ConfigService / Client / get_resource_evaluation_summary

get_resource_evaluation_summary

ConfigService.Client.get_resource_evaluation_summary(**kwargs)

Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run. The results indicate which evaluation context was used to evaluate the rules, which resource details were evaluated, the evaluation mode that was run, and whether the resource details comply with the configuration of the proactive rules.

Note

To see additional information about the evaluation result, such as which rule flagged a resource as NON_COMPLIANT, use the GetComplianceDetailsByResource API. For more information, see the Examples section.

See also: AWS API Documentation

Request Syntax

response = client.get_resource_evaluation_summary(
    ResourceEvaluationId='string'
)

Parameters:

ResourceEvaluationId (string) –

[REQUIRED]

The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.

Return type:

dict

Returns:

Response Syntax

{
    'ResourceEvaluationId': 'string',
    'EvaluationMode': 'DETECTIVE'|'PROACTIVE',
    'EvaluationStatus': {
        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
        'FailureReason': 'string'
    },
    'EvaluationStartTimestamp': datetime(2015, 1, 1),
    'Compliance': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
    'EvaluationContext': {
        'EvaluationContextIdentifier': 'string'
    },
    'ResourceDetails': {
        'ResourceId': 'string',
        'ResourceType': 'string',
        'ResourceConfiguration': 'string',
        'ResourceConfigurationSchemaType': 'CFN_RESOURCE_SCHEMA'
    }
}

Response Structure

• (dict) –

  • ResourceEvaluationId (string) –

    The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.

  • EvaluationMode (string) –

    Lists results of the mode that you requested to retrieve the resource evaluation summary. The valid values are Detective or Proactive.

  • EvaluationStatus (dict) –

    Returns an EvaluationStatus object.

    • Status (string) –

      The status of an execution. The valid values are In_Progress, Succeeded or Failed.

    • FailureReason (string) –

      An explanation for failed execution status.

  • EvaluationStartTimestamp (datetime) –

    The start timestamp when Config rule starts evaluating compliance for the provided resource details.

  • Compliance (string) –

    The compliance status of the resource evaluation summary.

  • EvaluationContext (dict) –

    Returns an EvaluationContext object.

    • EvaluationContextIdentifier (string) –

      A unique EvaluationContextIdentifier ID for an EvaluationContext.

  • ResourceDetails (dict) –

    Returns a ResourceDetails object.

    • ResourceId (string) –

      A unique resource ID for an evaluation.

    • ResourceType (string) –

      The type of resource being evaluated.

    • ResourceConfiguration (string) –

      The resource definition to be evaluated as per the resource configuration schema type.

    • ResourceConfigurationSchemaType (string) –

      The schema type of the resource configuration.

      Note

      You can find the Resource type schema, or CFN_RESOURCE_SCHEMA, in “Amazon Web Services public extensions” within the CloudFormation registry or with the following CLI commmand: aws cloudformation describe-type --type-name "AWS::S3::Bucket" --type RESOURCE.

      For more information, see Managing extensions through the CloudFormation registry and Amazon Web Services resource and property types reference in the CloudFormation User Guide.

Exceptions

• ConfigService.Client.exceptions.ResourceNotFoundException