| 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
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
- data DescribeOutboundConnections = DescribeOutboundConnections' {}
- newDescribeOutboundConnections :: DescribeOutboundConnections
- describeOutboundConnections_filters :: Lens' DescribeOutboundConnections (Maybe [Filter])
- describeOutboundConnections_maxResults :: Lens' DescribeOutboundConnections (Maybe Int)
- describeOutboundConnections_nextToken :: Lens' DescribeOutboundConnections (Maybe Text)
- data DescribeOutboundConnectionsResponse = DescribeOutboundConnectionsResponse' {}
- newDescribeOutboundConnectionsResponse :: Int -> DescribeOutboundConnectionsResponse
- describeOutboundConnectionsResponse_connections :: Lens' DescribeOutboundConnectionsResponse (Maybe [OutboundConnection])
- describeOutboundConnectionsResponse_nextToken :: Lens' DescribeOutboundConnectionsResponse (Maybe Text)
- describeOutboundConnectionsResponse_httpStatus :: Lens' DescribeOutboundConnectionsResponse Int
Creating a Request
data DescribeOutboundConnections Source #
Container for the parameters to the DescribeOutboundConnections
operation.
See: newDescribeOutboundConnections smart constructor.
Constructors
| DescribeOutboundConnections' | |
Fields
| |
Instances
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
| |
Instances
newDescribeOutboundConnectionsResponse Source #
Arguments
| :: Int | |
| -> 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.