DescribeConformancePackCompliance - AWS Config

DescribeConformancePackCompliance

Returns compliance details for each rule in that conformance pack.

Note

You must provide exact rule names.

Request Syntax

{ "ConformancePackName": "string", "Filters": { "ComplianceType": "string", "ConfigRuleNames": [ "string" ] }, "Limit": 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.

ConformancePackName

Name of the conformance pack.

Type: String

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

Pattern: [a-zA-Z][-a-zA-Z0-9]*

Required: Yes

Filters

A ConformancePackComplianceFilters object.

Type: ConformancePackComplianceFilters object

Required: No

Limit

The maximum number of AWS Config rules within a conformance pack are returned on each page.

Type: Integer

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

Required: No

NextToken

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Type: String

Required: No

Response Syntax

{ "ConformancePackName": "string", "ConformancePackRuleComplianceList": [ { "ComplianceType": "string", "ConfigRuleName": "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.

ConformancePackName

Name of the conformance pack.

Type: String

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

Pattern: [a-zA-Z][-a-zA-Z0-9]*

ConformancePackRuleComplianceList

Returns a list of ConformancePackRuleCompliance objects.

Type: Array of ConformancePackRuleCompliance objects

Array Members: Minimum number of 0 items. Maximum number of 1000 items.

NextToken

The nextToken string returned in a previous request that you use to request 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.

InvalidLimitException

The specified limit is outside the allowable range.

HTTP Status Code: 400

InvalidNextTokenException

The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

HTTP Status Code: 400

InvalidParameterValueException

One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

HTTP Status Code: 400

NoSuchConfigRuleInConformancePackException

AWS Config rule that you passed in the filter does not exist.

HTTP Status Code: 400

NoSuchConformancePackException

You specified one or more conformance packs that do 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: