CmdID / aws / aws ssm

aws ssm list-compliance-summaries

Returns a summary count of compliant and non-compliant resources for a compliance type. AWS CLI reference

2 examples 3 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

Example 1: To list compliance summaries for all compliance types

The following list-compliance-summaries example lists compliance summaries for all compliance types in your account.

aws ssm list-compliance-summariesIdentify

Its output, shortened

{
    "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": {
… 25 more lines

For more information, see Learn details about Compliance in the AWS Systems Manager User Guide.

Example 2: To list compliance summaries for a specific compliance type

The following list-compliance-summaries example lists the compliance summary for the Patch compliance type.

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

--filtersOne or more compliance or inventory filters.

Its output

{
    "ComplianceSummaryItems": [
        {
            "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
                }
            }
        }
    ]
}

For more information, see Learn details about Compliance in the AWS Systems Manager User Guide.

Options

3 in the AWS CLI reference

--filtersOne or more compliance or inventory filters.

--max-resultsThe maximum number of items to return for this call.

--next-tokenA token to start the list.