libZSservicesZSamazonka-elasticsearchZSamazonka-elasticsearch
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

Description

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

Synopsis

Creating a Request

data DescribeOutboundCrossClusterSearchConnections Source #

Container for the parameters to the DescribeOutboundCrossClusterSearchConnections operation.

See: newDescribeOutboundCrossClusterSearchConnections smart constructor.

Constructors

DescribeOutboundCrossClusterSearchConnections' 

Fields

  • filters :: Maybe [Filter]

    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
  • nextToken :: Maybe Text

    NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

  • maxResults :: Maybe Int

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

Instances

Instances details
Eq DescribeOutboundCrossClusterSearchConnections Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

Read DescribeOutboundCrossClusterSearchConnections Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

Show DescribeOutboundCrossClusterSearchConnections Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

Generic DescribeOutboundCrossClusterSearchConnections Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

NFData DescribeOutboundCrossClusterSearchConnections Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

Hashable DescribeOutboundCrossClusterSearchConnections Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

ToJSON DescribeOutboundCrossClusterSearchConnections Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

AWSRequest DescribeOutboundCrossClusterSearchConnections Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

ToHeaders DescribeOutboundCrossClusterSearchConnections Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

ToPath DescribeOutboundCrossClusterSearchConnections Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

ToQuery DescribeOutboundCrossClusterSearchConnections Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

type Rep DescribeOutboundCrossClusterSearchConnections Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

type Rep DescribeOutboundCrossClusterSearchConnections = D1 ('MetaData "DescribeOutboundCrossClusterSearchConnections" "Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections" "libZSservicesZSamazonka-elasticsearchZSamazonka-elasticsearch" 'False) (C1 ('MetaCons "DescribeOutboundCrossClusterSearchConnections'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))
type AWSResponse DescribeOutboundCrossClusterSearchConnections Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

newDescribeOutboundCrossClusterSearchConnections :: DescribeOutboundCrossClusterSearchConnections Source #

Create a value of DescribeOutboundCrossClusterSearchConnections with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:filters:DescribeOutboundCrossClusterSearchConnections', describeOutboundCrossClusterSearchConnections_filters - 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

$sel:nextToken:DescribeOutboundCrossClusterSearchConnections', describeOutboundCrossClusterSearchConnections_nextToken - NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

$sel:maxResults:DescribeOutboundCrossClusterSearchConnections', describeOutboundCrossClusterSearchConnections_maxResults - Set this value to limit the number of results returned. If not specified, defaults to 100.

Request Lenses

describeOutboundCrossClusterSearchConnections_filters :: Lens' DescribeOutboundCrossClusterSearchConnections (Maybe [Filter]) Source #

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

describeOutboundCrossClusterSearchConnections_nextToken :: Lens' DescribeOutboundCrossClusterSearchConnections (Maybe Text) Source #

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

describeOutboundCrossClusterSearchConnections_maxResults :: Lens' DescribeOutboundCrossClusterSearchConnections (Maybe Int) Source #

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

Destructuring the Response

data DescribeOutboundCrossClusterSearchConnectionsResponse Source #

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

See: newDescribeOutboundCrossClusterSearchConnectionsResponse smart constructor.

Constructors

DescribeOutboundCrossClusterSearchConnectionsResponse' 

Fields

Instances

Instances details
Eq DescribeOutboundCrossClusterSearchConnectionsResponse Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

Read DescribeOutboundCrossClusterSearchConnectionsResponse Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

Show DescribeOutboundCrossClusterSearchConnectionsResponse Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

Generic DescribeOutboundCrossClusterSearchConnectionsResponse Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

NFData DescribeOutboundCrossClusterSearchConnectionsResponse Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

type Rep DescribeOutboundCrossClusterSearchConnectionsResponse Source # 
Instance details

Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

type Rep DescribeOutboundCrossClusterSearchConnectionsResponse = D1 ('MetaData "DescribeOutboundCrossClusterSearchConnectionsResponse" "Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections" "libZSservicesZSamazonka-elasticsearchZSamazonka-elasticsearch" 'False) (C1 ('MetaCons "DescribeOutboundCrossClusterSearchConnectionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "crossClusterSearchConnections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OutboundCrossClusterSearchConnection])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeOutboundCrossClusterSearchConnectionsResponse Source #

Create a value of DescribeOutboundCrossClusterSearchConnectionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:crossClusterSearchConnections:DescribeOutboundCrossClusterSearchConnectionsResponse', describeOutboundCrossClusterSearchConnectionsResponse_crossClusterSearchConnections - Consists of list of OutboundCrossClusterSearchConnection matching the specified filter criteria.

$sel:nextToken:DescribeOutboundCrossClusterSearchConnections', describeOutboundCrossClusterSearchConnectionsResponse_nextToken - 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.

$sel:httpStatus:DescribeOutboundCrossClusterSearchConnectionsResponse', describeOutboundCrossClusterSearchConnectionsResponse_httpStatus - The response's http status code.

Response Lenses

describeOutboundCrossClusterSearchConnectionsResponse_nextToken :: Lens' DescribeOutboundCrossClusterSearchConnectionsResponse (Maybe Text) Source #

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.