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

get-odb-peering-connection

Description

Retrieves information about an ODB peering connection.

See also: AWS API Documentation

Synopsis

  get-odb-peering-connection
--odb-peering-connection-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

--odb-peering-connection-id (string)

The unique identifier of the ODB peering connection to retrieve information about.

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

odbPeeringConnection -> (structure)

A peering connection between an ODB network and either another ODB network or a customer-owned VPC.

odbPeeringConnectionId -> (string)

The unique identifier of the ODB peering connection. A sample ID is odbpcx-abcdefgh12345678 .

displayName -> (string)

The display name of the ODB peering connection.

status -> (string)

The status of the ODB peering connection.

Valid Values: provisioning | active | terminating | terminated | failed

statusReason -> (string)

The reason for the current status of the ODB peering connection.

odbPeeringConnectionArn -> (string)

The Amazon Resource Name (ARN) of the ODB peering connection.

Example: arn:aws:odb:us-east-1:123456789012:odb-peering-connection/odbpcx-abcdefgh12345678

odbNetworkArn -> (string)

The Amazon Resource Name (ARN) of the ODB network that initiated the peering connection.

peerNetworkArn -> (string)

The Amazon Resource Name (ARN) of the peer network.

odbPeeringConnectionType -> (string)

The type of the ODB peering connection.

Valid Values: ODB-VPC | ODB-ODB

createdAt -> (timestamp)

The timestamp when the ODB peering connection was created.

percentProgress -> (float)

The percentage progress of the ODB peering connection creation or deletion.