NetworkManager / Client / get_transit_gateway_connect_peer_associations

get_transit_gateway_connect_peer_associations#

NetworkManager.Client.get_transit_gateway_connect_peer_associations(**kwargs)#

Gets information about one or more of your transit gateway Connect peer associations in a global network.

See also: AWS API Documentation

Request Syntax

response = client.get_transit_gateway_connect_peer_associations(
    GlobalNetworkId='string',
    TransitGatewayConnectPeerArns=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters:
  • GlobalNetworkId (string) –

    [REQUIRED]

    The ID of the global network.

  • TransitGatewayConnectPeerArns (list) –

    One or more transit gateway Connect peer Amazon Resource Names (ARNs).

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

{
    'TransitGatewayConnectPeerAssociations': [
        {
            'TransitGatewayConnectPeerArn': 'string',
            'GlobalNetworkId': 'string',
            'DeviceId': 'string',
            'LinkId': 'string',
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • TransitGatewayConnectPeerAssociations (list) –

      Information about the transit gateway Connect peer associations.

      • (dict) –

        Describes a transit gateway Connect peer association.

        • TransitGatewayConnectPeerArn (string) –

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

        • GlobalNetworkId (string) –

          The ID of the global network.

        • DeviceId (string) –

          The ID of the device.

        • LinkId (string) –

          The ID of the link.

        • State (string) –

          The state of the association.

    • NextToken (string) –

      The token to use for the next page of results.

Exceptions

  • NetworkManager.Client.exceptions.ValidationException

  • NetworkManager.Client.exceptions.AccessDeniedException

  • NetworkManager.Client.exceptions.ResourceNotFoundException

  • NetworkManager.Client.exceptions.ConflictException

  • NetworkManager.Client.exceptions.ThrottlingException

  • NetworkManager.Client.exceptions.InternalServerException