Skip to content

Evaluation

Source code in docs_src/capo_config_service/types/evaluation.py
class Evaluation(TypedDict, closed=True):
    compliance_resource_type: (
        "capo_config_service.types.string_with_char_limit256.StringWithCharLimit256"
    )
    """<p>The type of Amazon Web Services resource that was evaluated.</p>"""
    compliance_resource_id: "capo_config_service.types.base_resource_id.BaseResourceId"
    """<p>The ID of the Amazon Web Services resource that was evaluated.</p>"""
    compliance_type: "capo_config_service.types.compliance_type.ComplianceType"
    """<p>Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.</p> <p>For the <code>Evaluation</code> data type, Config supports only the <code>COMPLIANT</code>, <code>NON_COMPLIANT</code>, and <code>NOT_APPLICABLE</code> values. Config does not support the <code>INSUFFICIENT_DATA</code> value for this data type.</p> <p>Similarly, Config does not accept <code>INSUFFICIENT_DATA</code> as the value for <code>ComplianceType</code> from a <code>PutEvaluations</code> request. For example, an Lambda function for a custom Config rule cannot pass an <code>INSUFFICIENT_DATA</code> value to Config.</p>"""
    annotation: NotRequired[
        "capo_config_service.types.string_with_char_limit256.StringWithCharLimit256"
    ]
    """<p>Supplementary information about how the evaluation determined the compliance.</p>"""
    ordering_timestamp: "capo_config_service.types.ordering_timestamp.OrderingTimestamp"
    """<p>The time of the event in Config that triggered the evaluation. For event-based evaluations, the time indicates when Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).</p>"""

annotation instance-attribute

annotation: NotRequired[StringWithCharLimit256]

Supplementary information about how the evaluation determined the compliance.

compliance_resource_id instance-attribute

compliance_resource_id: BaseResourceId

The ID of the Amazon Web Services resource that was evaluated.

compliance_resource_type instance-attribute

compliance_resource_type: StringWithCharLimit256

The type of Amazon Web Services resource that was evaluated.

compliance_type instance-attribute

compliance_type: ComplianceType

Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.

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

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

ordering_timestamp instance-attribute

ordering_timestamp: OrderingTimestamp

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