amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DescribeVpcPeeringConnections

Description

Describes one or more of your VPC peering connections.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeVpcPeeringConnections Source #

See: newDescribeVpcPeeringConnections smart constructor.

Constructors

DescribeVpcPeeringConnections' 

Fields

  • dryRun :: Maybe Bool

    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.

  • filters :: Maybe [Filter]

    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 key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA 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.
  • maxResults :: Maybe Natural

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • nextToken :: Maybe Text

    The token for the next page of results.

  • vpcPeeringConnectionIds :: Maybe [Text]

    One or more VPC peering connection IDs.

    Default: Describes all your VPC peering connections.

Instances

Instances details
ToHeaders DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

Methods

toHeaders :: DescribeVpcPeeringConnections -> [Header] #

ToPath DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

Methods

toPath :: DescribeVpcPeeringConnections -> ByteString #

ToQuery DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

Methods

toQuery :: DescribeVpcPeeringConnections -> QueryString #

AWSPager DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

Methods

page :: DescribeVpcPeeringConnections -> AWSResponse DescribeVpcPeeringConnections -> Maybe DescribeVpcPeeringConnections #

AWSRequest DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

Associated Types

type AWSResponse DescribeVpcPeeringConnections #

Methods

request :: (Service -> Service) -> DescribeVpcPeeringConnections -> Request DescribeVpcPeeringConnections #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeVpcPeeringConnections -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeVpcPeeringConnections))) #

Generic DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

Associated Types

type Rep DescribeVpcPeeringConnections :: Type -> Type #

Methods

from :: DescribeVpcPeeringConnections -> Rep DescribeVpcPeeringConnections x #

to :: Rep DescribeVpcPeeringConnections x -> DescribeVpcPeeringConnections #

Read DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

Methods

readsPrec :: Int -> ReadS DescribeVpcPeeringConnections #

readList :: ReadS [DescribeVpcPeeringConnections] #

readPrec :: ReadPrec DescribeVpcPeeringConnections #

readListPrec :: ReadPrec [DescribeVpcPeeringConnections] #

Show DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

Methods

showsPrec :: Int -> DescribeVpcPeeringConnections -> ShowS #

show :: DescribeVpcPeeringConnections -> String #

showList :: [DescribeVpcPeeringConnections] -> ShowS #

NFData DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

Methods

rnf :: DescribeVpcPeeringConnections -> () #

Eq DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

Methods

(==) :: DescribeVpcPeeringConnections -> DescribeVpcPeeringConnections -> Bool #

(/=) :: DescribeVpcPeeringConnections -> DescribeVpcPeeringConnections -> Bool #

Hashable DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

Methods

hashWithSalt :: Int -> DescribeVpcPeeringConnections -> Int #

hash :: DescribeVpcPeeringConnections -> Int #

type AWSResponse DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

type AWSResponse DescribeVpcPeeringConnections = DescribeVpcPeeringConnectionsResponse
type Rep DescribeVpcPeeringConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

type Rep DescribeVpcPeeringConnections = D1 ('MetaData "DescribeVpcPeeringConnections" "Amazonka.EC2.DescribeVpcPeeringConnections" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeVpcPeeringConnections'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcPeeringConnectionIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

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 key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA 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 key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA 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.

Constructors

DescribeVpcPeeringConnectionsResponse' 

Fields

Instances

Instances details
Generic DescribeVpcPeeringConnectionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

Associated Types

type Rep DescribeVpcPeeringConnectionsResponse :: Type -> Type #

Methods

from :: DescribeVpcPeeringConnectionsResponse -> Rep DescribeVpcPeeringConnectionsResponse x #

to :: Rep DescribeVpcPeeringConnectionsResponse x -> DescribeVpcPeeringConnectionsResponse #

Read DescribeVpcPeeringConnectionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

Methods

readsPrec :: Int -> ReadS DescribeVpcPeeringConnectionsResponse #

readList :: ReadS [DescribeVpcPeeringConnectionsResponse] #

readPrec :: ReadPrec DescribeVpcPeeringConnectionsResponse #

readListPrec :: ReadPrec [DescribeVpcPeeringConnectionsResponse] #

Show DescribeVpcPeeringConnectionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

Methods

showsPrec :: Int -> DescribeVpcPeeringConnectionsResponse -> ShowS #

show :: DescribeVpcPeeringConnectionsResponse -> String #

showList :: [DescribeVpcPeeringConnectionsResponse] -> ShowS #

NFData DescribeVpcPeeringConnectionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

Methods

rnf :: DescribeVpcPeeringConnectionsResponse -> () #

Eq DescribeVpcPeeringConnectionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

Methods

(==) :: DescribeVpcPeeringConnectionsResponse -> DescribeVpcPeeringConnectionsResponse -> Bool #

(/=) :: DescribeVpcPeeringConnectionsResponse -> DescribeVpcPeeringConnectionsResponse -> Bool #

type Rep DescribeVpcPeeringConnectionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcPeeringConnections

type Rep DescribeVpcPeeringConnectionsResponse = D1 ('MetaData "DescribeVpcPeeringConnectionsResponse" "Amazonka.EC2.DescribeVpcPeeringConnections" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeVpcPeeringConnectionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "vpcPeeringConnections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VpcPeeringConnection])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeVpcPeeringConnectionsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeVpcPeeringConnectionsResponse'

-> DescribeVpcPeeringConnectionsResponse 

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.