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.EC2.DescribeTransitGatewayAttachments

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeTransitGatewayAttachments Source #

See: newDescribeTransitGatewayAttachments smart constructor.

Constructors

DescribeTransitGatewayAttachments'

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:
- association.state - The state of the association (associating | associated | disassociating).
- association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.
- resource-id - The ID of the resource.
- resource-owner-id - The ID of the Amazon Web Services account that owns the resource.
- resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
- 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.
- transit-gateway-owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
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 DescribeTransitGatewayAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments Methods toHeaders :: DescribeTransitGatewayAttachments -> [Header] #
ToPath DescribeTransitGatewayAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments Methods toPath :: DescribeTransitGatewayAttachments -> ByteString #
ToQuery DescribeTransitGatewayAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments Methods toQuery :: DescribeTransitGatewayAttachments -> QueryString #
AWSPager DescribeTransitGatewayAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments Methods page :: DescribeTransitGatewayAttachments -> AWSResponse DescribeTransitGatewayAttachments -> Maybe DescribeTransitGatewayAttachments #
AWSRequest DescribeTransitGatewayAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments Associated Types type AWSResponse DescribeTransitGatewayAttachments # Methods request :: (Service -> Service) -> DescribeTransitGatewayAttachments -> Request DescribeTransitGatewayAttachments # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeTransitGatewayAttachments -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeTransitGatewayAttachments))) #
Generic DescribeTransitGatewayAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments Associated Types type Rep DescribeTransitGatewayAttachments :: Type -> Type # Methods from :: DescribeTransitGatewayAttachments -> Rep DescribeTransitGatewayAttachments x # to :: Rep DescribeTransitGatewayAttachments x -> DescribeTransitGatewayAttachments #
Read DescribeTransitGatewayAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments Methods readsPrec :: Int -> ReadS DescribeTransitGatewayAttachments # readList :: ReadS [DescribeTransitGatewayAttachments] # readPrec :: ReadPrec DescribeTransitGatewayAttachments # readListPrec :: ReadPrec [DescribeTransitGatewayAttachments] #
Show DescribeTransitGatewayAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments Methods showsPrec :: Int -> DescribeTransitGatewayAttachments -> ShowS # show :: DescribeTransitGatewayAttachments -> String # showList :: [DescribeTransitGatewayAttachments] -> ShowS #
NFData DescribeTransitGatewayAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments Methods rnf :: DescribeTransitGatewayAttachments -> () #
Eq DescribeTransitGatewayAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments Methods (==) :: DescribeTransitGatewayAttachments -> DescribeTransitGatewayAttachments -> Bool # (/=) :: DescribeTransitGatewayAttachments -> DescribeTransitGatewayAttachments -> Bool #
Hashable DescribeTransitGatewayAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments Methods hashWithSalt :: Int -> DescribeTransitGatewayAttachments -> Int # hash :: DescribeTransitGatewayAttachments -> Int #
type AWSResponse DescribeTransitGatewayAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments type AWSResponse DescribeTransitGatewayAttachments = DescribeTransitGatewayAttachmentsResponse
type Rep DescribeTransitGatewayAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments type Rep DescribeTransitGatewayAttachments = D1 ('MetaData "DescribeTransitGatewayAttachments" "Amazonka.EC2.DescribeTransitGatewayAttachments" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeTransitGatewayAttachments'" '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]))))))

newDescribeTransitGatewayAttachments :: DescribeTransitGatewayAttachments Source #

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

association.state - The state of the association (associating | associated | disassociating).
association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.
resource-id - The ID of the resource.
resource-owner-id - The ID of the Amazon Web Services account that owns the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
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.
transit-gateway-owner-id - The ID of the Amazon Web Services account that owns the transit gateway.

$sel:maxResults:DescribeTransitGatewayAttachments', describeTransitGatewayAttachments_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.

DescribeTransitGatewayAttachments, describeTransitGatewayAttachments_nextToken - The token for the next page of results.

$sel:transitGatewayAttachmentIds:DescribeTransitGatewayAttachments', describeTransitGatewayAttachments_transitGatewayAttachmentIds - The IDs of the attachments.

Request Lenses

describeTransitGatewayAttachments_dryRun :: Lens' DescribeTransitGatewayAttachments (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.

describeTransitGatewayAttachments_filters :: Lens' DescribeTransitGatewayAttachments (Maybe [Filter]) Source #

One or more filters. The possible values are:

association.state - The state of the association (associating | associated | disassociating).
association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.
resource-id - The ID of the resource.
resource-owner-id - The ID of the Amazon Web Services account that owns the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
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.
transit-gateway-owner-id - The ID of the Amazon Web Services account that owns the transit gateway.

describeTransitGatewayAttachments_maxResults :: Lens' DescribeTransitGatewayAttachments (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.

describeTransitGatewayAttachments_nextToken :: Lens' DescribeTransitGatewayAttachments (Maybe Text) Source #

The token for the next page of results.

describeTransitGatewayAttachments_transitGatewayAttachmentIds :: Lens' DescribeTransitGatewayAttachments (Maybe [Text]) Source #

The IDs of the attachments.

Destructuring the Response

data DescribeTransitGatewayAttachmentsResponse Source #

See: newDescribeTransitGatewayAttachmentsResponse smart constructor.

Constructors

DescribeTransitGatewayAttachmentsResponse'
Fields nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. transitGatewayAttachments :: Maybe [TransitGatewayAttachment] Information about the attachments. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeTransitGatewayAttachmentsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments Associated Types type Rep DescribeTransitGatewayAttachmentsResponse :: Type -> Type # Methods from :: DescribeTransitGatewayAttachmentsResponse -> Rep DescribeTransitGatewayAttachmentsResponse x # to :: Rep DescribeTransitGatewayAttachmentsResponse x -> DescribeTransitGatewayAttachmentsResponse #
Read DescribeTransitGatewayAttachmentsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments Methods readsPrec :: Int -> ReadS DescribeTransitGatewayAttachmentsResponse # readList :: ReadS [DescribeTransitGatewayAttachmentsResponse] # readPrec :: ReadPrec DescribeTransitGatewayAttachmentsResponse # readListPrec :: ReadPrec [DescribeTransitGatewayAttachmentsResponse] #
Show DescribeTransitGatewayAttachmentsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments Methods showsPrec :: Int -> DescribeTransitGatewayAttachmentsResponse -> ShowS # show :: DescribeTransitGatewayAttachmentsResponse -> String # showList :: [DescribeTransitGatewayAttachmentsResponse] -> ShowS #
NFData DescribeTransitGatewayAttachmentsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments Methods rnf :: DescribeTransitGatewayAttachmentsResponse -> () #
Eq DescribeTransitGatewayAttachmentsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments Methods (==) :: DescribeTransitGatewayAttachmentsResponse -> DescribeTransitGatewayAttachmentsResponse -> Bool # (/=) :: DescribeTransitGatewayAttachmentsResponse -> DescribeTransitGatewayAttachmentsResponse -> Bool #
type Rep DescribeTransitGatewayAttachmentsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayAttachments type Rep DescribeTransitGatewayAttachmentsResponse = D1 ('MetaData "DescribeTransitGatewayAttachmentsResponse" "Amazonka.EC2.DescribeTransitGatewayAttachments" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeTransitGatewayAttachmentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "transitGatewayAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TransitGatewayAttachment])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeTransitGatewayAttachmentsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeTransitGatewayAttachmentsResponse'`
-> DescribeTransitGatewayAttachmentsResponse

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

DescribeTransitGatewayAttachments, describeTransitGatewayAttachmentsResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeTransitGatewayAttachmentsResponse, describeTransitGatewayAttachmentsResponse_transitGatewayAttachments - Information about the attachments.

$sel:httpStatus:DescribeTransitGatewayAttachmentsResponse', describeTransitGatewayAttachmentsResponse_httpStatus - The response's http status code.

Response Lenses

describeTransitGatewayAttachmentsResponse_nextToken :: Lens' DescribeTransitGatewayAttachmentsResponse (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.

describeTransitGatewayAttachmentsResponse_transitGatewayAttachments :: Lens' DescribeTransitGatewayAttachmentsResponse (Maybe [TransitGatewayAttachment]) Source #

Information about the attachments.

describeTransitGatewayAttachmentsResponse_httpStatus :: Lens' DescribeTransitGatewayAttachmentsResponse Int Source #

The response's http status code.