NetworkManager / Client / get_network_resource_relationships

get_network_resource_relationships#

NetworkManager.Client.get_network_resource_relationships(**kwargs)#

Gets the network resource relationships for the specified global network.

See also: AWS API Documentation

Request Syntax

response = client.get_network_resource_relationships(
    GlobalNetworkId='string',
    CoreNetworkId='string',
    RegisteredGatewayArn='string',
    AwsRegion='string',
    AccountId='string',
    ResourceType='string',
    ResourceArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • GlobalNetworkId (string) –

    [REQUIRED]

    The ID of the global network.

  • CoreNetworkId (string) – The ID of a core network.

  • RegisteredGatewayArn (string) – The ARN of the registered gateway.

  • AwsRegion (string) – The Amazon Web Services Region.

  • AccountId (string) – The Amazon Web Services account ID.

  • ResourceType (string) –

    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

  • ResourceArn (string) – The ARN of the gateway.

  • MaxResults (integer) – The maximum number of results to return.

  • NextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'Relationships': [
        {
            'From': 'string',
            'To': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Relationships (list) –

      The resource relationships.

      • (dict) –

        Describes a resource relationship.

        • From (string) –

          The ARN of the resource.

        • To (string) –

          The ARN of the resource.

    • NextToken (string) –

      The token for the next page of results.

Exceptions

  • NetworkManager.Client.exceptions.ValidationException

  • NetworkManager.Client.exceptions.AccessDeniedException

  • NetworkManager.Client.exceptions.ResourceNotFoundException

  • NetworkManager.Client.exceptions.ThrottlingException

  • NetworkManager.Client.exceptions.InternalServerException