| 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.OpenSearchServerless.ListVpcEndpoints
Description
Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
Synopsis
- data ListVpcEndpoints = ListVpcEndpoints' {}
- newListVpcEndpoints :: ListVpcEndpoints
- listVpcEndpoints_maxResults :: Lens' ListVpcEndpoints (Maybe Natural)
- listVpcEndpoints_nextToken :: Lens' ListVpcEndpoints (Maybe Text)
- listVpcEndpoints_vpcEndpointFilters :: Lens' ListVpcEndpoints (Maybe VpcEndpointFilters)
- data ListVpcEndpointsResponse = ListVpcEndpointsResponse' {}
- newListVpcEndpointsResponse :: Int -> ListVpcEndpointsResponse
- listVpcEndpointsResponse_nextToken :: Lens' ListVpcEndpointsResponse (Maybe Text)
- listVpcEndpointsResponse_vpcEndpointSummaries :: Lens' ListVpcEndpointsResponse (Maybe [VpcEndpointSummary])
- listVpcEndpointsResponse_httpStatus :: Lens' ListVpcEndpointsResponse Int
Creating a Request
data ListVpcEndpoints Source #
See: newListVpcEndpoints smart constructor.
Constructors
| ListVpcEndpoints' | |
Fields
| |
Instances
newListVpcEndpoints :: ListVpcEndpoints Source #
Create a value of ListVpcEndpoints 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:maxResults:ListVpcEndpoints', listVpcEndpoints_maxResults - An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results. The
default is 20.
ListVpcEndpoints, listVpcEndpoints_nextToken - If your initial ListVpcEndpoints operation returns a nextToken, you
can include the returned nextToken in subsequent ListVpcEndpoints
operations, which returns results in the next page.
$sel:vpcEndpointFilters:ListVpcEndpoints', listVpcEndpoints_vpcEndpointFilters - Filter the results according to the current status of the VPC endpoint.
Possible statuses are CREATING, DELETING, UPDATING, ACTIVE, and
FAILED.
Request Lenses
listVpcEndpoints_maxResults :: Lens' ListVpcEndpoints (Maybe Natural) Source #
An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results. The
default is 20.
listVpcEndpoints_nextToken :: Lens' ListVpcEndpoints (Maybe Text) Source #
If your initial ListVpcEndpoints operation returns a nextToken, you
can include the returned nextToken in subsequent ListVpcEndpoints
operations, which returns results in the next page.
listVpcEndpoints_vpcEndpointFilters :: Lens' ListVpcEndpoints (Maybe VpcEndpointFilters) Source #
Filter the results according to the current status of the VPC endpoint.
Possible statuses are CREATING, DELETING, UPDATING, ACTIVE, and
FAILED.
Destructuring the Response
data ListVpcEndpointsResponse Source #
See: newListVpcEndpointsResponse smart constructor.
Constructors
| ListVpcEndpointsResponse' | |
Fields
| |
Instances
newListVpcEndpointsResponse Source #
Create a value of ListVpcEndpointsResponse 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:
ListVpcEndpoints, listVpcEndpointsResponse_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:vpcEndpointSummaries:ListVpcEndpointsResponse', listVpcEndpointsResponse_vpcEndpointSummaries - Details about each VPC endpoint, including the name and current status.
$sel:httpStatus:ListVpcEndpointsResponse', listVpcEndpointsResponse_httpStatus - The response's http status code.
Response Lenses
listVpcEndpointsResponse_nextToken :: Lens' ListVpcEndpointsResponse (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.
listVpcEndpointsResponse_vpcEndpointSummaries :: Lens' ListVpcEndpointsResponse (Maybe [VpcEndpointSummary]) Source #
Details about each VPC endpoint, including the name and current status.
listVpcEndpointsResponse_httpStatus :: Lens' ListVpcEndpointsResponse Int Source #
The response's http status code.