DeliverConfigSnapshot
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends the following notifications using an Amazon SNS topic that you have specified.
• Notification of the start of the delivery.
• Notification of the completion of the delivery, if the delivery was successfully completed.
• Notification of delivery failure, if the delivery failed.
Request Syntax
{ "deliveryChannelName": "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.
deliveryChannelName (p. 45)
The name of the delivery channel through which the snapshot is delivered.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
Response Syntax
{
"configSnapshotId": "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.
configSnapshotId (p. 45)
The ID of the snapshot that is being created.
Type: String
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 388).
NoAvailableConfigurationRecorderException
There are no configuration recorders available to provide the role needed to describe your resources.
Create a configuration recorder.
HTTP Status Code: 400
NoRunningConfigurationRecorderException There is no configuration recorder running.
HTTP Status Code: 400 NoSuchDeliveryChannelException
You have specified a delivery channel that does not exist.
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
DescribeAggregateComplianceByConfigRules
DescribeAggregateComplianceByConfigRules
Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.
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", "ComplianceType": "string", "ConfigRuleName": "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. 47) The name of the configuration aggregator.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [\w\-]+
Required: Yes Filters (p. 47)
Filters the results by ConfigRuleComplianceFilters object.
Type: ConfigRuleComplianceFilters (p. 279) object Required: No
Limit (p. 47)
The maximum number of evaluation 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 1000.
Required: No
Response Syntax
NextToken (p. 47)
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
{
"AggregateComplianceByConfigRules": [ {
"AccountId": "string", "AwsRegion": "string", "Compliance": {
"ComplianceContributorCount": { "CapExceeded": boolean, "CappedCount": number },
"ComplianceType": "string"
},
"ConfigRuleName": "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.
AggregateComplianceByConfigRules (p. 48)
Returns a list of AggregateComplianceByConfigRule object.
Type: Array of AggregateComplianceByConfigRule (p. 247) objects NextToken (p. 48)
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
See Also
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
DescribeAggregateComplianceByConformancePacks
DescribeAggregateComplianceByConformancePacks
Returns a list of the conformance packs and their associated compliance status with the count of
compliant and noncompliant AWS Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.
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", "ComplianceType": "string", "ConformancePackName": "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. 50) The name of the configuration aggregator.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [\w\-]+
Required: Yes Filters (p. 50)
Filters the result by AggregateConformancePackComplianceFilters object.
Type: AggregateConformancePackComplianceFilters (p. 254) object Required: No
Limit (p. 50)
Response Syntax
Required: No NextToken (p. 50)
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
{ "AggregateComplianceByConformancePacks": [ {
"AccountId": "string", "AwsRegion": "string", "Compliance": {
"ComplianceType": "string", "CompliantRuleCount": number, "NonCompliantRuleCount": number, "TotalRuleCount": number
},
"ConformancePackName": "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.
AggregateComplianceByConformancePacks (p. 51)
Returns the AggregateComplianceByConformancePack object.
Type: Array of AggregateComplianceByConformancePack (p. 249) objects NextToken (p. 51)
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
See Also
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
DescribeAggregationAuthorizations
DescribeAggregationAuthorizations
Returns a list of authorizations granted to various aggregator accounts and regions.
Request Syntax
{
"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.
Limit (p. 53)
The maximum number of AggregationAuthorizations 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. 53)
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
{ "AggregationAuthorizations": [ {
"AggregationAuthorizationArn": "string", "AuthorizedAccountId": "string",
"AuthorizedAwsRegion": "string", "CreationTime": number
} ],
"NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
Errors
The following data is returned in JSON format by the service.
AggregationAuthorizations (p. 53)
Returns a list of authorizations granted to various aggregator accounts and regions.
Type: Array of AggregationAuthorization (p. 263) objects NextToken (p. 53)
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 InvalidParameterValueException
One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.
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