PutConfigurationRecorder - AWS Config

PutConfigurationRecorder

Creates a new configuration recorder to record configuration changes for specified resource types.

You can also use this action to change the roleARN or the recordingGroup of an existing recorder. For more information, see Managing the Configuration Recorder in the AWS Config Developer Guide.

Note

You can specify only one configuration recorder for each AWS Region for each account.

If the configuration recorder does not have the recordingGroup field specified, the default is to record all supported resource types.

Request Syntax

{ "ConfigurationRecorder": { "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" ] } ] }, "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

An object for the configuration recorder to record configuration changes for specified resource types.

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 name for the configuration recorder that is not valid.

HTTP Status Code: 400

InvalidRecordingGroupException

Indicates one of the following errors:

  • You have provided a combination of parameter values that is not valid. For example:

  • Every parameter is either null, false, or empty.

  • You have reached the limit of the number of resource types you can provide for the recording group.

  • You have provided resource types or a recording strategy that are not valid.

HTTP Status Code: 400

InvalidRoleException

You have provided a null or empty Amazon Resource Name (ARN) for the IAM role assumed by AWS Config and used by the configuration recorder.

HTTP Status Code: 400

MaxNumberOfConfigurationRecordersExceededException

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

HTTP Status Code: 400

ValidationException

The requested action is not valid.

For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

HTTP Status Code: 400

See Also

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