NetworkManager / Client / get_transit_gateway_registrations

get_transit_gateway_registrations#

NetworkManager.Client.get_transit_gateway_registrations(**kwargs)#

Gets information about the transit gateway registrations in a specified global network.

See also: AWS API Documentation

Request Syntax

response = client.get_transit_gateway_registrations(
    GlobalNetworkId='string',
    TransitGatewayArns=[
        'string',
    ],
    MaxResults=123,
    NextToken='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) –

  • MaxResults (integer) – The maximum number of results to return.

  • NextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'TransitGatewayRegistrations': [
        {
            'GlobalNetworkId': 'string',
            'TransitGatewayArn': 'string',
            'State': {
                'Code': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'|'FAILED',
                'Message': 'string'
            }
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      The token for the next page of results.

Exceptions