GetComplianceDetailsByConfigRule
Returns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
Request Syntax
{
"ComplianceTypes": [ "string" ],
"ConfigRuleName": "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.
- ComplianceTypes
-
Filters the results by compliance.
INSUFFICIENT_DATAis a validComplianceTypethat is returned when an AWS Config rule cannot be evaluated. However,INSUFFICIENT_DATAcannot be used as aComplianceTypefor filtering results.Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 3 items.
Valid Values:
COMPLIANT | NON_COMPLIANT | NOT_APPLICABLE | INSUFFICIENT_DATARequired: No
- ConfigRuleName
-
The name of the AWS Config rule for which you want compliance information.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
- Limit
-
The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- NextToken
-
The
nextTokenstring 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
{
"EvaluationResults": [
{
"Annotation": "string",
"ComplianceType": "string",
"ConfigRuleInvokedTime": number,
"EvaluationResultIdentifier": {
"EvaluationResultQualifier": {
"ConfigRuleName": "string",
"EvaluationMode": "string",
"ResourceId": "string",
"ResourceType": "string"
},
"OrderingTimestamp": number,
"ResourceEvaluationId": "string"
},
"ResultRecordedTime": number,
"ResultToken": "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.
- EvaluationResults
-
Indicates whether the AWS resource complies with the specified AWS Config rule.
Type: Array of EvaluationResult objects
- NextToken
-
The string that you use in a subsequent request 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.
- InvalidNextTokenException
-
The specified next token is not valid. Specify the
nextTokenstring 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
- NoSuchConfigRuleException
-
The AWS Config rule in the request is not valid. Verify that the rule is an AWS Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
