Generates a compliance evaluation report based on all rules in an account group.
The sample request in this topic shows you how to generate a compliance evaluation
report based on all rules in the ca-f632626622af0079****
account group.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | GenerateAggregateConfigRulesReport |
The operation that you want to perform. Set the value to GenerateAggregateConfigRulesReport. |
ClientToken | String | No | 1594295238-f9361358-5843-4294-8d30-b5183fac**** |
The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. |
AggregatorId | String | Yes | ca-f632626622af0079**** |
The ID of the account group. For more information about how to query the ID of an account group, see ListAggregators. |
ConfigRuleIds | String | No | cr-25d86457e0d900b5**** |
The ID of the rule. Separate multiple rule IDs with commas (,). For more information about how to query the ID of a rule, see ListAggregateConfigRules. |
For more information about common request parameters, see Common parameters.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 6EC7AED1-172F-42AE-9C12-295BC2ADB751 |
The ID of the request. |
AggregatorId | String | ca-f632626622af0079**** |
The ID of the account group. |
ReportId | String | crp-88176457e0d900c9**** |
The ID of the compliance evaluation report. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=GenerateAggregateConfigRulesReport
&AggregatorId=ca-f632626622af0079****
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<GenerateAggregateConfigRulesReportResponse>
<RequestId>6EC7AED1-172F-42AE-9C12-295BC2ADB751</RequestId>
<AggregatorId>ca-f632626622af0079****</AggregatorId>
<ReportId>crp-88176457e0d900c9****</ReportId>
</GenerateAggregateConfigRulesReportResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "6EC7AED1-172F-42AE-9C12-295BC2ADB751",
"AggregatorId" : "ca-f632626622af0079****",
"ReportId" : "crp-88176457e0d900c9****"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | Invalid.AggregatorId.Value | The specified AggregatorId is invalid. | The error message returned because the specified account group ID does not exist or you are not authorized to use the account group. |
400 | ConfigRuleReportCreating | The config rule report is being created. | The error message returned because the compliance evaluation report is being generated. |
404 | AccountNotExisted | Your account does not exist. | The error message returned because the specified account does not exist. |
503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | The error message returned because the service is unavailable. |
For a list of error codes, visit the API Error Center.