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

PutConfigurationRecorder

Creates a new configuration recorder to record the selected resource configurations.

You can use this action to change the role roleARN and/or the recordingGroup of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.

Note

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

If ConfigurationRecorder does not have the recordingGroup parameter specified, the default is to record all supported resource types.

Request Syntax

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

ConfigurationRecorder

The configuration recorder object that records each configuration change made to the resources.

Type: ConfigurationRecorder object

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidConfigurationRecorderNameException

You have provided a configuration recorder name that is not valid.

HTTP Status Code: 400

InvalidRecordingGroupException

AWS Config throws an exception if the recording group does not contain a valid list of resource types. Invalid values could also be incorrectly formatted.

HTTP Status Code: 400

InvalidRoleException

You have provided a null or empty role ARN.

HTTP Status Code: 400

MaxNumberOfConfigurationRecordersExceededException

You have reached the limit on the number of recorders you can create.

HTTP Status Code: 400

See Also

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