| 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
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
- data DescribeInboundConnections = DescribeInboundConnections' {}
- newDescribeInboundConnections :: DescribeInboundConnections
- describeInboundConnections_filters :: Lens' DescribeInboundConnections (Maybe [Filter])
- describeInboundConnections_maxResults :: Lens' DescribeInboundConnections (Maybe Int)
- describeInboundConnections_nextToken :: Lens' DescribeInboundConnections (Maybe Text)
- data DescribeInboundConnectionsResponse = DescribeInboundConnectionsResponse' {
- connections :: Maybe [InboundConnection]
- nextToken :: Maybe Text
- httpStatus :: Int
- newDescribeInboundConnectionsResponse :: Int -> DescribeInboundConnectionsResponse
- describeInboundConnectionsResponse_connections :: Lens' DescribeInboundConnectionsResponse (Maybe [InboundConnection])
- describeInboundConnectionsResponse_nextToken :: Lens' DescribeInboundConnectionsResponse (Maybe Text)
- describeInboundConnectionsResponse_httpStatus :: Lens' DescribeInboundConnectionsResponse Int
Creating a Request
data DescribeInboundConnections Source #
Container for the parameters to the DescribeInboundConnections
operation.
See: newDescribeInboundConnections smart constructor.
Constructors
| DescribeInboundConnections' | |
Fields
| |
Instances
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
| |
Instances
newDescribeInboundConnectionsResponse Source #
Arguments
| :: Int | |
| -> 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.