

# GetComplianceDetailsByResource
<a name="API_GetComplianceDetailsByResource"></a>

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

## Request Syntax
<a name="API_GetComplianceDetailsByResource_RequestSyntax"></a>

```
{
   "ComplianceTypes": [ "string" ],
   "NextToken": "string",
   "ResourceEvaluationId": "string",
   "ResourceId": "string",
   "ResourceType": "string"
}
```

## Request Parameters
<a name="API_GetComplianceDetailsByResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ComplianceTypes](#API_GetComplianceDetailsByResource_RequestSyntax) **   <a name="config-GetComplianceDetailsByResource-request-ComplianceTypes"></a>
Filters the results by compliance.  
 `INSUFFICIENT_DATA` is a valid `ComplianceType` that is returned when an Amazon 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](#API_GetComplianceDetailsByResource_RequestSyntax) **   <a name="config-GetComplianceDetailsByResource-request-NextToken"></a>
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](#API_GetComplianceDetailsByResource_RequestSyntax) **   <a name="config-GetComplianceDetailsByResource-request-ResourceEvaluationId"></a>
The unique ID of Amazon resource execution for which you want to retrieve evaluation results.   
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](#API_GetComplianceDetailsByResource_RequestSyntax) **   <a name="config-GetComplianceDetailsByResource-request-ResourceId"></a>
The ID of the Amazon resource for which you want compliance information.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 768.  
Required: No

 ** [ResourceType](#API_GetComplianceDetailsByResource_RequestSyntax) **   <a name="config-GetComplianceDetailsByResource-request-ResourceType"></a>
The type of the Amazon resource for which you want compliance information.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_GetComplianceDetailsByResource_ResponseSyntax"></a>

```
{
   "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
<a name="API_GetComplianceDetailsByResource_ResponseElements"></a>

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](#API_GetComplianceDetailsByResource_ResponseSyntax) **   <a name="config-GetComplianceDetailsByResource-response-EvaluationResults"></a>
Indicates whether the specified Amazon resource complies each Amazon Config rule.  
Type: Array of [EvaluationResult](API_EvaluationResult.md) objects

 ** [NextToken](#API_GetComplianceDetailsByResource_ResponseSyntax) **   <a name="config-GetComplianceDetailsByResource-response-NextToken"></a>
The string that you use in a subsequent request to get the next page of results in a paginated response.  
Type: String

## Errors
<a name="API_GetComplianceDetailsByResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidParameterValueException **   
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.  
HTTP Status Code: 400

## See Also
<a name="API_GetComplianceDetailsByResource_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/config-2014-11-12/GetComplianceDetailsByResource) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/config-2014-11-12/GetComplianceDetailsByResource) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/config-2014-11-12/GetComplianceDetailsByResource) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/config-2014-11-12/GetComplianceDetailsByResource) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/config-2014-11-12/GetComplianceDetailsByResource) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/config-2014-11-12/GetComplianceDetailsByResource) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/config-2014-11-12/GetComplianceDetailsByResource) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/config-2014-11-12/GetComplianceDetailsByResource) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/config-2014-11-12/GetComplianceDetailsByResource) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/config-2014-11-12/GetComplianceDetailsByResource) 