configservice_get_aggregate_compliance_details_by_config_rule: Returns the evaluation results for the specified AWS Config...

Description Usage Arguments Value Request syntax

View source: R/configservice_operations.R

Description

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

1
2
3
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 AWS 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, AWS Config supports only the COMPLIANT and NON_COMPLIANT. AWS 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, AWS 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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
list(
  AggregateEvaluationResults = list(
    list(
      EvaluationResultIdentifier = list(
        EvaluationResultQualifier = list(
          ConfigRuleName = "string",
          ResourceType = "string",
          ResourceId = "string"
        ),
        OrderingTimestamp = as.POSIXct(
          "2015-01-01"
        )
      ),
      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

1
2
3
4
5
6
7
8
9
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"
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.