Skip to content

List Resource Compliance Summaries

ssm_list_resource_compliance_summaries R Documentation

Returns a resource-level summary count

Description

Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.

Usage

ssm_list_resource_compliance_summaries(Filters, NextToken, MaxResults)

Arguments

Filters

One or more filters. Use a filter to return a more specific list of results.

NextToken

A token to start the list. Use this token to get the next set of results.

MaxResults

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Value

A list with the following syntax:

list(
  ResourceComplianceSummaryItems = list(
    list(
      ComplianceType = "string",
      ResourceType = "string",
      ResourceId = "string",
      Status = "COMPLIANT"|"NON_COMPLIANT",
      OverallSeverity = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|"INFORMATIONAL"|"UNSPECIFIED",
      ExecutionSummary = list(
        ExecutionTime = as.POSIXct(
          "2015-01-01"
        ),
        ExecutionId = "string",
        ExecutionType = "string"
      ),
      CompliantSummary = list(
        CompliantCount = 123,
        SeveritySummary = list(
          CriticalCount = 123,
          HighCount = 123,
          MediumCount = 123,
          LowCount = 123,
          InformationalCount = 123,
          UnspecifiedCount = 123
        )
      ),
      NonCompliantSummary = list(
        NonCompliantCount = 123,
        SeveritySummary = list(
          CriticalCount = 123,
          HighCount = 123,
          MediumCount = 123,
          LowCount = 123,
          InformationalCount = 123,
          UnspecifiedCount = 123
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_resource_compliance_summaries(
  Filters = list(
    list(
      Key = "string",
      Values = list(
        "string"
      ),
      Type = "EQUAL"|"NOT_EQUAL"|"BEGIN_WITH"|"LESS_THAN"|"GREATER_THAN"
    )
  ),
  NextToken = "string",
  MaxResults = 123
)