SSM / Client / get_ops_summary

get_ops_summary

SSM.Client.get_ops_summary(**kwargs)

View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.

See also: AWS API Documentation

Request Syntax

response = client.get_ops_summary(
    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'
        },
    ],
    NextToken='string',
    MaxResults=123
)

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.

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

{
    'Entities': [
        {
            'Id': 'string',
            'Data': {
                'string': {
                    'CaptureTime': 'string',
                    'Content': [
                        {
                            'string': 'string'
                        },
                    ]
                }
            }
        },
    ],
    'NextToken': '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) –

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

• SSM.Client.exceptions.ResourceDataSyncNotFoundException

• SSM.Client.exceptions.InvalidFilter

• SSM.Client.exceptions.InvalidNextToken

• SSM.Client.exceptions.InvalidTypeNameException

• SSM.Client.exceptions.InvalidAggregatorException