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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the network resource relationships for the specified global network.

This operation returns paginated results.

Synopsis

Creating a Request

data GetNetworkResourceRelationships Source #

See: newGetNetworkResourceRelationships smart constructor.

Constructors

GetNetworkResourceRelationships'

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 registered gateway.
resourceArn :: Maybe Text
The ARN of the gateway.
resourceType :: Maybe Text
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
```
globalNetworkId :: Text
The ID of the global network.

Instances

Instances details

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

newGetNetworkResourceRelationships Source #

Arguments

:: Text	`GetNetworkResourceRelationships`
-> GetNetworkResourceRelationships

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.

Constructors

GetNetworkResourceRelationshipsResponse'
Fields nextToken :: Maybe Text The token for the next page of results. relationships :: Maybe [Relationship] The resource relationships. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetNetworkResourceRelationshipsResponse Source #

Arguments

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

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.