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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the network resources for the specified global network.

The results include information from the corresponding Describe call for the resource, minus any sensitive information such as pre-shared keys.

This operation returns paginated results.

Synopsis

data GetNetworkResources = GetNetworkResources' {
- accountId :: Maybe Text
- awsRegion :: Maybe Text
- coreNetworkId :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- registeredGatewayArn :: Maybe Text
- resourceArn :: Maybe Text
- resourceType :: Maybe Text
- globalNetworkId :: Text
}
newGetNetworkResources :: Text -> GetNetworkResources
getNetworkResources_accountId :: Lens' GetNetworkResources (Maybe Text)
getNetworkResources_awsRegion :: Lens' GetNetworkResources (Maybe Text)
getNetworkResources_coreNetworkId :: Lens' GetNetworkResources (Maybe Text)
getNetworkResources_maxResults :: Lens' GetNetworkResources (Maybe Natural)
getNetworkResources_nextToken :: Lens' GetNetworkResources (Maybe Text)
getNetworkResources_registeredGatewayArn :: Lens' GetNetworkResources (Maybe Text)
getNetworkResources_resourceArn :: Lens' GetNetworkResources (Maybe Text)
getNetworkResources_resourceType :: Lens' GetNetworkResources (Maybe Text)
getNetworkResources_globalNetworkId :: Lens' GetNetworkResources Text
data GetNetworkResourcesResponse = GetNetworkResourcesResponse' {
- networkResources :: Maybe [NetworkResource]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetNetworkResourcesResponse :: Int -> GetNetworkResourcesResponse
getNetworkResourcesResponse_networkResources :: Lens' GetNetworkResourcesResponse (Maybe [NetworkResource])
getNetworkResourcesResponse_nextToken :: Lens' GetNetworkResourcesResponse (Maybe Text)
getNetworkResourcesResponse_httpStatus :: Lens' GetNetworkResourcesResponse Int

Creating a Request

data GetNetworkResources Source #

See: newGetNetworkResources smart constructor.

Constructors

GetNetworkResources'

Fields

accountId :: Maybe Text
The Amazon Web Services account ID.
awsRegion :: Maybe Text
The Amazon Web Services Region.
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.
registeredGatewayArn :: Maybe Text
The ARN of the gateway.
resourceArn :: Maybe Text
The ARN of the resource.
resourceType :: Maybe Text
The resource type.
The following are the supported resource types for Direct Connect:
- dxcon - The definition model is Connection.
- dx-gateway - The definition model is DirectConnectGateway.
- dx-vif - The definition model is VirtualInterface.
The following are the supported resource types for Network Manager:
- connection - The definition model is Connection.
- device - The definition model is Device.
- link - The definition model is Link.
- site - The definition model is Site.
The following are the supported resource types for Amazon VPC:
- customer-gateway - The definition model is CustomerGateway.
- transit-gateway - The definition model is TransitGateway.
- transit-gateway-attachment - The definition model is TransitGatewayAttachment.
- transit-gateway-connect-peer - The definition model is TransitGatewayConnectPeer.
- transit-gateway-route-table - The definition model is TransitGatewayRouteTable.
- vpn-connection - The definition model is VpnConnection.
globalNetworkId :: Text
The ID of the global network.

Instances

Instances details

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

newGetNetworkResources Source #

Arguments

:: Text	`GetNetworkResources`
-> GetNetworkResources

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

GetNetworkResources, getNetworkResources_accountId - The Amazon Web Services account ID.

GetNetworkResources, getNetworkResources_awsRegion - The Amazon Web Services Region.

GetNetworkResources, getNetworkResources_coreNetworkId - The ID of a core network.

$sel:maxResults:GetNetworkResources', getNetworkResources_maxResults - The maximum number of results to return.

GetNetworkResources, getNetworkResources_nextToken - The token for the next page of results.

GetNetworkResources, getNetworkResources_registeredGatewayArn - The ARN of the gateway.

GetNetworkResources, getNetworkResources_resourceArn - The ARN of the resource.

GetNetworkResources, getNetworkResources_resourceType - The resource type.

The following are the supported resource types for Direct Connect:

dxcon - The definition model is Connection.
dx-gateway - The definition model is DirectConnectGateway.
dx-vif - The definition model is VirtualInterface.

The following are the supported resource types for Network Manager:

connection - The definition model is Connection.
device - The definition model is Device.
link - The definition model is Link.
site - The definition model is Site.

The following are the supported resource types for Amazon VPC:

customer-gateway - The definition model is CustomerGateway.
transit-gateway - The definition model is TransitGateway.
transit-gateway-attachment - The definition model is TransitGatewayAttachment.
transit-gateway-connect-peer - The definition model is TransitGatewayConnectPeer.
transit-gateway-route-table - The definition model is TransitGatewayRouteTable.
vpn-connection - The definition model is VpnConnection.

GetNetworkResources, getNetworkResources_globalNetworkId - The ID of the global network.

Request Lenses

getNetworkResources_accountId :: Lens' GetNetworkResources (Maybe Text) Source #

The Amazon Web Services account ID.

getNetworkResources_awsRegion :: Lens' GetNetworkResources (Maybe Text) Source #

The Amazon Web Services Region.

getNetworkResources_coreNetworkId :: Lens' GetNetworkResources (Maybe Text) Source #

The ID of a core network.

getNetworkResources_maxResults :: Lens' GetNetworkResources (Maybe Natural) Source #

The maximum number of results to return.

getNetworkResources_nextToken :: Lens' GetNetworkResources (Maybe Text) Source #

The token for the next page of results.

getNetworkResources_registeredGatewayArn :: Lens' GetNetworkResources (Maybe Text) Source #

The ARN of the gateway.

getNetworkResources_resourceArn :: Lens' GetNetworkResources (Maybe Text) Source #

The ARN of the resource.

getNetworkResources_resourceType :: Lens' GetNetworkResources (Maybe Text) Source #

The resource type.

The following are the supported resource types for Direct Connect:

dxcon - The definition model is Connection.
dx-gateway - The definition model is DirectConnectGateway.
dx-vif - The definition model is VirtualInterface.

The following are the supported resource types for Network Manager:

connection - The definition model is Connection.
device - The definition model is Device.
link - The definition model is Link.
site - The definition model is Site.

The following are the supported resource types for Amazon VPC:

customer-gateway - The definition model is CustomerGateway.
transit-gateway - The definition model is TransitGateway.
transit-gateway-attachment - The definition model is TransitGatewayAttachment.
transit-gateway-connect-peer - The definition model is TransitGatewayConnectPeer.
transit-gateway-route-table - The definition model is TransitGatewayRouteTable.
vpn-connection - The definition model is VpnConnection.

getNetworkResources_globalNetworkId :: Lens' GetNetworkResources Text Source #

The ID of the global network.

Destructuring the Response

data GetNetworkResourcesResponse Source #

See: newGetNetworkResourcesResponse smart constructor.

Constructors

GetNetworkResourcesResponse'
Fields networkResources :: Maybe [NetworkResource] The network resources. nextToken :: Maybe Text The token for the next page of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetNetworkResourcesResponse Source #

Arguments

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

Create a value of GetNetworkResourcesResponse 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:networkResources:GetNetworkResourcesResponse', getNetworkResourcesResponse_networkResources - The network resources.

GetNetworkResources, getNetworkResourcesResponse_nextToken - The token for the next page of results.

$sel:httpStatus:GetNetworkResourcesResponse', getNetworkResourcesResponse_httpStatus - The response's http status code.

Response Lenses

getNetworkResourcesResponse_networkResources :: Lens' GetNetworkResourcesResponse (Maybe [NetworkResource]) Source #

The network resources.

getNetworkResourcesResponse_nextToken :: Lens' GetNetworkResourcesResponse (Maybe Text) Source #

The token for the next page of results.

getNetworkResourcesResponse_httpStatus :: Lens' GetNetworkResourcesResponse Int Source #

The response's http status code.