Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeConfigurationRecorders

Returns details for the configuration recorder you specify.

If a configuration recorder is not specified, this operation returns details 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

A list of names of the configuration recorders that you want to specify.

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


{
   "ConfigurationRecorders": [ 
      { 
         "arn": "string",
         "name": "string",
         "recordingGroup": { 
            "allSupported": boolean,
            "exclusionByResourceTypes": { 
               "resourceTypes": [ "string" ]
            },
            "includeGlobalResourceTypes": boolean,
            "recordingStrategy": { 
               "useOnly": "string"
            },
            "resourceTypes": [ "string" ]
         },
         "recordingMode": { 
            "recordingFrequency": "string",
            "recordingModeOverrides": [ 
               { 
                  "description": "string",
                  "recordingFrequency": "string",
                  "resourceTypes": [ "string" ]
               }
            ]
         },
         "recordingScope": "string",
         "roleARN": "string",
         "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.

ConfigurationRecorders

A list that contains the descriptions of the specified configuration recorders.

Type: Array of ConfigurationRecorder 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

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