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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropriate Get* action. For example, to list the transit gateways in your global network, use GetTransitGatewayRegistrations.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeGlobalNetworks Source #

See: newDescribeGlobalNetworks smart constructor.

Constructors

DescribeGlobalNetworks'
Fields globalNetworkIds :: Maybe [Text] The IDs of one or more global networks. The maximum is 10. 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 DescribeGlobalNetworks Source #
Instance details Defined in Amazonka.NetworkManager.DescribeGlobalNetworks Methods toHeaders :: DescribeGlobalNetworks -> [Header] #
ToPath DescribeGlobalNetworks Source #
Instance details Defined in Amazonka.NetworkManager.DescribeGlobalNetworks Methods toPath :: DescribeGlobalNetworks -> ByteString #
ToQuery DescribeGlobalNetworks Source #
Instance details Defined in Amazonka.NetworkManager.DescribeGlobalNetworks Methods toQuery :: DescribeGlobalNetworks -> QueryString #
AWSPager DescribeGlobalNetworks Source #
Instance details Defined in Amazonka.NetworkManager.DescribeGlobalNetworks Methods page :: DescribeGlobalNetworks -> AWSResponse DescribeGlobalNetworks -> Maybe DescribeGlobalNetworks #
AWSRequest DescribeGlobalNetworks Source #
Instance details Defined in Amazonka.NetworkManager.DescribeGlobalNetworks Associated Types type AWSResponse DescribeGlobalNetworks # Methods request :: (Service -> Service) -> DescribeGlobalNetworks -> Request DescribeGlobalNetworks # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeGlobalNetworks -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeGlobalNetworks))) #
Generic DescribeGlobalNetworks Source #
Instance details Defined in Amazonka.NetworkManager.DescribeGlobalNetworks Associated Types type Rep DescribeGlobalNetworks :: Type -> Type # Methods from :: DescribeGlobalNetworks -> Rep DescribeGlobalNetworks x # to :: Rep DescribeGlobalNetworks x -> DescribeGlobalNetworks #
Read DescribeGlobalNetworks Source #
Instance details Defined in Amazonka.NetworkManager.DescribeGlobalNetworks Methods readsPrec :: Int -> ReadS DescribeGlobalNetworks # readList :: ReadS [DescribeGlobalNetworks] # readPrec :: ReadPrec DescribeGlobalNetworks # readListPrec :: ReadPrec [DescribeGlobalNetworks] #
Show DescribeGlobalNetworks Source #
Instance details Defined in Amazonka.NetworkManager.DescribeGlobalNetworks Methods showsPrec :: Int -> DescribeGlobalNetworks -> ShowS # show :: DescribeGlobalNetworks -> String # showList :: [DescribeGlobalNetworks] -> ShowS #
NFData DescribeGlobalNetworks Source #
Instance details Defined in Amazonka.NetworkManager.DescribeGlobalNetworks Methods rnf :: DescribeGlobalNetworks -> () #
Eq DescribeGlobalNetworks Source #
Instance details Defined in Amazonka.NetworkManager.DescribeGlobalNetworks Methods (==) :: DescribeGlobalNetworks -> DescribeGlobalNetworks -> Bool # (/=) :: DescribeGlobalNetworks -> DescribeGlobalNetworks -> Bool #
Hashable DescribeGlobalNetworks Source #
Instance details Defined in Amazonka.NetworkManager.DescribeGlobalNetworks Methods hashWithSalt :: Int -> DescribeGlobalNetworks -> Int # hash :: DescribeGlobalNetworks -> Int #
type AWSResponse DescribeGlobalNetworks Source #
Instance details Defined in Amazonka.NetworkManager.DescribeGlobalNetworks type AWSResponse DescribeGlobalNetworks = DescribeGlobalNetworksResponse
type Rep DescribeGlobalNetworks Source #
Instance details Defined in Amazonka.NetworkManager.DescribeGlobalNetworks type Rep DescribeGlobalNetworks = D1 ('MetaData "DescribeGlobalNetworks" "Amazonka.NetworkManager.DescribeGlobalNetworks" "amazonka-networkmanager-2.0-4HNcDlBc00x67cUJWWz3sw" 'False) (C1 ('MetaCons "DescribeGlobalNetworks'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalNetworkIds") '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)))))

newDescribeGlobalNetworks :: DescribeGlobalNetworks Source #

Create a value of DescribeGlobalNetworks 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:globalNetworkIds:DescribeGlobalNetworks', describeGlobalNetworks_globalNetworkIds - The IDs of one or more global networks. The maximum is 10.

$sel:maxResults:DescribeGlobalNetworks', describeGlobalNetworks_maxResults - The maximum number of results to return.

DescribeGlobalNetworks, describeGlobalNetworks_nextToken - The token for the next page of results.

Request Lenses

describeGlobalNetworks_globalNetworkIds :: Lens' DescribeGlobalNetworks (Maybe [Text]) Source #

The IDs of one or more global networks. The maximum is 10.

describeGlobalNetworks_maxResults :: Lens' DescribeGlobalNetworks (Maybe Natural) Source #

The maximum number of results to return.

describeGlobalNetworks_nextToken :: Lens' DescribeGlobalNetworks (Maybe Text) Source #

The token for the next page of results.

Destructuring the Response

data DescribeGlobalNetworksResponse Source #

See: newDescribeGlobalNetworksResponse smart constructor.

Constructors

DescribeGlobalNetworksResponse'
Fields globalNetworks :: Maybe [GlobalNetwork] Information about the global networks. nextToken :: Maybe Text The token for the next page of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeGlobalNetworksResponse Source #

Arguments

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

Create a value of DescribeGlobalNetworksResponse 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:globalNetworks:DescribeGlobalNetworksResponse', describeGlobalNetworksResponse_globalNetworks - Information about the global networks.

DescribeGlobalNetworks, describeGlobalNetworksResponse_nextToken - The token for the next page of results.

$sel:httpStatus:DescribeGlobalNetworksResponse', describeGlobalNetworksResponse_httpStatus - The response's http status code.

Response Lenses

describeGlobalNetworksResponse_globalNetworks :: Lens' DescribeGlobalNetworksResponse (Maybe [GlobalNetwork]) Source #

Information about the global networks.

describeGlobalNetworksResponse_nextToken :: Lens' DescribeGlobalNetworksResponse (Maybe Text) Source #

The token for the next page of results.

describeGlobalNetworksResponse_httpStatus :: Lens' DescribeGlobalNetworksResponse Int Source #

The response's http status code.