Get Compliance Details By Resource

configservice_get_compliance_details_by_resource

R Documentation

Returns the evaluation results for the specified Amazon Web Services resource¶

Description¶

Returns the evaluation results for the specified Amazon Web Services resource. The results indicate which Config rules were used to evaluate the resource, when each rule was last invoked, and whether the resource complies with each rule.

Usage¶

configservice_get_compliance_details_by_resource(ResourceType,
  ResourceId, ComplianceTypes, NextToken, ResourceEvaluationId)

Arguments¶

ResourceType

The type of the Amazon Web Services resource for which you want compliance information.

ResourceId

The ID of the Amazon Web Services resource for which you want compliance information.

ComplianceTypes

Filters the results by compliance.

INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a ComplianceType for filtering results.

NextToken

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

ResourceEvaluationId

The unique ID of Amazon Web Services resource execution for which you want to retrieve evaluation results.

You need to only provide either a ResourceEvaluationID or a ResourceID and ResourceType.

Value¶

A list with the following syntax:

list(
  EvaluationResults = list(
    list(
      EvaluationResultIdentifier = list(
        EvaluationResultQualifier = list(
          ConfigRuleName = "string",
          ResourceType = "string",
          ResourceId = "string",
          EvaluationMode = "DETECTIVE"|"PROACTIVE"
        ),
        OrderingTimestamp = as.POSIXct(
          "2015-01-01"
        ),
        ResourceEvaluationId = "string"
      ),
      ComplianceType = "COMPLIANT"|"NON_COMPLIANT"|"NOT_APPLICABLE"|"INSUFFICIENT_DATA",
      ResultRecordedTime = as.POSIXct(
        "2015-01-01"
      ),
      ConfigRuleInvokedTime = as.POSIXct(
        "2015-01-01"
      ),
      Annotation = "string",
      ResultToken = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$get_compliance_details_by_resource(
  ResourceType = "string",
  ResourceId = "string",
  ComplianceTypes = list(
    "COMPLIANT"|"NON_COMPLIANT"|"NOT_APPLICABLE"|"INSUFFICIENT_DATA"
  ),
  NextToken = "string",
  ResourceEvaluationId = "string"
)