describe_outbound_cross_cluster_search_connections

describe_outbound_cross_cluster_search_connections(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_outbound_cross_cluster_search_connections(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters

• 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
  • (dict) --

    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) --
• MaxResults (integer) -- Set this value to limit the number of results returned. If not specified, defaults to 100.
• NextToken (string) -- NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

Return type

dict

Returns

Response Syntax

{
    'CrossClusterSearchConnections': [
        {
            'SourceDomainInfo': {
                'OwnerId': 'string',
                'DomainName': 'string',
                'Region': 'string'
            },
            'DestinationDomainInfo': {
                'OwnerId': 'string',
                'DomainName': 'string',
                'Region': 'string'
            },
            'CrossClusterSearchConnectionId': 'string',
            'ConnectionAlias': 'string',
            'ConnectionStatus': {
                'StatusCode': 'PENDING_ACCEPTANCE'|'VALIDATING'|'VALIDATION_FAILED'|'PROVISIONING'|'ACTIVE'|'REJECTED'|'DELETING'|'DELETED',
                'Message': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  The result of a DescribeOutboundCrossClusterSearchConnections request. Contains the list of connections matching the filter criteria.

  • CrossClusterSearchConnections (list) --

    Consists of list of OutboundCrossClusterSearchConnection matching the specified filter criteria.

    • (dict) --

      Specifies details of an outbound connection.

      • SourceDomainInfo (dict) --

        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 (dict) --

        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 (dict) --

        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.

Exceptions

• ElasticsearchService.Client.exceptions.InvalidPaginationTokenException
• ElasticsearchService.Client.exceptions.DisabledOperationException