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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the peerings for a core network.

This operation returns paginated results.

Synopsis

data ListPeerings = ListPeerings' {
- coreNetworkId :: Maybe Text
- edgeLocation :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- peeringType :: Maybe PeeringType
- state :: Maybe PeeringState
}
newListPeerings :: ListPeerings
listPeerings_coreNetworkId :: Lens' ListPeerings (Maybe Text)
listPeerings_edgeLocation :: Lens' ListPeerings (Maybe Text)
listPeerings_maxResults :: Lens' ListPeerings (Maybe Natural)
listPeerings_nextToken :: Lens' ListPeerings (Maybe Text)
listPeerings_peeringType :: Lens' ListPeerings (Maybe PeeringType)
listPeerings_state :: Lens' ListPeerings (Maybe PeeringState)
data ListPeeringsResponse = ListPeeringsResponse' {
- nextToken :: Maybe Text
- peerings :: Maybe [Peering]
- httpStatus :: Int
}
newListPeeringsResponse :: Int -> ListPeeringsResponse
listPeeringsResponse_nextToken :: Lens' ListPeeringsResponse (Maybe Text)
listPeeringsResponse_peerings :: Lens' ListPeeringsResponse (Maybe [Peering])
listPeeringsResponse_httpStatus :: Lens' ListPeeringsResponse Int

Creating a Request

data ListPeerings Source #

See: newListPeerings smart constructor.

Constructors

ListPeerings'

Fields

coreNetworkId :: Maybe Text
The ID of a core network.
edgeLocation :: Maybe Text
Returns a list edge locations for the
maxResults :: Maybe Natural
The maximum number of results to return.
nextToken :: Maybe Text
The token for the next page of results.
peeringType :: Maybe PeeringType
Returns a list of a peering requests.
state :: Maybe PeeringState
Returns a list of the peering request states.

Instances

Instances details

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

newListPeerings :: ListPeerings Source #

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

ListPeerings, listPeerings_coreNetworkId - The ID of a core network.

ListPeerings, listPeerings_edgeLocation - Returns a list edge locations for the

$sel:maxResults:ListPeerings', listPeerings_maxResults - The maximum number of results to return.

ListPeerings, listPeerings_nextToken - The token for the next page of results.

ListPeerings, listPeerings_peeringType - Returns a list of a peering requests.

ListPeerings, listPeerings_state - Returns a list of the peering request states.

Request Lenses

listPeerings_coreNetworkId :: Lens' ListPeerings (Maybe Text) Source #

The ID of a core network.

listPeerings_edgeLocation :: Lens' ListPeerings (Maybe Text) Source #

Returns a list edge locations for the

listPeerings_maxResults :: Lens' ListPeerings (Maybe Natural) Source #

The maximum number of results to return.

listPeerings_nextToken :: Lens' ListPeerings (Maybe Text) Source #

The token for the next page of results.

listPeerings_peeringType :: Lens' ListPeerings (Maybe PeeringType) Source #

Returns a list of a peering requests.

listPeerings_state :: Lens' ListPeerings (Maybe PeeringState) Source #

Returns a list of the peering request states.

Destructuring the Response

data ListPeeringsResponse Source #

See: newListPeeringsResponse smart constructor.

Constructors

ListPeeringsResponse'
Fields nextToken :: Maybe Text The token for the next page of results. peerings :: Maybe [Peering] Lists the transit gateway peerings for the `ListPeerings` request. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListPeeringsResponse Source #

Arguments

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

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

ListPeerings, listPeeringsResponse_nextToken - The token for the next page of results.

$sel:peerings:ListPeeringsResponse', listPeeringsResponse_peerings - Lists the transit gateway peerings for the ListPeerings request.

$sel:httpStatus:ListPeeringsResponse', listPeeringsResponse_httpStatus - The response's http status code.

Response Lenses

listPeeringsResponse_nextToken :: Lens' ListPeeringsResponse (Maybe Text) Source #

The token for the next page of results.

listPeeringsResponse_peerings :: Lens' ListPeeringsResponse (Maybe [Peering]) Source #

Lists the transit gateway peerings for the ListPeerings request.

listPeeringsResponse_httpStatus :: Lens' ListPeeringsResponse Int Source #

The response's http status code.