ControlTower / Paginator / ListLandingZoneOperations

ListLandingZoneOperations#

class ControlTower.Paginator.ListLandingZoneOperations#
paginator = client.get_paginator('list_landing_zone_operations')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from ControlTower.Client.list_landing_zone_operations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filter={
        'statuses': [
            'SUCCEEDED'|'FAILED'|'IN_PROGRESS',
        ],
        'types': [
            'DELETE'|'CREATE'|'UPDATE'|'RESET',
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • filter (dict) –

    An input filter for the ListLandingZoneOperations API that lets you select the types of landing zone operations to view.

    • statuses (list) –

      The statuses of the set of landing zone operations selected by the filter.

      • (string) –

    • types (list) –

      The set of landing zone operation types selected by the filter.

      • (string) –

  • 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

{
    'landingZoneOperations': [
        {
            'operationIdentifier': 'string',
            'operationType': 'DELETE'|'CREATE'|'UPDATE'|'RESET',
            'status': 'SUCCEEDED'|'FAILED'|'IN_PROGRESS'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • landingZoneOperations (list) –

      Lists landing zone operations.

      • (dict) –

        Returns a summary of information about a landing zone operation.

        • operationIdentifier (string) –

          The operationIdentifier of the landing zone operation.

        • operationType (string) –

          The type of the landing zone operation.

        • status (string) –

          The status of the landing zone operation.

    • NextToken (string) –

      A token to resume pagination.