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.NetworkManager.ListConnectPeers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of core network Connect peers.

This operation returns paginated results.

Synopsis

data ListConnectPeers = ListConnectPeers' {
- connectAttachmentId :: Maybe Text
- coreNetworkId :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newListConnectPeers :: ListConnectPeers
listConnectPeers_connectAttachmentId :: Lens' ListConnectPeers (Maybe Text)
listConnectPeers_coreNetworkId :: Lens' ListConnectPeers (Maybe Text)
listConnectPeers_maxResults :: Lens' ListConnectPeers (Maybe Natural)
listConnectPeers_nextToken :: Lens' ListConnectPeers (Maybe Text)
data ListConnectPeersResponse = ListConnectPeersResponse' {
- connectPeers :: Maybe [ConnectPeerSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListConnectPeersResponse :: Int -> ListConnectPeersResponse
listConnectPeersResponse_connectPeers :: Lens' ListConnectPeersResponse (Maybe [ConnectPeerSummary])
listConnectPeersResponse_nextToken :: Lens' ListConnectPeersResponse (Maybe Text)
listConnectPeersResponse_httpStatus :: Lens' ListConnectPeersResponse Int

Creating a Request

data ListConnectPeers Source #

See: newListConnectPeers smart constructor.

Constructors

ListConnectPeers'
Fields connectAttachmentId :: Maybe Text The ID of the attachment. coreNetworkId :: Maybe Text The ID of a core network. maxResults :: Maybe Natural The maximum number of results to return. nextToken :: Maybe Text The token for the next page of results.

Instances

Instances details

ToHeaders ListConnectPeers Source #
Instance details Defined in Amazonka.NetworkManager.ListConnectPeers Methods toHeaders :: ListConnectPeers -> [Header] #
ToPath ListConnectPeers Source #
Instance details Defined in Amazonka.NetworkManager.ListConnectPeers Methods toPath :: ListConnectPeers -> ByteString #
ToQuery ListConnectPeers Source #
Instance details Defined in Amazonka.NetworkManager.ListConnectPeers Methods toQuery :: ListConnectPeers -> QueryString #
AWSPager ListConnectPeers Source #
Instance details Defined in Amazonka.NetworkManager.ListConnectPeers Methods page :: ListConnectPeers -> AWSResponse ListConnectPeers -> Maybe ListConnectPeers #
AWSRequest ListConnectPeers Source #
Instance details Defined in Amazonka.NetworkManager.ListConnectPeers Associated Types type AWSResponse ListConnectPeers # Methods request :: (Service -> Service) -> ListConnectPeers -> Request ListConnectPeers # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListConnectPeers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListConnectPeers))) #
Generic ListConnectPeers Source #
Instance details Defined in Amazonka.NetworkManager.ListConnectPeers Associated Types type Rep ListConnectPeers :: Type -> Type # Methods from :: ListConnectPeers -> Rep ListConnectPeers x # to :: Rep ListConnectPeers x -> ListConnectPeers #
Read ListConnectPeers Source #
Instance details Defined in Amazonka.NetworkManager.ListConnectPeers Methods readsPrec :: Int -> ReadS ListConnectPeers # readList :: ReadS [ListConnectPeers] # readPrec :: ReadPrec ListConnectPeers # readListPrec :: ReadPrec [ListConnectPeers] #
Show ListConnectPeers Source #
Instance details Defined in Amazonka.NetworkManager.ListConnectPeers Methods showsPrec :: Int -> ListConnectPeers -> ShowS # show :: ListConnectPeers -> String # showList :: [ListConnectPeers] -> ShowS #
NFData ListConnectPeers Source #
Instance details Defined in Amazonka.NetworkManager.ListConnectPeers Methods rnf :: ListConnectPeers -> () #
Eq ListConnectPeers Source #
Instance details Defined in Amazonka.NetworkManager.ListConnectPeers Methods (==) :: ListConnectPeers -> ListConnectPeers -> Bool # (/=) :: ListConnectPeers -> ListConnectPeers -> Bool #
Hashable ListConnectPeers Source #
Instance details Defined in Amazonka.NetworkManager.ListConnectPeers Methods hashWithSalt :: Int -> ListConnectPeers -> Int # hash :: ListConnectPeers -> Int #
type AWSResponse ListConnectPeers Source #
Instance details Defined in Amazonka.NetworkManager.ListConnectPeers type AWSResponse ListConnectPeers = ListConnectPeersResponse
type Rep ListConnectPeers Source #
Instance details Defined in Amazonka.NetworkManager.ListConnectPeers type Rep ListConnectPeers = D1 ('MetaData "ListConnectPeers" "Amazonka.NetworkManager.ListConnectPeers" "amazonka-networkmanager-2.0-4HNcDlBc00x67cUJWWz3sw" 'False) (C1 ('MetaCons "ListConnectPeers'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "connectAttachmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "coreNetworkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListConnectPeers :: ListConnectPeers Source #

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

ListConnectPeers, listConnectPeers_connectAttachmentId - The ID of the attachment.

ListConnectPeers, listConnectPeers_coreNetworkId - The ID of a core network.

$sel:maxResults:ListConnectPeers', listConnectPeers_maxResults - The maximum number of results to return.

ListConnectPeers, listConnectPeers_nextToken - The token for the next page of results.

Request Lenses

listConnectPeers_connectAttachmentId :: Lens' ListConnectPeers (Maybe Text) Source #

The ID of the attachment.

listConnectPeers_coreNetworkId :: Lens' ListConnectPeers (Maybe Text) Source #

The ID of a core network.

listConnectPeers_maxResults :: Lens' ListConnectPeers (Maybe Natural) Source #

The maximum number of results to return.

listConnectPeers_nextToken :: Lens' ListConnectPeers (Maybe Text) Source #

The token for the next page of results.

Destructuring the Response

data ListConnectPeersResponse Source #

See: newListConnectPeersResponse smart constructor.

Constructors

ListConnectPeersResponse'
Fields connectPeers :: Maybe [ConnectPeerSummary] Describes the Connect peers. nextToken :: Maybe Text The token for the next page of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListConnectPeersResponse Source #

Arguments

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

Create a value of ListConnectPeersResponse 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:connectPeers:ListConnectPeersResponse', listConnectPeersResponse_connectPeers - Describes the Connect peers.

ListConnectPeers, listConnectPeersResponse_nextToken - The token for the next page of results.

$sel:httpStatus:ListConnectPeersResponse', listConnectPeersResponse_httpStatus - The response's http status code.

Response Lenses

listConnectPeersResponse_connectPeers :: Lens' ListConnectPeersResponse (Maybe [ConnectPeerSummary]) Source #

Describes the Connect peers.

listConnectPeersResponse_nextToken :: Lens' ListConnectPeersResponse (Maybe Text) Source #

The token for the next page of results.

listConnectPeersResponse_httpStatus :: Lens' ListConnectPeersResponse Int Source #

The response's http status code.