configservice_describe_compliance_by_config_rule: Indicates whether the specified AWS Config rules are...

Description Usage Arguments Value Request syntax

View source: R/configservice_operations.R

Description

Indicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS resources that do not comply with the rule.

A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply.

If AWS Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions:

Usage

1
2
configservice_describe_compliance_by_config_rule(ConfigRuleNames,
  ComplianceTypes, NextToken)

Arguments

ConfigRuleNames

Specify one or more AWS Config rule names to filter the results by rule.

ComplianceTypes

Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT.

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
list(
  ComplianceByConfigRules = list(
    list(
      ConfigRuleName = "string",
      Compliance = list(
        ComplianceType = "COMPLIANT"|"NON_COMPLIANT"|"NOT_APPLICABLE"|"INSUFFICIENT_DATA",
        ComplianceContributorCount = list(
          CappedCount = 123,
          CapExceeded = TRUE|FALSE
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

1
2
3
4
5
6
7
8
9
svc$describe_compliance_by_config_rule(
  ConfigRuleNames = list(
    "string"
  ),
  ComplianceTypes = list(
    "COMPLIANT"|"NON_COMPLIANT"|"NOT_APPLICABLE"|"INSUFFICIENT_DATA"
  ),
  NextToken = "string"
)

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