[ aws . ec2 ]



Describes one or more Connect peers.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-transit-gateway-connect-peers is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: TransitGatewayConnectPeers


[--transit-gateway-connect-peer-ids <value>]
[--filters <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]


--transit-gateway-connect-peer-ids (list)

The IDs of the Connect peers.



"string" "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.


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.

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.


Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

    "Name": "string",
    "Values": ["string", ...]

--dry-run | --no-dry-run (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 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.



To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To describe a Transit Gateway Connect peer

The following describe-transit-gateway-connect-peers example describes the specified Connect peer.

aws ec2 describe-transit-gateway-connect-peers \
    --transit-gateway-connect-peer-ids tgw-connect-peer-0666adbac4EXAMPLE


    "TransitGatewayConnectPeers": [
            "TransitGatewayAttachmentId": "tgw-attach-0f0927767cEXAMPLE",
            "TransitGatewayConnectPeerId": "tgw-connect-peer-0666adbac4EXAMPLE",
            "State": "available",
            "CreationTime": "2021-10-13T03:35:17.000Z",
            "ConnectPeerConfiguration": {
                "TransitGatewayAddress": "",
                "PeerAddress": "",
                "InsideCidrBlocks": [
                "Protocol": "gre",
                "BgpConfigurations": [
                        "TransitGatewayAsn": 64512,
                        "PeerAsn": 64512,
                        "TransitGatewayAddress": "",
                        "PeerAddress": "",
                        "BgpStatus": "down"
                        "TransitGatewayAsn": 64512,
                        "PeerAsn": 64512,
                        "TransitGatewayAddress": "",
                        "PeerAddress": "",
                        "BgpStatus": "down"
            "Tags": []

For more information, see Transit gateway Connect attachments and Transit Gateway Connect peers in the Transit Gateways Guide.


TransitGatewayConnectPeers -> (list)

Information about the Connect peers.


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 -> (timestamp)

The creation time.

ConnectPeerConfiguration -> (structure)

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.


Protocol -> (string)

The tunnel protocol.

BgpConfigurations -> (list)

The BGP configuration details.


The BGP configuration information.

TransitGatewayAsn -> (long)

The transit gateway Autonomous System Number (ASN).

PeerAsn -> (long)

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.


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.