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.DescribeTransitGatewayVpcAttachments

Description

Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeTransitGatewayVpcAttachments Source #

Constructors

DescribeTransitGatewayVpcAttachments' 

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. The possible values are:

    • state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
    • transit-gateway-attachment-id - The ID of the attachment.
    • transit-gateway-id - The ID of the transit gateway.
    • vpc-id - The ID of the VPC.
  • 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.

  • transitGatewayAttachmentIds :: Maybe [Text]

    The IDs of the attachments.

Instances

Instances details
ToHeaders DescribeTransitGatewayVpcAttachments Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

ToPath DescribeTransitGatewayVpcAttachments Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

ToQuery DescribeTransitGatewayVpcAttachments Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

AWSPager DescribeTransitGatewayVpcAttachments Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

AWSRequest DescribeTransitGatewayVpcAttachments Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

Generic DescribeTransitGatewayVpcAttachments Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

Read DescribeTransitGatewayVpcAttachments Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

Show DescribeTransitGatewayVpcAttachments Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

NFData DescribeTransitGatewayVpcAttachments Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

Eq DescribeTransitGatewayVpcAttachments Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

Hashable DescribeTransitGatewayVpcAttachments Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

type AWSResponse DescribeTransitGatewayVpcAttachments Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

type Rep DescribeTransitGatewayVpcAttachments Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

type Rep DescribeTransitGatewayVpcAttachments = D1 ('MetaData "DescribeTransitGatewayVpcAttachments" "Amazonka.EC2.DescribeTransitGatewayVpcAttachments" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeTransitGatewayVpcAttachments'" '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 "transitGatewayAttachmentIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newDescribeTransitGatewayVpcAttachments :: DescribeTransitGatewayVpcAttachments Source #

Create a value of DescribeTransitGatewayVpcAttachments 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:DescribeTransitGatewayVpcAttachments', describeTransitGatewayVpcAttachments_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:DescribeTransitGatewayVpcAttachments', describeTransitGatewayVpcAttachments_filters - One or more filters. The possible values are:

  • state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
  • transit-gateway-attachment-id - The ID of the attachment.
  • transit-gateway-id - The ID of the transit gateway.
  • vpc-id - The ID of the VPC.

$sel:maxResults:DescribeTransitGatewayVpcAttachments', describeTransitGatewayVpcAttachments_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.

DescribeTransitGatewayVpcAttachments, describeTransitGatewayVpcAttachments_nextToken - The token for the next page of results.

$sel:transitGatewayAttachmentIds:DescribeTransitGatewayVpcAttachments', describeTransitGatewayVpcAttachments_transitGatewayAttachmentIds - The IDs of the attachments.

Request Lenses

describeTransitGatewayVpcAttachments_dryRun :: Lens' DescribeTransitGatewayVpcAttachments (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.

describeTransitGatewayVpcAttachments_filters :: Lens' DescribeTransitGatewayVpcAttachments (Maybe [Filter]) Source #

One or more filters. The possible values are:

  • state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
  • transit-gateway-attachment-id - The ID of the attachment.
  • transit-gateway-id - The ID of the transit gateway.
  • vpc-id - The ID of the VPC.

describeTransitGatewayVpcAttachments_maxResults :: Lens' DescribeTransitGatewayVpcAttachments (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.

Destructuring the Response

data DescribeTransitGatewayVpcAttachmentsResponse Source #

Constructors

DescribeTransitGatewayVpcAttachmentsResponse' 

Fields

Instances

Instances details
Generic DescribeTransitGatewayVpcAttachmentsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

Read DescribeTransitGatewayVpcAttachmentsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

Show DescribeTransitGatewayVpcAttachmentsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

NFData DescribeTransitGatewayVpcAttachmentsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

Eq DescribeTransitGatewayVpcAttachmentsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

type Rep DescribeTransitGatewayVpcAttachmentsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayVpcAttachments

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

newDescribeTransitGatewayVpcAttachmentsResponse Source #

Create a value of DescribeTransitGatewayVpcAttachmentsResponse 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:

DescribeTransitGatewayVpcAttachments, describeTransitGatewayVpcAttachmentsResponse_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:transitGatewayVpcAttachments:DescribeTransitGatewayVpcAttachmentsResponse', describeTransitGatewayVpcAttachmentsResponse_transitGatewayVpcAttachments - Information about the VPC attachments.

$sel:httpStatus:DescribeTransitGatewayVpcAttachmentsResponse', describeTransitGatewayVpcAttachmentsResponse_httpStatus - The response's http status code.

Response Lenses

describeTransitGatewayVpcAttachmentsResponse_nextToken :: Lens' DescribeTransitGatewayVpcAttachmentsResponse (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.