EC2 / Client / describe_transit_gateway_connect_peers

describe_transit_gateway_connect_peers

EC2.Client.describe_transit_gateway_connect_peers(**kwargs)

Describes one or more Connect peers.

See also: AWS API Documentation

Request Syntax

response = client.describe_transit_gateway_connect_peers(
    TransitGatewayConnectPeerIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)

Parameters:

• TransitGatewayConnectPeerIds (list) –

  The IDs of the Connect peers.

  • (string) –

• Filters (list) –

  One or more filters. The possible values are:

  • state - The state of the Connect peer ( pending | available | deleting | deleted).

  • transit-gateway-attachment-id - The ID of the attachment.

  • transit-gateway-connect-peer-id - The ID of the Connect peer.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

• MaxResults (integer) – The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

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

• DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

dict

Returns:

Response Syntax

{
    'TransitGatewayConnectPeers': [
        {
            'TransitGatewayAttachmentId': 'string',
            'TransitGatewayConnectPeerId': 'string',
            'State': 'pending'|'available'|'deleting'|'deleted',
            'CreationTime': datetime(2015, 1, 1),
            'ConnectPeerConfiguration': {
                'TransitGatewayAddress': 'string',
                'PeerAddress': 'string',
                'InsideCidrBlocks': [
                    'string',
                ],
                'Protocol': 'gre',
                'BgpConfigurations': [
                    {
                        'TransitGatewayAsn': 123,
                        'PeerAsn': 123,
                        'TransitGatewayAddress': 'string',
                        'PeerAddress': 'string',
                        'BgpStatus': 'up'|'down'
                    },
                ]
            },
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • TransitGatewayConnectPeers (list) –

    Information about the Connect peers.

    • (dict) –

      Describes a transit gateway Connect peer.

      • TransitGatewayAttachmentId (string) –

        The ID of the Connect attachment.

      • TransitGatewayConnectPeerId (string) –

        The ID of the Connect peer.

      • State (string) –

        The state of the Connect peer.

      • CreationTime (datetime) –

        The creation time.

      • ConnectPeerConfiguration (dict) –

        The Connect peer details.

        • TransitGatewayAddress (string) –

          The Connect peer IP address on the transit gateway side of the tunnel.

        • PeerAddress (string) –

          The Connect peer IP address on the appliance side of the tunnel.

        • InsideCidrBlocks (list) –

          The range of interior BGP peer IP addresses.

          • (string) –

        • Protocol (string) –

          The tunnel protocol.

        • BgpConfigurations (list) –

          The BGP configuration details.

          • (dict) –

            The BGP configuration information.

            • TransitGatewayAsn (integer) –

              The transit gateway Autonomous System Number (ASN).

            • PeerAsn (integer) –

              The peer Autonomous System Number (ASN).

            • TransitGatewayAddress (string) –

              The interior BGP peer IP address for the transit gateway.

            • PeerAddress (string) –

              The interior BGP peer IP address for the appliance.

            • BgpStatus (string) –

              The BGP status.

      • Tags (list) –

        The tags for the Connect peer.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

  • NextToken (string) –

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.