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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Synopsis

Creating a Request

data DescribeInboundConnections Source #

Container for the parameters to the DescribeInboundConnections operation.

See: newDescribeInboundConnections smart constructor.

Constructors

DescribeInboundConnections'

Fields

filters :: Maybe [Filter]
A list of filters used to match properties for inbound cross-cluster connections.
maxResults :: Maybe Int
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
nextToken :: Maybe Text
If your initial DescribeInboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeInboundConnections operations, which returns results in the next page.

Instances

Instances details

ToJSON DescribeInboundConnections Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections Methods toJSON :: DescribeInboundConnections -> Value # toEncoding :: DescribeInboundConnections -> Encoding # toJSONList :: [DescribeInboundConnections] -> Value # toEncodingList :: [DescribeInboundConnections] -> Encoding #
ToHeaders DescribeInboundConnections Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections Methods toHeaders :: DescribeInboundConnections -> [Header] #
ToPath DescribeInboundConnections Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections Methods toPath :: DescribeInboundConnections -> ByteString #
ToQuery DescribeInboundConnections Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections Methods toQuery :: DescribeInboundConnections -> QueryString #
AWSRequest DescribeInboundConnections Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections Associated Types type AWSResponse DescribeInboundConnections # Methods request :: (Service -> Service) -> DescribeInboundConnections -> Request DescribeInboundConnections # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeInboundConnections -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeInboundConnections))) #
Generic DescribeInboundConnections Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections Associated Types type Rep DescribeInboundConnections :: Type -> Type # Methods from :: DescribeInboundConnections -> Rep DescribeInboundConnections x # to :: Rep DescribeInboundConnections x -> DescribeInboundConnections #
Read DescribeInboundConnections Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections Methods readsPrec :: Int -> ReadS DescribeInboundConnections # readList :: ReadS [DescribeInboundConnections] # readPrec :: ReadPrec DescribeInboundConnections # readListPrec :: ReadPrec [DescribeInboundConnections] #
Show DescribeInboundConnections Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections Methods showsPrec :: Int -> DescribeInboundConnections -> ShowS # show :: DescribeInboundConnections -> String # showList :: [DescribeInboundConnections] -> ShowS #
NFData DescribeInboundConnections Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections Methods rnf :: DescribeInboundConnections -> () #
Eq DescribeInboundConnections Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections Methods (==) :: DescribeInboundConnections -> DescribeInboundConnections -> Bool # (/=) :: DescribeInboundConnections -> DescribeInboundConnections -> Bool #
Hashable DescribeInboundConnections Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections Methods hashWithSalt :: Int -> DescribeInboundConnections -> Int # hash :: DescribeInboundConnections -> Int #
type AWSResponse DescribeInboundConnections Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections type AWSResponse DescribeInboundConnections = DescribeInboundConnectionsResponse
type Rep DescribeInboundConnections Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections type Rep DescribeInboundConnections = D1 ('MetaData "DescribeInboundConnections" "Amazonka.OpenSearch.DescribeInboundConnections" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "DescribeInboundConnections'" '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)))))

newDescribeInboundConnections :: DescribeInboundConnections Source #

Create a value of DescribeInboundConnections 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:DescribeInboundConnections', describeInboundConnections_filters - A list of filters used to match properties for inbound cross-cluster connections.

$sel:maxResults:DescribeInboundConnections', describeInboundConnections_maxResults - An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

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

Request Lenses

describeInboundConnections_filters :: Lens' DescribeInboundConnections (Maybe [Filter]) Source #

A list of filters used to match properties for inbound cross-cluster connections.

describeInboundConnections_maxResults :: Lens' DescribeInboundConnections (Maybe Int) Source #

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

describeInboundConnections_nextToken :: Lens' DescribeInboundConnections (Maybe Text) Source #

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

Destructuring the Response

data DescribeInboundConnectionsResponse Source #

Contains a list of connections matching the filter criteria.

See: newDescribeInboundConnectionsResponse smart constructor.

Constructors

DescribeInboundConnectionsResponse'
Fields connections :: Maybe [InboundConnection] List of inbound connections. nextToken :: Maybe Text 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. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeInboundConnectionsResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections Associated Types type Rep DescribeInboundConnectionsResponse :: Type -> Type # Methods from :: DescribeInboundConnectionsResponse -> Rep DescribeInboundConnectionsResponse x # to :: Rep DescribeInboundConnectionsResponse x -> DescribeInboundConnectionsResponse #
Read DescribeInboundConnectionsResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections Methods readsPrec :: Int -> ReadS DescribeInboundConnectionsResponse # readList :: ReadS [DescribeInboundConnectionsResponse] # readPrec :: ReadPrec DescribeInboundConnectionsResponse # readListPrec :: ReadPrec [DescribeInboundConnectionsResponse] #
Show DescribeInboundConnectionsResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections Methods showsPrec :: Int -> DescribeInboundConnectionsResponse -> ShowS # show :: DescribeInboundConnectionsResponse -> String # showList :: [DescribeInboundConnectionsResponse] -> ShowS #
NFData DescribeInboundConnectionsResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections Methods rnf :: DescribeInboundConnectionsResponse -> () #
Eq DescribeInboundConnectionsResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections Methods (==) :: DescribeInboundConnectionsResponse -> DescribeInboundConnectionsResponse -> Bool # (/=) :: DescribeInboundConnectionsResponse -> DescribeInboundConnectionsResponse -> Bool #
type Rep DescribeInboundConnectionsResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeInboundConnections type Rep DescribeInboundConnectionsResponse = D1 ('MetaData "DescribeInboundConnectionsResponse" "Amazonka.OpenSearch.DescribeInboundConnections" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "DescribeInboundConnectionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InboundConnection])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeInboundConnectionsResponse Source #

Arguments

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

Create a value of DescribeInboundConnectionsResponse 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:connections:DescribeInboundConnectionsResponse', describeInboundConnectionsResponse_connections - List of inbound connections.

DescribeInboundConnections, describeInboundConnectionsResponse_nextToken - 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.

$sel:httpStatus:DescribeInboundConnectionsResponse', describeInboundConnectionsResponse_httpStatus - The response's http status code.

Response Lenses

describeInboundConnectionsResponse_connections :: Lens' DescribeInboundConnectionsResponse (Maybe [InboundConnection]) Source #

List of inbound connections.

describeInboundConnectionsResponse_nextToken :: Lens' DescribeInboundConnectionsResponse (Maybe Text) Source #

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.

describeInboundConnectionsResponse_httpStatus :: Lens' DescribeInboundConnectionsResponse Int Source #

The response's http status code.