SSM / Paginator / GetOpsSummary

GetOpsSummary

class SSM.Paginator.GetOpsSummary

paginator = client.get_paginator('get_ops_summary')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SSM.Client.get_ops_summary().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SyncName='string',
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'Type': 'Equal'|'NotEqual'|'BeginWith'|'LessThan'|'GreaterThan'|'Exists'
        },
    ],
    Aggregators=[
        {
            'AggregatorType': 'string',
            'TypeName': 'string',
            'AttributeName': 'string',
            'Values': {
                'string': 'string'
            },
            'Filters': [
                {
                    'Key': 'string',
                    'Values': [
                        'string',
                    ],
                    'Type': 'Equal'|'NotEqual'|'BeginWith'|'LessThan'|'GreaterThan'|'Exists'
                },
            ],
            'Aggregators': {'... recursive ...'}
        },
    ],
    ResultAttributes=[
        {
            'TypeName': 'string'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• SyncName (string) – Specify the name of a resource data sync to get.

• Filters (list) –

  Optional filters used to scope down the returned OpsData.

  • (dict) –

    A filter for viewing OpsData summaries.

    • Key (string) – [REQUIRED]

      The name of the filter.

    • Values (list) – [REQUIRED]

      The filter value.

      • (string) –

    • Type (string) –

      The type of filter.

• Aggregators (list) –

  Optional aggregators that return counts of OpsData based on one or more expressions.

  • (dict) –

    One or more aggregators for viewing counts of OpsData using different dimensions such as Source, CreatedTime, or Source and CreatedTime, to name a few.

    • AggregatorType (string) –

      Either a Range or Count aggregator for limiting an OpsData summary.

    • TypeName (string) –

      The data type name to use for viewing counts of OpsData.

    • AttributeName (string) –

      The name of an OpsData attribute on which to limit the count of OpsData.

    • Values (dict) –

      The aggregator value.

      • (string) –

        • (string) –

    • Filters (list) –

      The aggregator filters.

      • (dict) –

        A filter for viewing OpsData summaries.

        • Key (string) – [REQUIRED]

          The name of the filter.

        • Values (list) – [REQUIRED]

          The filter value.

          • (string) –

        • Type (string) –

          The type of filter.

    • Aggregators (list) –

      A nested aggregator for viewing counts of OpsData.

• ResultAttributes (list) –

  The OpsData data type to return.

  • (dict) –

    The OpsItem data type to return.

    • TypeName (string) – [REQUIRED]

      Name of the data type. Valid value: AWS:OpsItem, AWS:EC2InstanceInformation, AWS:OpsItemTrendline, or AWS:ComplianceSummary.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'Entities': [
        {
            'Id': 'string',
            'Data': {
                'string': {
                    'CaptureTime': 'string',
                    'Content': [
                        {
                            'string': 'string'
                        },
                    ]
                }
            }
        },
    ],

}

Response Structure

• (dict) –

  • Entities (list) –

    The list of aggregated details and filtered OpsData.

    • (dict) –

      The result of the query.

      • Id (string) –

        The query ID.

      • Data (dict) –

        The data returned by the query.

        • (string) –

          • (dict) –

            The OpsData summary.

            • CaptureTime (string) –

              The time the OpsData was captured.

            • Content (list) –

              The details of an OpsData summary.

              • (dict) –

                • (string) –

                  • (string) –