[ aws . opensearch ]

describe-inbound-connections

Description

Lists all the inbound cross-cluster connections for a remote domain.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--filters (list)

A list of filters used to match properties for inbound cross-cluster connections. Available `` Filter `` values are:

• connection-id

• local-domain-info.domain-name

• local-domain-info.owner-id

• local-domain-info.region

• remote-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)

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.

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

Connections -> (list)

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

(structure)

Details of an inbound connection.

LocalDomainInfo -> (structure)

The `` AWSDomainInformation `` 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 `` AWSDomainInformation `` 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 inbound cross-cluster connection.

ConnectionStatus -> (structure)

The `` InboundConnectionStatus `` for the outbound connection.

StatusCode -> (string)

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

• PENDING_ACCEPTANCE: Inbound connection is not yet accepted by the remote domain owner.

• APPROVED: Inbound connection is pending acceptance by the remote domain owner.

• PROVISIONING: Inbound connection provisioning is in progress.

• ACTIVE: Inbound connection is active and ready to use.

• REJECTING: Inbound connection rejection is in process.

• REJECTED: Inbound connection is rejected.

• DELETING: Inbound connection deletion is in progress.

• DELETED: Inbound connection is deleted and can no longer be used.

Message -> (string)

Verbose information for the inbound 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.