AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . networkmanager ]

get-transit-gateway-peering

Description

Returns information about a transit gateway peer.

See also: AWS API Documentation

Synopsis

  get-transit-gateway-peering
--peering-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--peering-id (string)

The ID of the peering request.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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.

LastModificationErrors -> (list)

Describes the error associated with the Connect peer request.

(structure)

Describes an error associated with a peering request.

Code -> (string)

The error code for the peering request.

Message -> (string)

The message associated with the error code .

ResourceArn -> (string)

The ARN of the requested peering resource.

RequestId -> (string)

The ID of the Peering request.

MissingPermissionsContext -> (structure)

Provides additional information about missing permissions for the peering error.

MissingPermission -> (string)

The missing permissions.

TransitGatewayArn -> (string)

The ARN of the transit gateway.

TransitGatewayPeeringAttachmentId -> (string)

The ID of the transit gateway peering attachment.