AWS CLI Command Reference

[ aws . opensearch ]

describe-outbound-connections

Description

Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service .

See also: AWS API Documentation

Synopsis

  describe-outbound-connections
[--filters <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--filters (list)

List of filter names and values that you can use for requests.

(structure)

A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values 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)

One or more values for the filter.

(string)

Shorthand Syntax:

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

JSON Syntax:

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

--max-results (integer)

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

--next-token (string)

If your initial DescribeOutboundConnections operation returns a nextToken , you can include the returned nextToken in subsequent DescribeOutboundConnections operations, which returns results in the next page.

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

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.

--output (string)

The formatting style for command output.

  • json

  • text

  • table

  • yaml

  • yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64

  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

Connections -> (list)

List of outbound connections that match the filter criteria.

(structure)

Specifies details about an outbound cross-cluster connection.

LocalDomainInfo -> (structure)

Information about the source (local) domain.

AWSDomainInformation -> (structure)

Information about an Amazon OpenSearch Service domain.

OwnerId -> (string)

The Amazon Web Services account ID of the domain owner.

DomainName -> (string)

Name of the domain.

Region -> (string)

The Amazon Web Services Region in which the domain is located.

RemoteDomainInfo -> (structure)

Information about the destination (remote) domain.

AWSDomainInformation -> (structure)

Information about an Amazon OpenSearch Service domain.

OwnerId -> (string)

The Amazon Web Services account ID of the domain owner.

DomainName -> (string)

Name of the domain.

Region -> (string)

The Amazon Web Services Region in which the domain is located.

ConnectionId -> (string)

Unique identifier of the connection.

ConnectionAlias -> (string)

Name of the connection.

ConnectionStatus -> (structure)

Status of the connection.

StatusCode -> (string)

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

NextToken -> (string)

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

© Copyright 2018, Amazon Web Services. Created using Sphinx.