Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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
maxResults :: Maybe Int
Set this value to limit the number of results returned. If not specified, defaults to 100.
nextToken :: Maybe Text
NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

Instances

Instances details

ToJSON DescribeOutboundCrossClusterSearchConnections Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections Methods toJSON :: DescribeOutboundCrossClusterSearchConnections -> Value # toEncoding :: DescribeOutboundCrossClusterSearchConnections -> Encoding # toJSONList :: [DescribeOutboundCrossClusterSearchConnections] -> Value # toEncodingList :: [DescribeOutboundCrossClusterSearchConnections] -> Encoding #
ToHeaders DescribeOutboundCrossClusterSearchConnections Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections Methods toHeaders :: DescribeOutboundCrossClusterSearchConnections -> [Header] #
ToPath DescribeOutboundCrossClusterSearchConnections Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections Methods toPath :: DescribeOutboundCrossClusterSearchConnections -> ByteString #
ToQuery DescribeOutboundCrossClusterSearchConnections Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections Methods toQuery :: DescribeOutboundCrossClusterSearchConnections -> QueryString #
AWSRequest DescribeOutboundCrossClusterSearchConnections Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections Associated Types type AWSResponse DescribeOutboundCrossClusterSearchConnections # Methods request :: (Service -> Service) -> DescribeOutboundCrossClusterSearchConnections -> Request DescribeOutboundCrossClusterSearchConnections # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeOutboundCrossClusterSearchConnections -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeOutboundCrossClusterSearchConnections))) #
Generic DescribeOutboundCrossClusterSearchConnections Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections Associated Types type Rep DescribeOutboundCrossClusterSearchConnections :: Type -> Type # Methods from :: DescribeOutboundCrossClusterSearchConnections -> Rep DescribeOutboundCrossClusterSearchConnections x # to :: Rep DescribeOutboundCrossClusterSearchConnections x -> DescribeOutboundCrossClusterSearchConnections #
Read DescribeOutboundCrossClusterSearchConnections Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections Methods readsPrec :: Int -> ReadS DescribeOutboundCrossClusterSearchConnections # readList :: ReadS [DescribeOutboundCrossClusterSearchConnections] # readPrec :: ReadPrec DescribeOutboundCrossClusterSearchConnections # readListPrec :: ReadPrec [DescribeOutboundCrossClusterSearchConnections] #
Show DescribeOutboundCrossClusterSearchConnections Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections Methods showsPrec :: Int -> DescribeOutboundCrossClusterSearchConnections -> ShowS # show :: DescribeOutboundCrossClusterSearchConnections -> String # showList :: [DescribeOutboundCrossClusterSearchConnections] -> ShowS #
NFData DescribeOutboundCrossClusterSearchConnections Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections Methods rnf :: DescribeOutboundCrossClusterSearchConnections -> () #
Eq DescribeOutboundCrossClusterSearchConnections Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections Methods (==) :: DescribeOutboundCrossClusterSearchConnections -> DescribeOutboundCrossClusterSearchConnections -> Bool # (/=) :: DescribeOutboundCrossClusterSearchConnections -> DescribeOutboundCrossClusterSearchConnections -> Bool #
Hashable DescribeOutboundCrossClusterSearchConnections Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections Methods hashWithSalt :: Int -> DescribeOutboundCrossClusterSearchConnections -> Int # hash :: DescribeOutboundCrossClusterSearchConnections -> Int #
type AWSResponse DescribeOutboundCrossClusterSearchConnections Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections type AWSResponse DescribeOutboundCrossClusterSearchConnections = DescribeOutboundCrossClusterSearchConnectionsResponse
type Rep DescribeOutboundCrossClusterSearchConnections Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections type Rep DescribeOutboundCrossClusterSearchConnections = D1 ('MetaData "DescribeOutboundCrossClusterSearchConnections" "Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections" "amazonka-elasticsearch-2.0-BmZjovliTfgJWgrJ3fCf5z" 'False) (C1 ('MetaCons "DescribeOutboundCrossClusterSearchConnections'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

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:maxResults:DescribeOutboundCrossClusterSearchConnections', describeOutboundCrossClusterSearchConnections_maxResults - Set this value to limit the number of results returned. If not specified, defaults to 100.

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

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_maxResults :: Lens' DescribeOutboundCrossClusterSearchConnections (Maybe Int) Source #

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

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.

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

crossClusterSearchConnections :: Maybe [OutboundCrossClusterSearchConnection]
Consists of list of OutboundCrossClusterSearchConnection matching the specified filter criteria.
nextToken :: Maybe Text
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeOutboundCrossClusterSearchConnectionsResponse Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections Associated Types type Rep DescribeOutboundCrossClusterSearchConnectionsResponse :: Type -> Type # Methods from :: DescribeOutboundCrossClusterSearchConnectionsResponse -> Rep DescribeOutboundCrossClusterSearchConnectionsResponse x # to :: Rep DescribeOutboundCrossClusterSearchConnectionsResponse x -> DescribeOutboundCrossClusterSearchConnectionsResponse #
Read DescribeOutboundCrossClusterSearchConnectionsResponse Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections Methods readsPrec :: Int -> ReadS DescribeOutboundCrossClusterSearchConnectionsResponse # readList :: ReadS [DescribeOutboundCrossClusterSearchConnectionsResponse] # readPrec :: ReadPrec DescribeOutboundCrossClusterSearchConnectionsResponse # readListPrec :: ReadPrec [DescribeOutboundCrossClusterSearchConnectionsResponse] #
Show DescribeOutboundCrossClusterSearchConnectionsResponse Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections Methods showsPrec :: Int -> DescribeOutboundCrossClusterSearchConnectionsResponse -> ShowS # show :: DescribeOutboundCrossClusterSearchConnectionsResponse -> String # showList :: [DescribeOutboundCrossClusterSearchConnectionsResponse] -> ShowS #
NFData DescribeOutboundCrossClusterSearchConnectionsResponse Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections Methods rnf :: DescribeOutboundCrossClusterSearchConnectionsResponse -> () #
Eq DescribeOutboundCrossClusterSearchConnectionsResponse Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections Methods (==) :: DescribeOutboundCrossClusterSearchConnectionsResponse -> DescribeOutboundCrossClusterSearchConnectionsResponse -> Bool # (/=) :: DescribeOutboundCrossClusterSearchConnectionsResponse -> DescribeOutboundCrossClusterSearchConnectionsResponse -> Bool #
type Rep DescribeOutboundCrossClusterSearchConnectionsResponse Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections type Rep DescribeOutboundCrossClusterSearchConnectionsResponse = D1 ('MetaData "DescribeOutboundCrossClusterSearchConnectionsResponse" "Amazonka.ElasticSearch.DescribeOutboundCrossClusterSearchConnections" "amazonka-elasticsearch-2.0-BmZjovliTfgJWgrJ3fCf5z" '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 #

Arguments

:: Int	`$sel:httpStatus:DescribeOutboundCrossClusterSearchConnectionsResponse'`
-> DescribeOutboundCrossClusterSearchConnectionsResponse

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.

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_crossClusterSearchConnections :: Lens' DescribeOutboundCrossClusterSearchConnectionsResponse (Maybe [OutboundCrossClusterSearchConnection]) Source #

Consists of list of OutboundCrossClusterSearchConnection matching the specified filter criteria.

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.

describeOutboundCrossClusterSearchConnectionsResponse_httpStatus :: Lens' DescribeOutboundCrossClusterSearchConnectionsResponse Int Source #

The response's http status code.