SsmSap / Paginator / ListOperations

ListOperations

class SsmSap.Paginator.ListOperations

paginator = client.get_paginator('list_operations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SsmSap.Client.list_operations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ApplicationId='string',
    Filters=[
        {
            'Name': 'string',
            'Value': 'string',
            'Operator': 'Equals'|'GreaterThanOrEquals'|'LessThanOrEquals'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ApplicationId (string) –

  [REQUIRED]

  The ID of the application.

• Filters (list) –

  The filters of an operation.

  • (dict) –

    A specific result obtained by specifying the name, value, and operator.

    • Name (string) – [REQUIRED]

      The name of the filter. Filter names are case-sensitive.

    • Value (string) – [REQUIRED]

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values

    • Operator (string) – [REQUIRED]

      The operator for the filter.

• 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

{
    'Operations': [
        {
            'Id': 'string',
            'Type': 'string',
            'Status': 'INPROGRESS'|'SUCCESS'|'ERROR',
            'StatusMessage': 'string',
            'Properties': {
                'string': 'string'
            },
            'ResourceType': 'string',
            'ResourceId': 'string',
            'ResourceArn': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • Operations (list) –

    List of operations performed by AWS Systems Manager for SAP.

    • (dict) –

      The operations performed by AWS Systems Manager for SAP.

      • Id (string) –

        The ID of the operation.

      • Type (string) –

        The type of the operation.

      • Status (string) –

        The status of the operation.

      • StatusMessage (string) –

        The status message of the operation.

      • Properties (dict) –

        The properties of the operation.

        • (string) –

          • (string) –

      • ResourceType (string) –

        The resource type of the operation.

      • ResourceId (string) –

        The resource ID of the operation.

      • ResourceArn (string) –

        The Amazon Resource Name (ARN) of the operation.

      • StartTime (datetime) –

        The start time of the operation.

      • EndTime (datetime) –

        The end time of the operation.

      • LastUpdatedTime (datetime) –

        The time at which the operation was last updated.