GetAggregateConfigRuleComplianceSummary
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
NoteThe results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
Request Syntax
{ "ConfigurationAggregatorName": "string", "Filters": {
"AccountId": "string", "AwsRegion": "string"
},
"GroupByKey": "string", "Limit": number,
"NextToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 386).
The request accepts the following data in JSON format.
ConfigurationAggregatorName (p. 119) The name of the configuration aggregator.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [\w\-]+
Required: Yes Filters (p. 119)
Filters the results based on the ConfigRuleComplianceSummaryFilters object.
Type: ConfigRuleComplianceSummaryFilters (p. 281) object Required: No
GroupByKey (p. 119)
Groups the result based on ACCOUNT_ID or AWS_REGION.
Type: String
Valid Values: ACCOUNT_ID | AWS_REGION Required: No
Response Syntax
Limit (p. 119)
The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, AWS Config uses the default.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1000.
Required: No NextToken (p. 119)
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Type: String Required: No
Response Syntax
{
"AggregateComplianceCounts": [ {
"ComplianceSummary": {
"ComplianceSummaryTimestamp": number, "CompliantResourceCount": {
"CapExceeded": boolean, "CappedCount": number },
"NonCompliantResourceCount": { "CapExceeded": boolean, "CappedCount": number }
},
"GroupName": "string"
} ],
"GroupByKey": "string", "NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
AggregateComplianceCounts (p. 120)
Returns a list of AggregateComplianceCounts object.
Errors
Length Constraints: Minimum length of 1. Maximum length of 256.
NextToken (p. 120)
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 388).
InvalidLimitException
The specified limit is outside the allowable range.
HTTP Status Code: 400 InvalidNextTokenException
The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.
HTTP Status Code: 400
NoSuchConfigurationAggregatorException
You have specified a configuration aggregator that does not exist.
HTTP Status Code: 400 ValidationException
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
See Also
GetAggregateConformancePackComplianceSummary
GetAggregateConformancePackComplianceSummary
Returns the count of compliant and noncompliant conformance packs across all AWS accounts and AWS Regions in an aggregator. You can filter based on AWS account ID or AWS Region.
NoteThe results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
Request Syntax
{ "ConfigurationAggregatorName": "string", "Filters": {
"AccountId": "string", "AwsRegion": "string"
},
"GroupByKey": "string", "Limit": number,
"NextToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 386).
The request accepts the following data in JSON format.
ConfigurationAggregatorName (p. 123) The name of the configuration aggregator.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [\w\-]+
Required: Yes Filters (p. 123)
Filters the results based on the AggregateConformancePackComplianceSummaryFilters object.
Type: AggregateConformancePackComplianceSummaryFilters (p. 256) object Required: No
GroupByKey (p. 123)
Groups the result based on AWS account ID or AWS Region.
Type: String
Valid Values: ACCOUNT_ID | AWS_REGION Required: No
Response Syntax
Limit (p. 123)
The maximum number of results returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No NextToken (p. 123)
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Type: String Required: No
Response Syntax
{ "AggregateConformancePackComplianceSummaries": [ {
"ComplianceSummary": {
"CompliantConformancePackCount": number, "NonCompliantConformancePackCount": number },
"GroupName": "string"
} ],
"GroupByKey": "string", "NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
AggregateConformancePackComplianceSummaries (p. 124)
Returns a list of AggregateConformancePackComplianceSummary object.
Type: Array of AggregateConformancePackComplianceSummary (p. 255) objects GroupByKey (p. 124)
Groups the result based on AWS account ID or AWS Region.
Type: String
Errors
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 388).
InvalidLimitException
The specified limit is outside the allowable range.
HTTP Status Code: 400 InvalidNextTokenException
The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.
HTTP Status Code: 400
NoSuchConfigurationAggregatorException
You have specified a configuration aggregator that does not exist.
HTTP Status Code: 400 ValidationException
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetAggregateDiscoveredResourceCounts
GetAggregateDiscoveredResourceCounts
Returns the resource counts across accounts and regions that are present in your AWS Config aggregator.
You can request the resource counts by providing filters and GroupByKey.
For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator.
Request Syntax
{ "ConfigurationAggregatorName": "string", "Filters": {
"AccountId": "string", "Region": "string", "ResourceType": "string"
},
"GroupByKey": "string", "Limit": number,
"NextToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 386).
The request accepts the following data in JSON format.
ConfigurationAggregatorName (p. 126) The name of the configuration aggregator.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [\w\-]+
Required: Yes Filters (p. 126)
Filters the results based on the ResourceCountFilters object.
Type: ResourceCountFilters (p. 363) object Required: No
GroupByKey (p. 126)
Response Syntax
Limit (p. 126)
The maximum number of GroupedResourceCount (p. 324) objects returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, AWS Config uses the default.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1000.
Required: No NextToken (p. 126)
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Type: String Required: No
Response Syntax
{
"GroupByKey": "string", "GroupedResourceCounts": [ {
"GroupName": "string", "ResourceCount": number }
],
"NextToken": "string",
"TotalDiscoveredResources": number }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
GroupByKey (p. 127)
The key passed into the request object. If GroupByKey is not provided, the result will be empty.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
GroupedResourceCounts (p. 127)
Returns a list of GroupedResourceCount objects.
Type: Array of GroupedResourceCount (p. 324) objects NextToken (p. 127)
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Type: String
Errors
TotalDiscoveredResources (p. 127)
The total number of resources that are present in an aggregator with the filters that you provide.
Type: Long
Errors
For information about the errors that are common to all actions, see Common Errors (p. 388).
InvalidLimitException
The specified limit is outside the allowable range.
HTTP Status Code: 400 InvalidNextTokenException
The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.
HTTP Status Code: 400
NoSuchConfigurationAggregatorException
You have specified a configuration aggregator that does not exist.
HTTP Status Code: 400 ValidationException
The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
GetAggregateResourceConfig
GetAggregateResourceConfig
Returns configuration item that is aggregated for your specific resource in a specific source account and region.
Request Syntax
{ "ConfigurationAggregatorName": "string", "ResourceIdentifier": {
"ResourceId": "string", "ResourceName": "string", "ResourceType": "string", "SourceAccountId": "string", "SourceRegion": "string"
}}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 386).
The request accepts the following data in JSON format.
ConfigurationAggregatorName (p. 129) The name of the configuration aggregator.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [\w\-]+
Required: Yes
ResourceIdentifier (p. 129)
An object that identifies aggregate resource.
Type: AggregateResourceIdentifier (p. 261) object Required: Yes
Response Syntax
{ "ConfigurationItem": { "accountId": "string", "arn": "string",
"availabilityZone": "string", "awsRegion": "string", "configuration": "string",
"configurationItemCaptureTime": number, "configurationItemMD5Hash": "string",
Response Elements
"configurationItemStatus": "string", "configurationStateId": "string", "relatedEvents": [ "string" ],
"resourceCreationTime": number, "resourceId": "string",
"resourceName": "string", "resourceType": "string", "supplementaryConfiguration": { "string" : "string"
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ConfigurationItem (p. 129)
Returns a ConfigurationItem object.
Type: ConfigurationItem (p. 289) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 388).
NoSuchConfigurationAggregatorException
You have specified a configuration aggregator that does not exist.
HTTP Status Code: 400
OversizedConfigurationItemException
The configuration item size is outside the allowable range.
HTTP Status Code: 400 ResourceNotDiscoveredException
See Also
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3