Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetComplianceDetailsByResource

Returns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last invoked, and whether the resource complies with each rule.

Request Syntax


{
   "ComplianceTypes": [ "string" ],
   "NextToken": "string",
   "ResourceEvaluationId": "string",
   "ResourceId": "string",
   "ResourceType": "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_DATA is a valid ComplianceType that is returned when an AWS Config rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a ComplianceType for 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_DATA

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

ResourceEvaluationId

The unique ID of AWS resource execution for which you want to retrieve evaluation results.

Note

You need to only provide either a ResourceEvaluationID or a ResourceID and ResourceType.

Type: String

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

Required: No

ResourceId

The ID of the AWS resource for which you want compliance information.

Type: String

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

Required: No

ResourceType

The type of the AWS resource for which you want compliance information.

Type: String

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

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 specified AWS resource complies each 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.

InvalidParameterValueException

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

HTTP Status Code: 400