describe-outbound-cross-cluster-search-connections¶
Description¶
Lists all the outbound cross-cluster search connections for a source domain.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-outbound-cross-cluster-search-connections
[--filters <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--filters (list)
A list of filters used to match properties for outbound cross-cluster search connection. Available `` Filter`` names for this operation are:
cross-cluster-search-connection-id
destination-domain-info.domain-name
destination-domain-info.owner-id
destination-domain-info.region
source-domain-info.domain-name
(structure)
A filter used to limit results when describing inbound or outbound cross-cluster search connections. Multiple values can be specified per filter. A cross-cluster search connection must match at least one of the specified values for it to be returned from an operation.
Name -> (string)
Specifies 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. It is used for pagination.
--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.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Output¶
CrossClusterSearchConnections -> (list)
Consists of list of `` OutboundCrossClusterSearchConnection`` matching the specified filter criteria.
(structure)
Specifies details of an outbound connection.
SourceDomainInfo -> (structure)
Specifies the `` DomainInformation`` for the source Elasticsearch domain.
OwnerId -> (string)
DomainName -> (string)
The name of an Elasticsearch 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)
DestinationDomainInfo -> (structure)
Specifies the `` DomainInformation`` for the destination Elasticsearch domain.
OwnerId -> (string)
DomainName -> (string)
The name of an Elasticsearch 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)
CrossClusterSearchConnectionId -> (string)
Specifies the connection id for the outbound cross-cluster search connection.
ConnectionAlias -> (string)
Specifies the connection alias for the outbound cross-cluster search connection.
ConnectionStatus -> (structure)
Specifies the `` OutboundCrossClusterSearchConnectionStatus`` for the outbound connection.
StatusCode -> (string)
The state code for outbound connection. This 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 destination domain owner.
PROVISIONING: Outbound connection request is in process.
ACTIVE: Outbound connection is active and ready to use.
REJECTED: Outbound connection request is rejected by destination domain owner.
DELETING: Outbound connection deletion is in progress.
DELETED: Outbound connection is deleted and cannot be used further.
Message -> (string)
Specifies 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.