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 |
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' {}
- 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' {}
- 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.
GetNetworkResources' | |
|
Instances
newGetNetworkResources Source #
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.
GetNetworkResourcesResponse' | |
|
Instances
newGetNetworkResourcesResponse Source #
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.