Menu
AWS Config
API Reference (API Version 2014-11-12)

DescribeConfigurationRecorders

Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account.

Note

Currently, you can specify only one configuration recorder per region in your account.

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

A list of configuration recorder names.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

Response Syntax

{
   "ConfigurationRecorders": [ 
      { 
         "name": "string",
         "recordingGroup": { 
            "allSupported": boolean,
            "includeGlobalResourceTypes": boolean,
            "resourceTypes": [ "string" ]
         },
         "roleARN": "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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: