Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListConfigurationPolicyAssociations

Provides information about the associations for your configuration policies and self-managed behavior. Only the Amazon Security Hub delegated administrator can invoke this operation from the home Region.

Request Syntax


POST /configurationPolicyAssociation/list HTTP/1.1
Content-type: application/json

{
   "Filters": { 
      "AssociationStatus": "string",
      "AssociationType": "string",
      "ConfigurationPolicyId": "string"
   },
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Filters

Options for filtering the ListConfigurationPolicyAssociations response. You can filter by the Amazon Resource Name (ARN) or universally unique identifier (UUID) of a configuration, AssociationType, or AssociationStatus.

Type: AssociationFilters object

Required: No

MaxResults

The maximum number of results that's returned by ListConfigurationPolicies in each page of the response. When this parameter is used, ListConfigurationPolicyAssociations returns the specified number of results in a single page and a NextToken response element. You can see the remaining results of the initial request by sending another ListConfigurationPolicyAssociations request with the returned NextToken value. A valid range for MaxResults is between 1 and 100.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The NextToken value that's returned from a previous paginated ListConfigurationPolicyAssociations request where MaxResults was used but the results exceeded the value of that parameter. Pagination continues from the end of the previous response that returned the NextToken value. This value is null when there are no more results to return.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ConfigurationPolicyAssociationSummaries": [ 
      { 
         "AssociationStatus": "string",
         "AssociationStatusMessage": "string",
         "AssociationType": "string",
         "ConfigurationPolicyId": "string",
         "TargetId": "string",
         "TargetType": "string",
         "UpdatedAt": "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.

ConfigurationPolicyAssociationSummaries

An object that contains the details of each configuration policy association that’s returned in a ListConfigurationPolicyAssociations request.

Type: Array of ConfigurationPolicyAssociationSummary objects

NextToken

The NextToken value to include in the next ListConfigurationPolicyAssociations request. When the results of a ListConfigurationPolicyAssociations request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Errors

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

AccessDeniedException

You don't have permission to perform the action specified in the request.

HTTP Status Code: 403

InternalException

Internal server error.

HTTP Status Code: 500

InvalidAccessException

The account doesn't have permission to perform this action.

HTTP Status Code: 401

InvalidInputException

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

HTTP Status Code: 400

LimitExceededException

The request was rejected because it attempted to create resources beyond the current Amazon account or throttling limits. The error code describes the limit exceeded.

HTTP Status Code: 429