GetConformancePackComplianceDetails
Returns compliance details of a conformance pack for all Amazon resources that are monitered by conformance pack.
Request Syntax
{
"ConformancePackName": "string
",
"Filters": {
"ComplianceType": "string
",
"ConfigRuleNames": [ "string
" ],
"ResourceIds": [ "string
" ],
"ResourceType": "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
ConformancePackEvaluationFilters
object.Type: ConformancePackEvaluationFilters object
Required: No
- Limit
-
The maximum number of evaluation results returned on each page. If you do no specify a number, Amazon Config uses the default. The default is 100.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
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",
"ConformancePackRuleEvaluationResults": [
{
"Annotation": "string",
"ComplianceType": "string",
"ConfigRuleInvokedTime": number,
"EvaluationResultIdentifier": {
"EvaluationResultQualifier": {
"ConfigRuleName": "string",
"EvaluationMode": "string",
"ResourceId": "string",
"ResourceType": "string"
},
"OrderingTimestamp": number,
"ResourceEvaluationId": "string"
},
"ResultRecordedTime": number
}
],
"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]*
- ConformancePackRuleEvaluationResults
-
Returns a list of
ConformancePackEvaluationResult
objects.Type: Array of ConformancePackEvaluationResult objects
Array Members: Minimum number of 0 items. Maximum number of 100 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 not valid. 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 not valid. Verify that your parameters are valid and try again.
HTTP Status Code: 400
- NoSuchConfigRuleInConformancePackException
-
Amazon 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 Amazon SDKs, see the following: