NetworkManager / Paginator / GetTransitGatewayRegistrations

GetTransitGatewayRegistrations

class NetworkManager.Paginator.GetTransitGatewayRegistrations

paginator = client.get_paginator('get_transit_gateway_registrations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.get_transit_gateway_registrations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalNetworkId='string',
    TransitGatewayArns=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• GlobalNetworkId (string) –

  [REQUIRED]

  The ID of the global network.

• TransitGatewayArns (list) –

  The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.

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

{
    'TransitGatewayRegistrations': [
        {
            'GlobalNetworkId': 'string',
            'TransitGatewayArn': 'string',
            'State': {
                'Code': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'|'FAILED',
                'Message': 'string'
            }
        },
    ],

}

Response Structure

• (dict) –

  • TransitGatewayRegistrations (list) –

    The transit gateway registrations.

    • (dict) –

      Describes the registration of a transit gateway to a global network.

      • GlobalNetworkId (string) –

        The ID of the global network.

      • TransitGatewayArn (string) –

        The Amazon Resource Name (ARN) of the transit gateway.

      • State (dict) –

        The state of the transit gateway registration.

        • Code (string) –

          The code for the state reason.

        • Message (string) –

          The message for the state reason.