SSM / Client / list_compliance_summaries

list_compliance_summaries

SSM.Client.list_compliance_summaries(**kwargs)

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

Request Syntax

response = client.list_compliance_summaries(
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'Type': 'EQUAL'|'NOT_EQUAL'|'BEGIN_WITH'|'LESS_THAN'|'GREATER_THAN'
        },
    ],
    NextToken='string',
    MaxResults=123
)

Parameters:

• Filters (list) –

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

  • (dict) –

    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.

• NextToken (string) – A token to start the list. Use this token to get the next set of results.

• MaxResults (integer) – The maximum number of items to return for this call. Currently, you can specify null or 50. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'ComplianceSummaryItems': [
        {
            'ComplianceType': 'string',
            'CompliantSummary': {
                'CompliantCount': 123,
                'SeveritySummary': {
                    'CriticalCount': 123,
                    'HighCount': 123,
                    'MediumCount': 123,
                    'LowCount': 123,
                    'InformationalCount': 123,
                    'UnspecifiedCount': 123
                }
            },
            'NonCompliantSummary': {
                'NonCompliantCount': 123,
                'SeveritySummary': {
                    'CriticalCount': 123,
                    'HighCount': 123,
                    'MediumCount': 123,
                    'LowCount': 123,
                    'InformationalCount': 123,
                    'UnspecifiedCount': 123
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • 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.

    • (dict) –

      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 (dict) –

        A list of COMPLIANT items for the specified compliance type.

        • CompliantCount (integer) –

          The total number of resources that are compliant.

        • SeveritySummary (dict) –

          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 (dict) –

        A list of NON_COMPLIANT items for the specified compliance type.

        • NonCompliantCount (integer) –

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

        • SeveritySummary (dict) –

          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.

Exceptions

• SSM.Client.exceptions.InvalidFilter

• SSM.Client.exceptions.InvalidNextToken

• SSM.Client.exceptions.InternalServerError