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.DescribeOutboundConnections

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Synopsis

Creating a Request

data DescribeOutboundConnections Source #

Container for the parameters to the DescribeOutboundConnections operation.

See: newDescribeOutboundConnections smart constructor.

Constructors

DescribeOutboundConnections'

Fields

filters :: Maybe [Filter]
List of filter names and values that you can use for requests.
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 DescribeOutboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeOutboundConnections operations, which returns results in the next page.

Instances

Instances details

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

newDescribeOutboundConnections :: DescribeOutboundConnections Source #

Create a value of DescribeOutboundConnections 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:DescribeOutboundConnections', describeOutboundConnections_filters - List of filter names and values that you can use for requests.

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

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

Request Lenses

describeOutboundConnections_filters :: Lens' DescribeOutboundConnections (Maybe [Filter]) Source #

List of filter names and values that you can use for requests.

describeOutboundConnections_maxResults :: Lens' DescribeOutboundConnections (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.

describeOutboundConnections_nextToken :: Lens' DescribeOutboundConnections (Maybe Text) Source #

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

Destructuring the Response

data DescribeOutboundConnectionsResponse Source #

Contains a list of connections matching the filter criteria.

See: newDescribeOutboundConnectionsResponse smart constructor.

Constructors

DescribeOutboundConnectionsResponse'
Fields connections :: Maybe [OutboundConnection] List of outbound connections that match the filter criteria. 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 DescribeOutboundConnectionsResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeOutboundConnections Associated Types type Rep DescribeOutboundConnectionsResponse :: Type -> Type # Methods from :: DescribeOutboundConnectionsResponse -> Rep DescribeOutboundConnectionsResponse x # to :: Rep DescribeOutboundConnectionsResponse x -> DescribeOutboundConnectionsResponse #
Read DescribeOutboundConnectionsResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeOutboundConnections Methods readsPrec :: Int -> ReadS DescribeOutboundConnectionsResponse # readList :: ReadS [DescribeOutboundConnectionsResponse] # readPrec :: ReadPrec DescribeOutboundConnectionsResponse # readListPrec :: ReadPrec [DescribeOutboundConnectionsResponse] #
Show DescribeOutboundConnectionsResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeOutboundConnections Methods showsPrec :: Int -> DescribeOutboundConnectionsResponse -> ShowS # show :: DescribeOutboundConnectionsResponse -> String # showList :: [DescribeOutboundConnectionsResponse] -> ShowS #
NFData DescribeOutboundConnectionsResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeOutboundConnections Methods rnf :: DescribeOutboundConnectionsResponse -> () #
Eq DescribeOutboundConnectionsResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeOutboundConnections Methods (==) :: DescribeOutboundConnectionsResponse -> DescribeOutboundConnectionsResponse -> Bool # (/=) :: DescribeOutboundConnectionsResponse -> DescribeOutboundConnectionsResponse -> Bool #
type Rep DescribeOutboundConnectionsResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeOutboundConnections type Rep DescribeOutboundConnectionsResponse = D1 ('MetaData "DescribeOutboundConnectionsResponse" "Amazonka.OpenSearch.DescribeOutboundConnections" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "DescribeOutboundConnectionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OutboundConnection])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeOutboundConnectionsResponse Source #

Arguments

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

Create a value of DescribeOutboundConnectionsResponse 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:DescribeOutboundConnectionsResponse', describeOutboundConnectionsResponse_connections - List of outbound connections that match the filter criteria.

DescribeOutboundConnections, describeOutboundConnectionsResponse_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:DescribeOutboundConnectionsResponse', describeOutboundConnectionsResponse_httpStatus - The response's http status code.

Response Lenses

describeOutboundConnectionsResponse_connections :: Lens' DescribeOutboundConnectionsResponse (Maybe [OutboundConnection]) Source #

List of outbound connections that match the filter criteria.

describeOutboundConnectionsResponse_nextToken :: Lens' DescribeOutboundConnectionsResponse (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.

describeOutboundConnectionsResponse_httpStatus :: Lens' DescribeOutboundConnectionsResponse Int Source #

The response's http status code.