Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListConfigurationRecorders

Returns a list of configuration recorders depending on the filters you specify.

Request Syntax


{
   "Filters": [ 
      { 
         "filterName": "string",
         "filterValue": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "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.

Filters

Filters the results based on a list of ConfigurationRecorderFilter objects that you specify.

Type: Array of ConfigurationRecorderFilter objects

Required: No

MaxResults

The maximum number of results to include in the response.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 20.

Required: No

NextToken

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Type: String

Required: No

Response Syntax


{
   "ConfigurationRecorderSummaries": [ 
      { 
         "arn": "string",
         "name": "string",
         "recordingScope": "string",
         "servicePrincipal": "string"
      }
   ],
   "NextToken": "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.

ConfigurationRecorderSummaries

A list of ConfigurationRecorderSummary objects that includes.

Type: Array of ConfigurationRecorderSummary objects

NextToken

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Type: String

Errors

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

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