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 |
Gets the network resource relationships for the specified global network.
This operation returns paginated results.
Synopsis
- data GetNetworkResourceRelationships = GetNetworkResourceRelationships' {}
- newGetNetworkResourceRelationships :: Text -> GetNetworkResourceRelationships
- getNetworkResourceRelationships_accountId :: Lens' GetNetworkResourceRelationships (Maybe Text)
- getNetworkResourceRelationships_awsRegion :: Lens' GetNetworkResourceRelationships (Maybe Text)
- getNetworkResourceRelationships_coreNetworkId :: Lens' GetNetworkResourceRelationships (Maybe Text)
- getNetworkResourceRelationships_maxResults :: Lens' GetNetworkResourceRelationships (Maybe Natural)
- getNetworkResourceRelationships_nextToken :: Lens' GetNetworkResourceRelationships (Maybe Text)
- getNetworkResourceRelationships_registeredGatewayArn :: Lens' GetNetworkResourceRelationships (Maybe Text)
- getNetworkResourceRelationships_resourceArn :: Lens' GetNetworkResourceRelationships (Maybe Text)
- getNetworkResourceRelationships_resourceType :: Lens' GetNetworkResourceRelationships (Maybe Text)
- getNetworkResourceRelationships_globalNetworkId :: Lens' GetNetworkResourceRelationships Text
- data GetNetworkResourceRelationshipsResponse = GetNetworkResourceRelationshipsResponse' {
- nextToken :: Maybe Text
- relationships :: Maybe [Relationship]
- httpStatus :: Int
- newGetNetworkResourceRelationshipsResponse :: Int -> GetNetworkResourceRelationshipsResponse
- getNetworkResourceRelationshipsResponse_nextToken :: Lens' GetNetworkResourceRelationshipsResponse (Maybe Text)
- getNetworkResourceRelationshipsResponse_relationships :: Lens' GetNetworkResourceRelationshipsResponse (Maybe [Relationship])
- getNetworkResourceRelationshipsResponse_httpStatus :: Lens' GetNetworkResourceRelationshipsResponse Int
Creating a Request
data GetNetworkResourceRelationships Source #
See: newGetNetworkResourceRelationships
smart constructor.
GetNetworkResourceRelationships' | |
|
Instances
newGetNetworkResourceRelationships Source #
Create a value of GetNetworkResourceRelationships
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:
GetNetworkResourceRelationships
, getNetworkResourceRelationships_accountId
- The Amazon Web Services account ID.
GetNetworkResourceRelationships
, getNetworkResourceRelationships_awsRegion
- The Amazon Web Services Region.
GetNetworkResourceRelationships
, getNetworkResourceRelationships_coreNetworkId
- The ID of a core network.
$sel:maxResults:GetNetworkResourceRelationships'
, getNetworkResourceRelationships_maxResults
- The maximum number of results to return.
GetNetworkResourceRelationships
, getNetworkResourceRelationships_nextToken
- The token for the next page of results.
GetNetworkResourceRelationships
, getNetworkResourceRelationships_registeredGatewayArn
- The ARN of the registered gateway.
GetNetworkResourceRelationships
, getNetworkResourceRelationships_resourceArn
- The ARN of the gateway.
GetNetworkResourceRelationships
, getNetworkResourceRelationships_resourceType
- The resource type.
The following are the supported resource types for Direct Connect:
dxcon
dx-gateway
dx-vif
The following are the supported resource types for Network Manager:
connection
device
link
site
The following are the supported resource types for Amazon VPC:
customer-gateway
transit-gateway
transit-gateway-attachment
transit-gateway-connect-peer
transit-gateway-route-table
vpn-connection
GetNetworkResourceRelationships
, getNetworkResourceRelationships_globalNetworkId
- The ID of the global network.
Request Lenses
getNetworkResourceRelationships_accountId :: Lens' GetNetworkResourceRelationships (Maybe Text) Source #
The Amazon Web Services account ID.
getNetworkResourceRelationships_awsRegion :: Lens' GetNetworkResourceRelationships (Maybe Text) Source #
The Amazon Web Services Region.
getNetworkResourceRelationships_coreNetworkId :: Lens' GetNetworkResourceRelationships (Maybe Text) Source #
The ID of a core network.
getNetworkResourceRelationships_maxResults :: Lens' GetNetworkResourceRelationships (Maybe Natural) Source #
The maximum number of results to return.
getNetworkResourceRelationships_nextToken :: Lens' GetNetworkResourceRelationships (Maybe Text) Source #
The token for the next page of results.
getNetworkResourceRelationships_registeredGatewayArn :: Lens' GetNetworkResourceRelationships (Maybe Text) Source #
The ARN of the registered gateway.
getNetworkResourceRelationships_resourceArn :: Lens' GetNetworkResourceRelationships (Maybe Text) Source #
The ARN of the gateway.
getNetworkResourceRelationships_resourceType :: Lens' GetNetworkResourceRelationships (Maybe Text) Source #
The resource type.
The following are the supported resource types for Direct Connect:
dxcon
dx-gateway
dx-vif
The following are the supported resource types for Network Manager:
connection
device
link
site
The following are the supported resource types for Amazon VPC:
customer-gateway
transit-gateway
transit-gateway-attachment
transit-gateway-connect-peer
transit-gateway-route-table
vpn-connection
getNetworkResourceRelationships_globalNetworkId :: Lens' GetNetworkResourceRelationships Text Source #
The ID of the global network.
Destructuring the Response
data GetNetworkResourceRelationshipsResponse Source #
See: newGetNetworkResourceRelationshipsResponse
smart constructor.
GetNetworkResourceRelationshipsResponse' | |
|
Instances
newGetNetworkResourceRelationshipsResponse Source #
Create a value of GetNetworkResourceRelationshipsResponse
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:
GetNetworkResourceRelationships
, getNetworkResourceRelationshipsResponse_nextToken
- The token for the next page of results.
$sel:relationships:GetNetworkResourceRelationshipsResponse'
, getNetworkResourceRelationshipsResponse_relationships
- The resource relationships.
$sel:httpStatus:GetNetworkResourceRelationshipsResponse'
, getNetworkResourceRelationshipsResponse_httpStatus
- The response's http status code.
Response Lenses
getNetworkResourceRelationshipsResponse_nextToken :: Lens' GetNetworkResourceRelationshipsResponse (Maybe Text) Source #
The token for the next page of results.
getNetworkResourceRelationshipsResponse_relationships :: Lens' GetNetworkResourceRelationshipsResponse (Maybe [Relationship]) Source #
The resource relationships.
getNetworkResourceRelationshipsResponse_httpStatus :: Lens' GetNetworkResourceRelationshipsResponse Int Source #
The response's http status code.