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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes your transit gateway peering attachments.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeTransitGatewayPeeringAttachments Source #

See: newDescribeTransitGatewayPeeringAttachments smart constructor.

Constructors

DescribeTransitGatewayPeeringAttachments'

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:
- transit-gateway-attachment-id - The ID of the transit gateway attachment.
- local-owner-id - The ID of your Amazon Web Services account.
- remote-owner-id - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.
- state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
- 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 that have a tag with a specific key, regardless of the tag value.
- transit-gateway-id - The ID of 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]
One or more IDs of the transit gateway peering attachments.

Instances

Instances details

ToHeaders DescribeTransitGatewayPeeringAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayPeeringAttachments Methods toHeaders :: DescribeTransitGatewayPeeringAttachments -> [Header] #
ToPath DescribeTransitGatewayPeeringAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayPeeringAttachments Methods toPath :: DescribeTransitGatewayPeeringAttachments -> ByteString #
ToQuery DescribeTransitGatewayPeeringAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayPeeringAttachments Methods toQuery :: DescribeTransitGatewayPeeringAttachments -> QueryString #
AWSPager DescribeTransitGatewayPeeringAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayPeeringAttachments Methods page :: DescribeTransitGatewayPeeringAttachments -> AWSResponse DescribeTransitGatewayPeeringAttachments -> Maybe DescribeTransitGatewayPeeringAttachments #
AWSRequest DescribeTransitGatewayPeeringAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayPeeringAttachments Associated Types type AWSResponse DescribeTransitGatewayPeeringAttachments # Methods request :: (Service -> Service) -> DescribeTransitGatewayPeeringAttachments -> Request DescribeTransitGatewayPeeringAttachments # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeTransitGatewayPeeringAttachments -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeTransitGatewayPeeringAttachments))) #
Generic DescribeTransitGatewayPeeringAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayPeeringAttachments Associated Types type Rep DescribeTransitGatewayPeeringAttachments :: Type -> Type # Methods from :: DescribeTransitGatewayPeeringAttachments -> Rep DescribeTransitGatewayPeeringAttachments x # to :: Rep DescribeTransitGatewayPeeringAttachments x -> DescribeTransitGatewayPeeringAttachments #
Read DescribeTransitGatewayPeeringAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayPeeringAttachments Methods readsPrec :: Int -> ReadS DescribeTransitGatewayPeeringAttachments # readList :: ReadS [DescribeTransitGatewayPeeringAttachments] # readPrec :: ReadPrec DescribeTransitGatewayPeeringAttachments # readListPrec :: ReadPrec [DescribeTransitGatewayPeeringAttachments] #
Show DescribeTransitGatewayPeeringAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayPeeringAttachments Methods showsPrec :: Int -> DescribeTransitGatewayPeeringAttachments -> ShowS # show :: DescribeTransitGatewayPeeringAttachments -> String # showList :: [DescribeTransitGatewayPeeringAttachments] -> ShowS #
NFData DescribeTransitGatewayPeeringAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayPeeringAttachments Methods rnf :: DescribeTransitGatewayPeeringAttachments -> () #
Eq DescribeTransitGatewayPeeringAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayPeeringAttachments Methods (==) :: DescribeTransitGatewayPeeringAttachments -> DescribeTransitGatewayPeeringAttachments -> Bool # (/=) :: DescribeTransitGatewayPeeringAttachments -> DescribeTransitGatewayPeeringAttachments -> Bool #
Hashable DescribeTransitGatewayPeeringAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayPeeringAttachments Methods hashWithSalt :: Int -> DescribeTransitGatewayPeeringAttachments -> Int # hash :: DescribeTransitGatewayPeeringAttachments -> Int #
type AWSResponse DescribeTransitGatewayPeeringAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayPeeringAttachments type AWSResponse DescribeTransitGatewayPeeringAttachments = DescribeTransitGatewayPeeringAttachmentsResponse
type Rep DescribeTransitGatewayPeeringAttachments Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayPeeringAttachments type Rep DescribeTransitGatewayPeeringAttachments = D1 ('MetaData "DescribeTransitGatewayPeeringAttachments" "Amazonka.EC2.DescribeTransitGatewayPeeringAttachments" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeTransitGatewayPeeringAttachments'" '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]))))))

newDescribeTransitGatewayPeeringAttachments :: DescribeTransitGatewayPeeringAttachments Source #

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

transit-gateway-attachment-id - The ID of the transit gateway attachment.
local-owner-id - The ID of your Amazon Web Services account.
remote-owner-id - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.
state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
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 that have a tag with a specific key, regardless of the tag value.
transit-gateway-id - The ID of the transit gateway.

$sel:maxResults:DescribeTransitGatewayPeeringAttachments', describeTransitGatewayPeeringAttachments_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.

DescribeTransitGatewayPeeringAttachments, describeTransitGatewayPeeringAttachments_nextToken - The token for the next page of results.

$sel:transitGatewayAttachmentIds:DescribeTransitGatewayPeeringAttachments', describeTransitGatewayPeeringAttachments_transitGatewayAttachmentIds - One or more IDs of the transit gateway peering attachments.

Request Lenses

describeTransitGatewayPeeringAttachments_dryRun :: Lens' DescribeTransitGatewayPeeringAttachments (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.

describeTransitGatewayPeeringAttachments_filters :: Lens' DescribeTransitGatewayPeeringAttachments (Maybe [Filter]) Source #

One or more filters. The possible values are:

transit-gateway-attachment-id - The ID of the transit gateway attachment.
local-owner-id - The ID of your Amazon Web Services account.
remote-owner-id - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.
state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
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 that have a tag with a specific key, regardless of the tag value.
transit-gateway-id - The ID of the transit gateway.

describeTransitGatewayPeeringAttachments_maxResults :: Lens' DescribeTransitGatewayPeeringAttachments (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.

describeTransitGatewayPeeringAttachments_nextToken :: Lens' DescribeTransitGatewayPeeringAttachments (Maybe Text) Source #

The token for the next page of results.

describeTransitGatewayPeeringAttachments_transitGatewayAttachmentIds :: Lens' DescribeTransitGatewayPeeringAttachments (Maybe [Text]) Source #

One or more IDs of the transit gateway peering attachments.

Destructuring the Response

data DescribeTransitGatewayPeeringAttachmentsResponse Source #

See: newDescribeTransitGatewayPeeringAttachmentsResponse smart constructor.

Constructors

DescribeTransitGatewayPeeringAttachmentsResponse'
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. transitGatewayPeeringAttachments :: Maybe [TransitGatewayPeeringAttachment] The transit gateway peering attachments. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeTransitGatewayPeeringAttachmentsResponse Source #

Arguments

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

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

DescribeTransitGatewayPeeringAttachments, describeTransitGatewayPeeringAttachmentsResponse_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:transitGatewayPeeringAttachments:DescribeTransitGatewayPeeringAttachmentsResponse', describeTransitGatewayPeeringAttachmentsResponse_transitGatewayPeeringAttachments - The transit gateway peering attachments.

$sel:httpStatus:DescribeTransitGatewayPeeringAttachmentsResponse', describeTransitGatewayPeeringAttachmentsResponse_httpStatus - The response's http status code.

Response Lenses

describeTransitGatewayPeeringAttachmentsResponse_nextToken :: Lens' DescribeTransitGatewayPeeringAttachmentsResponse (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.

describeTransitGatewayPeeringAttachmentsResponse_transitGatewayPeeringAttachments :: Lens' DescribeTransitGatewayPeeringAttachmentsResponse (Maybe [TransitGatewayPeeringAttachment]) Source #

The transit gateway peering attachments.

describeTransitGatewayPeeringAttachmentsResponse_httpStatus :: Lens' DescribeTransitGatewayPeeringAttachmentsResponse Int Source #

The response's http status code.