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 peering connections.
This operation returns paginated results.
Synopsis
- data DescribeVpcPeeringConnections = DescribeVpcPeeringConnections' {}
- newDescribeVpcPeeringConnections :: DescribeVpcPeeringConnections
- describeVpcPeeringConnections_dryRun :: Lens' DescribeVpcPeeringConnections (Maybe Bool)
- describeVpcPeeringConnections_filters :: Lens' DescribeVpcPeeringConnections (Maybe [Filter])
- describeVpcPeeringConnections_maxResults :: Lens' DescribeVpcPeeringConnections (Maybe Natural)
- describeVpcPeeringConnections_nextToken :: Lens' DescribeVpcPeeringConnections (Maybe Text)
- describeVpcPeeringConnections_vpcPeeringConnectionIds :: Lens' DescribeVpcPeeringConnections (Maybe [Text])
- data DescribeVpcPeeringConnectionsResponse = DescribeVpcPeeringConnectionsResponse' {}
- newDescribeVpcPeeringConnectionsResponse :: Int -> DescribeVpcPeeringConnectionsResponse
- describeVpcPeeringConnectionsResponse_nextToken :: Lens' DescribeVpcPeeringConnectionsResponse (Maybe Text)
- describeVpcPeeringConnectionsResponse_vpcPeeringConnections :: Lens' DescribeVpcPeeringConnectionsResponse (Maybe [VpcPeeringConnection])
- describeVpcPeeringConnectionsResponse_httpStatus :: Lens' DescribeVpcPeeringConnectionsResponse Int
Creating a Request
data DescribeVpcPeeringConnections Source #
See: newDescribeVpcPeeringConnections
smart constructor.
DescribeVpcPeeringConnections' | |
|
Instances
newDescribeVpcPeeringConnections :: DescribeVpcPeeringConnections Source #
Create a value of DescribeVpcPeeringConnections
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:DescribeVpcPeeringConnections'
, describeVpcPeeringConnections_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:DescribeVpcPeeringConnections'
, describeVpcPeeringConnections_filters
- One or more filters.
accepter-vpc-info.cidr-block
- The IPv4 CIDR block of the accepter VPC.accepter-vpc-info.owner-id
- The ID of the Amazon Web Services account that owns the accepter VPC.accepter-vpc-info.vpc-id
- The ID of the accepter VPC.expiration-time
- The expiration date and time for the VPC peering connection.requester-vpc-info.cidr-block
- The IPv4 CIDR block of the requester's VPC.requester-vpc-info.owner-id
- The ID of the Amazon Web Services account that owns the requester VPC.requester-vpc-info.vpc-id
- The ID of the requester VPC.status-code
- The status of the VPC peering connection (pending-acceptance
|failed
|expired
|provisioning
|active
|deleting
|deleted
|rejected
).status-message
- A message that provides more information about the status of the VPC peering connection, if applicable.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-peering-connection-id
- The ID of the VPC peering connection.
$sel:maxResults:DescribeVpcPeeringConnections'
, describeVpcPeeringConnections_maxResults
- The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
DescribeVpcPeeringConnections
, describeVpcPeeringConnections_nextToken
- The token for the next page of results.
$sel:vpcPeeringConnectionIds:DescribeVpcPeeringConnections'
, describeVpcPeeringConnections_vpcPeeringConnectionIds
- One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
Request Lenses
describeVpcPeeringConnections_dryRun :: Lens' DescribeVpcPeeringConnections (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
.
describeVpcPeeringConnections_filters :: Lens' DescribeVpcPeeringConnections (Maybe [Filter]) Source #
One or more filters.
accepter-vpc-info.cidr-block
- The IPv4 CIDR block of the accepter VPC.accepter-vpc-info.owner-id
- The ID of the Amazon Web Services account that owns the accepter VPC.accepter-vpc-info.vpc-id
- The ID of the accepter VPC.expiration-time
- The expiration date and time for the VPC peering connection.requester-vpc-info.cidr-block
- The IPv4 CIDR block of the requester's VPC.requester-vpc-info.owner-id
- The ID of the Amazon Web Services account that owns the requester VPC.requester-vpc-info.vpc-id
- The ID of the requester VPC.status-code
- The status of the VPC peering connection (pending-acceptance
|failed
|expired
|provisioning
|active
|deleting
|deleted
|rejected
).status-message
- A message that provides more information about the status of the VPC peering connection, if applicable.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-peering-connection-id
- The ID of the VPC peering connection.
describeVpcPeeringConnections_maxResults :: Lens' DescribeVpcPeeringConnections (Maybe Natural) Source #
The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
describeVpcPeeringConnections_nextToken :: Lens' DescribeVpcPeeringConnections (Maybe Text) Source #
The token for the next page of results.
describeVpcPeeringConnections_vpcPeeringConnectionIds :: Lens' DescribeVpcPeeringConnections (Maybe [Text]) Source #
One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
Destructuring the Response
data DescribeVpcPeeringConnectionsResponse Source #
See: newDescribeVpcPeeringConnectionsResponse
smart constructor.
DescribeVpcPeeringConnectionsResponse' | |
|
Instances
newDescribeVpcPeeringConnectionsResponse Source #
Create a value of DescribeVpcPeeringConnectionsResponse
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:
DescribeVpcPeeringConnections
, describeVpcPeeringConnectionsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:vpcPeeringConnections:DescribeVpcPeeringConnectionsResponse'
, describeVpcPeeringConnectionsResponse_vpcPeeringConnections
- Information about the VPC peering connections.
$sel:httpStatus:DescribeVpcPeeringConnectionsResponse'
, describeVpcPeeringConnectionsResponse_httpStatus
- The response's http status code.
Response Lenses
describeVpcPeeringConnectionsResponse_nextToken :: Lens' DescribeVpcPeeringConnectionsResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
describeVpcPeeringConnectionsResponse_vpcPeeringConnections :: Lens' DescribeVpcPeeringConnectionsResponse (Maybe [VpcPeeringConnection]) Source #
Information about the VPC peering connections.
describeVpcPeeringConnectionsResponse_httpStatus :: Lens' DescribeVpcPeeringConnectionsResponse Int Source #
The response's http status code.