Get Compliance Summary By Resource Type

configservice_get_compliance_summary_by_resource_type

R Documentation

Returns the number of resources that are compliant and the number that are noncompliant¶

Description¶

Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.

Usage¶

configservice_get_compliance_summary_by_resource_type(ResourceTypes)

Arguments¶

ResourceTypes

Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.

For this request, you can specify an Amazon Web Services resource type such as ⁠AWS::EC2::Instance⁠. You can specify that the resource type is an Amazon Web Services account by specifying ⁠AWS::::Account⁠.

Value¶

A list with the following syntax:

list(
  ComplianceSummariesByResourceType = list(
    list(
      ResourceType = "string",
      ComplianceSummary = list(
        CompliantResourceCount = list(
          CappedCount = 123,
          CapExceeded = TRUE|FALSE
        ),
        NonCompliantResourceCount = list(
          CappedCount = 123,
          CapExceeded = TRUE|FALSE
        ),
        ComplianceSummaryTimestamp = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  )
)

Request syntax¶

svc$get_compliance_summary_by_resource_type(
  ResourceTypes = list(
    "string"
  )
)