GetConformancePackComplianceSummary - AWS Config

GetConformancePackComplianceSummary

Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.

Request Syntax

{ "ConformancePackNames": [ "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.

ConformancePackNames

Names of conformance packs.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

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

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

Required: Yes

Limit

The maximum number of conformance packs returned on each page.

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

{ "ConformancePackComplianceSummaryList": [ { "ConformancePackComplianceStatus": "string", "ConformancePackName": "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.

ConformancePackComplianceSummaryList

A list of ConformancePackComplianceSummary objects.

Type: Array of ConformancePackComplianceSummary objects

Array Members: Minimum number of 1 item. Maximum number of 5 items.

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.

InvalidLimitException

The specified limit is outside the allowable range.

HTTP Status Code: 400

InvalidNextTokenException

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

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: