get_transit_gateway_peering

get_transit_gateway_peering(**kwargs)

Returns information about a transit gateway peer.

See also: AWS API Documentation

Request Syntax

response = client.get_transit_gateway_peering(
    PeeringId='string'
)

Parameters

PeeringId (string) --

[REQUIRED]

The ID of the peering request.

Return type

dict

Returns

Response Syntax

{
    'TransitGatewayPeering': {
        'Peering': {
            'CoreNetworkId': 'string',
            'CoreNetworkArn': 'string',
            'PeeringId': 'string',
            'OwnerAccountId': 'string',
            'PeeringType': 'TRANSIT_GATEWAY',
            'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
            'EdgeLocation': 'string',
            'ResourceArn': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'CreatedAt': datetime(2015, 1, 1)
        },
        'TransitGatewayArn': 'string',
        'TransitGatewayPeeringAttachmentId': 'string'
    }
}

Response Structure

• (dict) --
  • TransitGatewayPeering (dict) --

    Returns information about a transit gateway peering.

    • Peering (dict) --

      Describes a transit gateway peer connection.

      • CoreNetworkId (string) --

        The ID of the core network for the peering request.

      • CoreNetworkArn (string) --

        The ARN of a core network.

      • PeeringId (string) --

        The ID of the peering attachment.

      • OwnerAccountId (string) --

        The ID of the account owner.

      • PeeringType (string) --

        The type of peering. This will be TRANSIT_GATEWAY .

      • State (string) --

        The current state of the peering connection.

      • EdgeLocation (string) --

        The edge location for the peer.

      • ResourceArn (string) --

        The resource ARN of the peer.

      • Tags (list) --

        The list of key-value tags associated with the peering.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value (string) --

            The tag value.

            Constraints: Maximum length of 256 characters.

      • CreatedAt (datetime) --

        The timestamp when the attachment peer was created.

    • TransitGatewayArn (string) --

      The ARN of the transit gateway.

    • TransitGatewayPeeringAttachmentId (string) --

      The ID of the transit gateway peering attachment.

Exceptions

• NetworkManager.Client.exceptions.ValidationException
• NetworkManager.Client.exceptions.AccessDeniedException
• NetworkManager.Client.exceptions.ResourceNotFoundException
• NetworkManager.Client.exceptions.ThrottlingException
• NetworkManager.Client.exceptions.InternalServerException