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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes one or more Connect attachments.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeTransitGatewayConnects Source #

See: newDescribeTransitGatewayConnects smart constructor.

Constructors

DescribeTransitGatewayConnects'

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:
- options.protocol - The tunnel protocol (gre).
- state - The state of the attachment (initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing).
- transit-gateway-attachment-id - The ID of the Connect attachment.
- transit-gateway-id - The ID of the transit gateway.
- transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.
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 DescribeTransitGatewayConnects Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayConnects Methods toHeaders :: DescribeTransitGatewayConnects -> [Header] #
ToPath DescribeTransitGatewayConnects Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayConnects Methods toPath :: DescribeTransitGatewayConnects -> ByteString #
ToQuery DescribeTransitGatewayConnects Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayConnects Methods toQuery :: DescribeTransitGatewayConnects -> QueryString #
AWSPager DescribeTransitGatewayConnects Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayConnects Methods page :: DescribeTransitGatewayConnects -> AWSResponse DescribeTransitGatewayConnects -> Maybe DescribeTransitGatewayConnects #
AWSRequest DescribeTransitGatewayConnects Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayConnects Associated Types type AWSResponse DescribeTransitGatewayConnects # Methods request :: (Service -> Service) -> DescribeTransitGatewayConnects -> Request DescribeTransitGatewayConnects # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeTransitGatewayConnects -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeTransitGatewayConnects))) #
Generic DescribeTransitGatewayConnects Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayConnects Associated Types type Rep DescribeTransitGatewayConnects :: Type -> Type # Methods from :: DescribeTransitGatewayConnects -> Rep DescribeTransitGatewayConnects x # to :: Rep DescribeTransitGatewayConnects x -> DescribeTransitGatewayConnects #
Read DescribeTransitGatewayConnects Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayConnects Methods readsPrec :: Int -> ReadS DescribeTransitGatewayConnects # readList :: ReadS [DescribeTransitGatewayConnects] # readPrec :: ReadPrec DescribeTransitGatewayConnects # readListPrec :: ReadPrec [DescribeTransitGatewayConnects] #
Show DescribeTransitGatewayConnects Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayConnects Methods showsPrec :: Int -> DescribeTransitGatewayConnects -> ShowS # show :: DescribeTransitGatewayConnects -> String # showList :: [DescribeTransitGatewayConnects] -> ShowS #
NFData DescribeTransitGatewayConnects Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayConnects Methods rnf :: DescribeTransitGatewayConnects -> () #
Eq DescribeTransitGatewayConnects Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayConnects Methods (==) :: DescribeTransitGatewayConnects -> DescribeTransitGatewayConnects -> Bool # (/=) :: DescribeTransitGatewayConnects -> DescribeTransitGatewayConnects -> Bool #
Hashable DescribeTransitGatewayConnects Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayConnects Methods hashWithSalt :: Int -> DescribeTransitGatewayConnects -> Int # hash :: DescribeTransitGatewayConnects -> Int #
type AWSResponse DescribeTransitGatewayConnects Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayConnects type AWSResponse DescribeTransitGatewayConnects = DescribeTransitGatewayConnectsResponse
type Rep DescribeTransitGatewayConnects Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGatewayConnects type Rep DescribeTransitGatewayConnects = D1 ('MetaData "DescribeTransitGatewayConnects" "Amazonka.EC2.DescribeTransitGatewayConnects" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeTransitGatewayConnects'" '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]))))))

newDescribeTransitGatewayConnects :: DescribeTransitGatewayConnects Source #

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

options.protocol - The tunnel protocol (gre).
state - The state of the attachment (initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing).
transit-gateway-attachment-id - The ID of the Connect attachment.
transit-gateway-id - The ID of the transit gateway.
transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.

$sel:maxResults:DescribeTransitGatewayConnects', describeTransitGatewayConnects_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.

DescribeTransitGatewayConnects, describeTransitGatewayConnects_nextToken - The token for the next page of results.

$sel:transitGatewayAttachmentIds:DescribeTransitGatewayConnects', describeTransitGatewayConnects_transitGatewayAttachmentIds - The IDs of the attachments.

Request Lenses

describeTransitGatewayConnects_dryRun :: Lens' DescribeTransitGatewayConnects (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.

describeTransitGatewayConnects_filters :: Lens' DescribeTransitGatewayConnects (Maybe [Filter]) Source #

One or more filters. The possible values are:

options.protocol - The tunnel protocol (gre).
state - The state of the attachment (initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing).
transit-gateway-attachment-id - The ID of the Connect attachment.
transit-gateway-id - The ID of the transit gateway.
transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.

describeTransitGatewayConnects_maxResults :: Lens' DescribeTransitGatewayConnects (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.

describeTransitGatewayConnects_nextToken :: Lens' DescribeTransitGatewayConnects (Maybe Text) Source #

The token for the next page of results.

describeTransitGatewayConnects_transitGatewayAttachmentIds :: Lens' DescribeTransitGatewayConnects (Maybe [Text]) Source #

The IDs of the attachments.

Destructuring the Response

data DescribeTransitGatewayConnectsResponse Source #

See: newDescribeTransitGatewayConnectsResponse smart constructor.

Constructors

DescribeTransitGatewayConnectsResponse'
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. transitGatewayConnects :: Maybe [TransitGatewayConnect] Information about the Connect attachments. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeTransitGatewayConnectsResponse Source #

Arguments

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

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

DescribeTransitGatewayConnects, describeTransitGatewayConnectsResponse_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:transitGatewayConnects:DescribeTransitGatewayConnectsResponse', describeTransitGatewayConnectsResponse_transitGatewayConnects - Information about the Connect attachments.

$sel:httpStatus:DescribeTransitGatewayConnectsResponse', describeTransitGatewayConnectsResponse_httpStatus - The response's http status code.

Response Lenses

describeTransitGatewayConnectsResponse_nextToken :: Lens' DescribeTransitGatewayConnectsResponse (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.

describeTransitGatewayConnectsResponse_transitGatewayConnects :: Lens' DescribeTransitGatewayConnectsResponse (Maybe [TransitGatewayConnect]) Source #

Information about the Connect attachments.

describeTransitGatewayConnectsResponse_httpStatus :: Lens' DescribeTransitGatewayConnectsResponse Int Source #

The response's http status code.