Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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

describe-outbound-connections

Description

Lists all the outbound cross-cluster connections for a local domain.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-outbound-connections
[--filters <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--filters (list)

A list of filters used to match properties for outbound cross-cluster connections. Available `` Filter `` names for this operation are:

  • connection-id
  • remote-domain-info.domain-name
  • remote-domain-info.owner-id
  • remote-domain-info.region
  • local-domain-info.domain-name

(structure)

A filter used to limit results when describing inbound or outbound cross-cluster connections. Multiple values can be specified per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.

Name -> (string)

The name of the filter.

Values -> (list)

Contains one or more values for the filter.

(string)

Shorthand Syntax:

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

JSON Syntax:

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

--max-results (integer)

Set this value to limit the number of results returned. If not specified, defaults to 100.

--next-token (string)

NextToken is sent in case the earlier API call results contain the NextToken parameter. Used for pagination.

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

See 'aws help' for descriptions of global parameters.

Output

Connections -> (list)

A list of `` OutboundConnection `` matching the specified filter criteria.

(structure)

Specifies details about an outbound connection.

LocalDomainInfo -> (structure)

The `` DomainInformation `` for the local OpenSearch domain.

AWSDomainInformation -> (structure)

OwnerId -> (string)

DomainName -> (string)

The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Region -> (string)

RemoteDomainInfo -> (structure)

The `` DomainInformation `` for the remote OpenSearch domain.

AWSDomainInformation -> (structure)

OwnerId -> (string)

DomainName -> (string)

The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Region -> (string)

ConnectionId -> (string)

The connection ID for the outbound cross-cluster connection.

ConnectionAlias -> (string)

The connection alias for the outbound cross-cluster connection.

ConnectionStatus -> (structure)

The `` OutboundConnectionStatus `` for the outbound connection.

StatusCode -> (string)

The state code for the outbound connection. Can be one of the following:

  • VALIDATING: The outbound connection request is being validated.
  • VALIDATION_FAILED: Validation failed for the connection request.
  • PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.
  • APPROVED: Outbound connection has been approved by the remote domain owner for getting provisioned.
  • PROVISIONING: Outbound connection request is in process.
  • ACTIVE: Outbound connection is active and ready to use.
  • REJECTING: Outbound connection rejection by remote domain owner is in progress.
  • REJECTED: Outbound connection request is rejected by remote domain owner.
  • DELETING: Outbound connection deletion is in progress.
  • DELETED: Outbound connection is deleted and can no longer be used.

Message -> (string)

Verbose information for the outbound connection status.

NextToken -> (string)

If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.