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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes one or more Connect peers.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeTransitGatewayConnectPeers Source #

See: newDescribeTransitGatewayConnectPeers smart constructor.

Constructors

DescribeTransitGatewayConnectPeers'

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 Connect peer (pending | available | deleting | deleted).
- transit-gateway-attachment-id - The ID of the attachment.
- transit-gateway-connect-peer-id - The ID of the Connect peer.
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.
transitGatewayConnectPeerIds :: Maybe [Text]
The IDs of the Connect peers.

Instances

Instances details

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

newDescribeTransitGatewayConnectPeers :: DescribeTransitGatewayConnectPeers Source #

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

state - The state of the Connect peer (pending | available | deleting | deleted).
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-connect-peer-id - The ID of the Connect peer.

$sel:maxResults:DescribeTransitGatewayConnectPeers', describeTransitGatewayConnectPeers_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.

DescribeTransitGatewayConnectPeers, describeTransitGatewayConnectPeers_nextToken - The token for the next page of results.

$sel:transitGatewayConnectPeerIds:DescribeTransitGatewayConnectPeers', describeTransitGatewayConnectPeers_transitGatewayConnectPeerIds - The IDs of the Connect peers.

Request Lenses

describeTransitGatewayConnectPeers_dryRun :: Lens' DescribeTransitGatewayConnectPeers (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.

describeTransitGatewayConnectPeers_filters :: Lens' DescribeTransitGatewayConnectPeers (Maybe [Filter]) Source #

One or more filters. The possible values are:

state - The state of the Connect peer (pending | available | deleting | deleted).
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-connect-peer-id - The ID of the Connect peer.

describeTransitGatewayConnectPeers_maxResults :: Lens' DescribeTransitGatewayConnectPeers (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.

describeTransitGatewayConnectPeers_nextToken :: Lens' DescribeTransitGatewayConnectPeers (Maybe Text) Source #

The token for the next page of results.

describeTransitGatewayConnectPeers_transitGatewayConnectPeerIds :: Lens' DescribeTransitGatewayConnectPeers (Maybe [Text]) Source #

The IDs of the Connect peers.

Destructuring the Response

data DescribeTransitGatewayConnectPeersResponse Source #

See: newDescribeTransitGatewayConnectPeersResponse smart constructor.

Constructors

DescribeTransitGatewayConnectPeersResponse'
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. transitGatewayConnectPeers :: Maybe [TransitGatewayConnectPeer] Information about the Connect peers. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeTransitGatewayConnectPeersResponse Source #

Arguments

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

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

DescribeTransitGatewayConnectPeers, describeTransitGatewayConnectPeersResponse_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:transitGatewayConnectPeers:DescribeTransitGatewayConnectPeersResponse', describeTransitGatewayConnectPeersResponse_transitGatewayConnectPeers - Information about the Connect peers.

$sel:httpStatus:DescribeTransitGatewayConnectPeersResponse', describeTransitGatewayConnectPeersResponse_httpStatus - The response's http status code.

Response Lenses

describeTransitGatewayConnectPeersResponse_nextToken :: Lens' DescribeTransitGatewayConnectPeersResponse (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.

describeTransitGatewayConnectPeersResponse_transitGatewayConnectPeers :: Lens' DescribeTransitGatewayConnectPeersResponse (Maybe [TransitGatewayConnectPeer]) Source #

Information about the Connect peers.

describeTransitGatewayConnectPeersResponse_httpStatus :: Lens' DescribeTransitGatewayConnectPeersResponse Int Source #

The response's http status code.