DescribeConfigurationRecorderStatus
Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.
Note
>You can specify only one configuration recorder for each AWS Region for each account. For a detailed status of recording events over time, add your AWS Config events to Amazon CloudWatch metrics and use CloudWatch metrics.
Request Syntax
{
"ConfigurationRecorderNames": [ "string
" ]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ConfigurationRecorderNames
-
The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
Response Syntax
{
"ConfigurationRecordersStatus": [
{
"lastErrorCode": "string",
"lastErrorMessage": "string",
"lastStartTime": number,
"lastStatus": "string",
"lastStatusChangeTime": number,
"lastStopTime": number,
"name": "string",
"recording": boolean
}
]
}
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.
- ConfigurationRecordersStatus
-
A list that contains status of the specified recorders.
Type: Array of ConfigurationRecorderStatus objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- NoSuchConfigurationRecorderException
-
You have specified a configuration recorder 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: