DescribeConfigurationRecorderStatus
Returns the current status of the configuration recorder you specify as well as the status of the last recording event for the configuration recorders.
For a detailed status of recording events over time, add your AWS Config events to Amazon CloudWatch metrics and use CloudWatch metrics.
If a configuration recorder is not specified, this operation returns the status for the customer managed configuration recorder configured for the account, if applicable.
Note
When making a request to this operation, you can only specify one configuration recorder.
Request Syntax
{
"Arn": "string",
"ConfigurationRecorderNames": [ "string" ],
"ServicePrincipal": "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.
- Arn
-
The Amazon Resource Name (ARN) of the configuration recorder that you want to specify.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
- ConfigurationRecorderNames
-
The name of the configuration recorder. If the name is not specified, the opertation returns the status for the customer managed configuration recorder configured for the account, if applicable.
Note
When making a request to this operation, you can only specify one configuration recorder.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- ServicePrincipal
-
For service-linked configuration recorders, you can use the service principal of the linked AWS service to specify the configuration recorder.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+=,.@-]+Required: No
Response Syntax
{
"ConfigurationRecordersStatus": [
{
"arn": "string",
"lastErrorCode": "string",
"lastErrorMessage": "string",
"lastStartTime": number,
"lastStatus": "string",
"lastStatusChangeTime": number,
"lastStopTime": number,
"name": "string",
"recording": boolean,
"servicePrincipal": "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.
- 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.
- InvalidConfigurationRecorderNameException
-
The configuration recorder name is not valid. The prefix "
AWSConfigurationRecorderFor" is reserved for service-linked configuration recorders.HTTP Status Code: 400
- NoSuchConfigurationRecorderException
-
You have specified a configuration recorder that does not exist.
HTTP Status Code: 400
- ValidationException
-
The requested operation is not valid. You will see this exception if there are missing required fields or if the input value fails the validation.
For PutStoredQuery, one of the following errors:
-
There are missing required fields.
-
The input value fails the validation.
-
You are trying to create more than 300 queries.
For DescribeConfigurationRecorders and DescribeConfigurationRecorderStatus, one of the following errors:
-
You have specified more than one configuration recorder.
-
You have provided a service principal for service-linked configuration recorder that is not valid.
For AssociateResourceTypes and DisassociateResourceTypes, one of the following errors:
-
Your configuraiton recorder has a recording strategy that does not allow the association or disassociation of resource types.
-
One or more of the specified resource types are already associated or disassociated with the configuration recorder.
-
For service-linked configuration recorders, the configuration recorder does not record one or more of the specified resource types.
HTTP Status Code: 400
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
