AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
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.
See also: AWS API Documentation
list-compliance-summaries
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: ComplianceSummaryItems
list-compliance-summaries
[--filters <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--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
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI 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.
--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 theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
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
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
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"
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 ofCritical
. 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 ofCritical
. 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.