[ aws . networkmanager ]

get-transit-gateway-peering

Description

Returns information about a transit gateway peer.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-transit-gateway-peering
--peering-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--peering-id (string)

The ID of the peering request.

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

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

TransitGatewayPeering -> (structure)

Returns information about a transit gateway peering.

Peering -> (structure)

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.

(structure)

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

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.