Get Compliance Details By Config Rule

configservice_get_compliance_details_by_config_rule

R Documentation

Returns the evaluation results for the specified Config rule¶

Description¶

Returns the evaluation results for the specified Config rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.

Usage¶

configservice_get_compliance_details_by_config_rule(ConfigRuleName,
  ComplianceTypes, Limit, NextToken)

Arguments¶

ConfigRuleName

[required] The name of the Config rule 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.

Limit

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

NextToken

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

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_config_rule(
  ConfigRuleName = "string",
  ComplianceTypes = list(
    "COMPLIANT"|"NON_COMPLIANT"|"NOT_APPLICABLE"|"INSUFFICIENT_DATA"
  ),
  Limit = 123,
  NextToken = "string"
)