ServiceDiscovery / Paginator / ListOperations

ListOperations

class ServiceDiscovery.Paginator.ListOperations

paginator = client.get_paginator('list_operations')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'NAMESPACE_ID'|'SERVICE_ID'|'STATUS'|'TYPE'|'UPDATE_DATE',
            'Values': [
                'string',
            ],
            'Condition': 'EQ'|'IN'|'BETWEEN'|'BEGINS_WITH'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filters (list) –

  A complex type that contains specifications for the operations that you want to list, for example, operations that you started between a specified start date and end date.

  If you specify more than one filter, an operation must match all filters to be returned by ListOperations.

  • (dict) –

    A complex type that lets you select the operations that you want to list.

    • Name (string) – [REQUIRED]

      Specify the operations that you want to get:

      • NAMESPACE_ID: Gets operations related to specified namespaces.

      • SERVICE_ID: Gets operations related to specified services.

      • STATUS: Gets operations based on the status of the operations: SUBMITTED, PENDING, SUCCEED, or FAIL.

      • TYPE: Gets specified types of operation.

      • UPDATE_DATE: Gets operations that changed status during a specified date/time range.

    • Values (list) – [REQUIRED]

      Specify values that are applicable to the value that you specify for Name:

      • NAMESPACE_ID: Specify one namespace ID.

      • SERVICE_ID: Specify one service ID.

      • STATUS: Specify one or more statuses: SUBMITTED, PENDING, SUCCEED, or FAIL.

      • TYPE: Specify one or more of the following types: CREATE_NAMESPACE, DELETE_NAMESPACE, UPDATE_SERVICE, REGISTER_INSTANCE, or DEREGISTER_INSTANCE.

      • UPDATE_DATE: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.

      • (string) –

    • Condition (string) –

      The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include:

      • EQ: When you specify EQ for the condition, you can specify only one value. EQ is supported for NAMESPACE_ID, SERVICE_ID, STATUS, and TYPE. EQ is the default condition and can be omitted.

      • IN: When you specify IN for the condition, you can specify a list of one or more values. IN is supported for STATUS and TYPE. An operation must match one of the specified values to be returned in the response.

      • BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value. BETWEEN is supported for UPDATE_DATE.

• 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',
            'Status': 'SUBMITTED'|'PENDING'|'SUCCESS'|'FAIL'
        },
    ],

}

Response Structure

• (dict) –

  • Operations (list) –

    Summary information about the operations that match the specified criteria.

    • (dict) –

      A complex type that contains information about an operation that matches the criteria that you specified in a ListOperations request.

      • Id (string) –

        The ID for an operation.

      • Status (string) –

        The status of the operation. Values include the following:

        • SUBMITTED: This is the initial state immediately after you submit a request.

        • PENDING: Cloud Map is performing the operation.

        • SUCCESS: The operation succeeded.

        • FAIL: The operation failed. For the failure reason, see ErrorMessage.