Get Resource Evaluation Summary

configservice_get_resource_evaluation_summary

R Documentation

Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run¶

Description¶

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.

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

Usage¶

configservice_get_resource_evaluation_summary(ResourceEvaluationId)

Arguments¶

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

Value¶

A list with the following syntax:

list(
  ResourceEvaluationId = "string",
  EvaluationMode = "DETECTIVE"|"PROACTIVE",
  EvaluationStatus = list(
    Status = "IN_PROGRESS"|"FAILED"|"SUCCEEDED",
    FailureReason = "string"
  ),
  EvaluationStartTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  Compliance = "COMPLIANT"|"NON_COMPLIANT"|"NOT_APPLICABLE"|"INSUFFICIENT_DATA",
  EvaluationContext = list(
    EvaluationContextIdentifier = "string"
  ),
  ResourceDetails = list(
    ResourceId = "string",
    ResourceType = "string",
    ResourceConfiguration = "string",
    ResourceConfigurationSchemaType = "CFN_RESOURCE_SCHEMA"
  )
)

Request syntax¶

svc$get_resource_evaluation_summary(
  ResourceEvaluationId = "string"
)