configservice_describe_compliance_by_resource: Indicates whether the specified AWS resources are compliant

Description Usage Arguments Value Request syntax

View source: R/configservice_operations.R

Description

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

A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.

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

Usage

1
2
configservice_describe_compliance_by_resource(ResourceType, ResourceId,
  ComplianceTypes, Limit, NextToken)

Arguments

ResourceType

The types of AWS resources for which you want compliance information (for example, AWS::EC2::Instance). For this action, you can specify that the resource type is an AWS account by specifying AWS::::Account.

ResourceId

The ID of the AWS resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for ResourceType.

ComplianceTypes

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

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, 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
list(
  ComplianceByResources = list(
    list(
      ResourceType = "string",
      ResourceId = "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_resource(
  ResourceType = "string",
  ResourceId = "string",
  ComplianceTypes = list(
    "COMPLIANT"|"NON_COMPLIANT"|"NOT_APPLICABLE"|"INSUFFICIENT_DATA"
  ),
  Limit = 123,
  NextToken = "string"
)

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