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 |
Describes one or more of your VPC endpoints.
This operation returns paginated results.
Synopsis
- data DescribeVpcEndpoints = DescribeVpcEndpoints' {}
- newDescribeVpcEndpoints :: DescribeVpcEndpoints
- describeVpcEndpoints_dryRun :: Lens' DescribeVpcEndpoints (Maybe Bool)
- describeVpcEndpoints_filters :: Lens' DescribeVpcEndpoints (Maybe [Filter])
- describeVpcEndpoints_maxResults :: Lens' DescribeVpcEndpoints (Maybe Int)
- describeVpcEndpoints_nextToken :: Lens' DescribeVpcEndpoints (Maybe Text)
- describeVpcEndpoints_vpcEndpointIds :: Lens' DescribeVpcEndpoints (Maybe [Text])
- data DescribeVpcEndpointsResponse = DescribeVpcEndpointsResponse' {
- nextToken :: Maybe Text
- vpcEndpoints :: Maybe [VpcEndpoint]
- httpStatus :: Int
- newDescribeVpcEndpointsResponse :: Int -> DescribeVpcEndpointsResponse
- describeVpcEndpointsResponse_nextToken :: Lens' DescribeVpcEndpointsResponse (Maybe Text)
- describeVpcEndpointsResponse_vpcEndpoints :: Lens' DescribeVpcEndpointsResponse (Maybe [VpcEndpoint])
- describeVpcEndpointsResponse_httpStatus :: Lens' DescribeVpcEndpointsResponse Int
Creating a Request
data DescribeVpcEndpoints Source #
Contains the parameters for DescribeVpcEndpoints.
See: newDescribeVpcEndpoints
smart constructor.
DescribeVpcEndpoints' | |
|
Instances
newDescribeVpcEndpoints :: DescribeVpcEndpoints Source #
Create a value of DescribeVpcEndpoints
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:dryRun:DescribeVpcEndpoints'
, describeVpcEndpoints_dryRun
- Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation
.
Otherwise, it is UnauthorizedOperation
.
$sel:filters:DescribeVpcEndpoints'
, describeVpcEndpoints_filters
- One or more filters.
ip-address-type
- The IP address type (ipv4
|ipv6
).service-name
- The name of the service.tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value.tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.vpc-id
- The ID of the VPC in which the endpoint resides.vpc-endpoint-id
- The ID of the endpoint.vpc-endpoint-state
- The state of the endpoint (pendingAcceptance
|pending
|available
|deleting
|deleted
|rejected
|failed
).vpc-endpoint-type
- The type of VPC endpoint (Interface
|Gateway
|GatewayLoadBalancer
).
$sel:maxResults:DescribeVpcEndpoints'
, describeVpcEndpoints_maxResults
- The maximum number of items to return for this request. The request
returns a token that you can specify in a subsequent call to get the
next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
DescribeVpcEndpoints
, describeVpcEndpoints_nextToken
- The token for the next set of items to return. (You received this token
from a prior call.)
$sel:vpcEndpointIds:DescribeVpcEndpoints'
, describeVpcEndpoints_vpcEndpointIds
- One or more endpoint IDs.
Request Lenses
describeVpcEndpoints_dryRun :: Lens' DescribeVpcEndpoints (Maybe Bool) Source #
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation
.
Otherwise, it is UnauthorizedOperation
.
describeVpcEndpoints_filters :: Lens' DescribeVpcEndpoints (Maybe [Filter]) Source #
One or more filters.
ip-address-type
- The IP address type (ipv4
|ipv6
).service-name
- The name of the service.tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value.tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.vpc-id
- The ID of the VPC in which the endpoint resides.vpc-endpoint-id
- The ID of the endpoint.vpc-endpoint-state
- The state of the endpoint (pendingAcceptance
|pending
|available
|deleting
|deleted
|rejected
|failed
).vpc-endpoint-type
- The type of VPC endpoint (Interface
|Gateway
|GatewayLoadBalancer
).
describeVpcEndpoints_maxResults :: Lens' DescribeVpcEndpoints (Maybe Int) Source #
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
describeVpcEndpoints_nextToken :: Lens' DescribeVpcEndpoints (Maybe Text) Source #
The token for the next set of items to return. (You received this token from a prior call.)
describeVpcEndpoints_vpcEndpointIds :: Lens' DescribeVpcEndpoints (Maybe [Text]) Source #
One or more endpoint IDs.
Destructuring the Response
data DescribeVpcEndpointsResponse Source #
Contains the output of DescribeVpcEndpoints.
See: newDescribeVpcEndpointsResponse
smart constructor.
DescribeVpcEndpointsResponse' | |
|
Instances
newDescribeVpcEndpointsResponse Source #
Create a value of DescribeVpcEndpointsResponse
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:
DescribeVpcEndpoints
, describeVpcEndpointsResponse_nextToken
- The token to use when requesting the next set of items. If there are no
additional items to return, the string is empty.
$sel:vpcEndpoints:DescribeVpcEndpointsResponse'
, describeVpcEndpointsResponse_vpcEndpoints
- Information about the endpoints.
$sel:httpStatus:DescribeVpcEndpointsResponse'
, describeVpcEndpointsResponse_httpStatus
- The response's http status code.
Response Lenses
describeVpcEndpointsResponse_nextToken :: Lens' DescribeVpcEndpointsResponse (Maybe Text) Source #
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
describeVpcEndpointsResponse_vpcEndpoints :: Lens' DescribeVpcEndpointsResponse (Maybe [VpcEndpoint]) Source #
Information about the endpoints.
describeVpcEndpointsResponse_httpStatus :: Lens' DescribeVpcEndpointsResponse Int Source #
The response's http status code.