Menu
AWS Config
API Reference (API Version 2014-11-12)

Evaluation

Identifies an AWS resource and indicates whether it complies with the AWS Config rule that it was evaluated against.

Contents

Annotation

Supplementary information about how the evaluation determined the compliance.

Type: String

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

Required: No

ComplianceResourceId

The ID of the AWS resource that was evaluated.

Type: String

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

Required: Yes

ComplianceResourceType

The type of AWS resource that was evaluated.

Type: String

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

Required: Yes

ComplianceType

Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.

For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type.

Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config.

Type: String

Valid Values: COMPLIANT | NON_COMPLIANT | NOT_APPLICABLE | INSUFFICIENT_DATA

Required: Yes

OrderingTimestamp

The time of the event in AWS Config that triggered the evaluation. For event-based evaluations, the time indicates when AWS Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when AWS Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).

Type: Timestamp

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: