list-compliance-summaries¶

Description¶

Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.

Synopsis¶

  list-compliance-summaries
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--filters (list)

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

(structure)

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

Key -> (string)

The name of the filter.

Values -> (list)

The value for which to search.

(string)

Type -> (string)

The type of comparison that should be performed for the value: Equal, NotEqual, BeginWith, LessThan, or GreaterThan.

Shorthand Syntax:

Key=string,Values=string,string,Type=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Values": ["string", ...],
    "Type": "EQUAL"|"NOT_EQUAL"|"BEGIN_WITH"|"LESS_THAN"|"GREATER_THAN"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To list compliance summaries for all compliance types

This example lists compliance summaries for all compliance types in your account.

Command:

aws ssm list-compliance-summaries

Output:

{
  "ComplianceSummaryItems": [
      {
          "ComplianceType": "Association",
          "CompliantSummary": {
              "CompliantCount": 2,
              "SeveritySummary": {
                  "CriticalCount": 0,
                  "HighCount": 0,
                  "MediumCount": 0,
                  "LowCount": 0,
                  "InformationalCount": 0,
                  "UnspecifiedCount": 2
              }
          },
          "NonCompliantSummary": {
              "NonCompliantCount": 0,
              "SeveritySummary": {
                  "CriticalCount": 0,
                  "HighCount": 0,
                  "MediumCount": 0,
                  "LowCount": 0,
                  "InformationalCount": 0,
                  "UnspecifiedCount": 0
              }
          }
      },
      {
          "ComplianceType": "Patch",
          "CompliantSummary": {
              "CompliantCount": 1,
              "SeveritySummary": {
                  "CriticalCount": 0,
                  "HighCount": 0,
                  "MediumCount": 0,
                  "LowCount": 0,
                  "InformationalCount": 0,
                  "UnspecifiedCount": 1
              }
          },
          "NonCompliantSummary": {
              "NonCompliantCount": 1,
              "SeveritySummary": {
                  "CriticalCount": 1,
                  "HighCount": 0,
                  "MediumCount": 0,
                  "LowCount": 0,
                  "InformationalCount": 0,
                  "UnspecifiedCount": 0
              }
          }
      },
              ...
  ],
  "NextToken": "eyJOZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ=="
}

To list compliance summaries for a specific compliance type

This example lists the compliance summary for the Patch compliance type.

Command:

aws ssm list-compliance-summaries --filters "Key=ComplianceType,Values=Patch,Type=EQUAL"

Output¶

ComplianceSummaryItems -> (list)

A list of compliant and non-compliant summary counts based on compliance types. For example, this call returns State Manager associations, patches, or custom compliance types according to the filter criteria that you specified.

(structure)

A summary of compliance information by compliance type.

ComplianceType -> (string)

The type of compliance item. For example, the compliance type can be Association, Patch, or Custom:string.

CompliantSummary -> (structure)

A list of COMPLIANT items for the specified compliance type.

CompliantCount -> (integer)

The total number of resources that are compliant.

SeveritySummary -> (structure)

A summary of the compliance severity by compliance type.

CriticalCount -> (integer)

The total number of resources or compliance items that have a severity level of Critical . Critical severity is determined by the organization that published the compliance items.

HighCount -> (integer)

The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.

MediumCount -> (integer)

The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.

LowCount -> (integer)

The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.

InformationalCount -> (integer)

The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.

UnspecifiedCount -> (integer)

The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.

NonCompliantSummary -> (structure)

A list of NON_COMPLIANT items for the specified compliance type.

NonCompliantCount -> (integer)

The total number of compliance items that aren’t compliant.

SeveritySummary -> (structure)

A summary of the non-compliance severity by compliance type

CriticalCount -> (integer)

The total number of resources or compliance items that have a severity level of Critical . Critical severity is determined by the organization that published the compliance items.

HighCount -> (integer)

The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.

MediumCount -> (integer)

The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.

LowCount -> (integer)

The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.

InformationalCount -> (integer)

The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.

UnspecifiedCount -> (integer)

The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.

NextToken -> (string)

The token for the next set of items to return. Use this token to get the next set of results.

Table of Contents

Feedback

User Guide