Evaluation
Identifies an Amazon resource and indicates whether it complies with the Amazon Config rule that it was evaluated against.
Contents
- ComplianceResourceId
-
The ID of the Amazon resource that was evaluated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 768.
Required: Yes
- ComplianceResourceType
-
The type of Amazon resource that was evaluated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
- ComplianceType
-
Indicates whether the Amazon resource complies with the Amazon Config rule that it was evaluated against.
For the
Evaluation
data type, Amazon Config supports only theCOMPLIANT
,NON_COMPLIANT
, andNOT_APPLICABLE
values. Amazon Config does not support theINSUFFICIENT_DATA
value for this data type.Similarly, Amazon Config does not accept
INSUFFICIENT_DATA
as the value forComplianceType
from aPutEvaluations
request. For example, an Amazon Lambda function for a custom Amazon Config rule cannot pass anINSUFFICIENT_DATA
value to Amazon Config.Type: String
Valid Values:
COMPLIANT | NON_COMPLIANT | NOT_APPLICABLE | INSUFFICIENT_DATA
Required: Yes
- OrderingTimestamp
-
The time of the event in Amazon Config that triggered the evaluation. For event-based evaluations, the time indicates when Amazon Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when Amazon Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).
Type: Timestamp
Required: Yes
- Annotation
-
Supplementary information about how the evaluation determined the compliance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: