Skip to content

Get Aggregate Compliance Details By Config Rule

configservice_get_aggregate_compliance_details_by_config_rule R Documentation

Returns the evaluation results for the specified Config rule for a specific resource in a rule

Description

Returns the evaluation results for the specified Config rule for a specific resource in a 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.

The results can return an empty result page. But if you have a nextToken, the results are displayed on the next page.

Usage

configservice_get_aggregate_compliance_details_by_config_rule(
  ConfigurationAggregatorName, ConfigRuleName, AccountId, AwsRegion,
  ComplianceType, Limit, NextToken)

Arguments

ConfigurationAggregatorName

[required] The name of the configuration aggregator.

ConfigRuleName

[required] The name of the Config rule for which you want compliance information.

AccountId

[required] The 12-digit account ID of the source account.

AwsRegion

[required] The source region from where the data is aggregated.

ComplianceType

The resource compliance status.

For the GetAggregateComplianceDetailsByConfigRuleRequest data type, Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA values.

Limit

The maximum number of evaluation results returned on each page. The default is 50. 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(
  AggregateEvaluationResults = 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",
      AccountId = "string",
      AwsRegion = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_aggregate_compliance_details_by_config_rule(
  ConfigurationAggregatorName = "string",
  ConfigRuleName = "string",
  AccountId = "string",
  AwsRegion = "string",
  ComplianceType = "COMPLIANT"|"NON_COMPLIANT"|"NOT_APPLICABLE"|"INSUFFICIENT_DATA",
  Limit = 123,
  NextToken = "string"
)