NetworkManager / Client / get_network_resources

get_network_resources

NetworkManager.Client.get_network_resources(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_network_resources(
    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 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 - 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.

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

• 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

{
    'NetworkResources': [
        {
            'RegisteredGatewayArn': 'string',
            'CoreNetworkId': 'string',
            'AwsRegion': 'string',
            'AccountId': 'string',
            'ResourceType': 'string',
            'ResourceId': 'string',
            'ResourceArn': 'string',
            'Definition': 'string',
            'DefinitionTimestamp': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Metadata': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • NetworkResources (list) –

    The network resources.

    • (dict) –

      Describes a network resource.

      • RegisteredGatewayArn (string) –

        The ARN of the gateway.

      • CoreNetworkId (string) –

        The ID of a core network.

      • 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

      • ResourceId (string) –

        The ID of the resource.

      • ResourceArn (string) –

        The ARN of the resource.

      • Definition (string) –

        Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

      • DefinitionTimestamp (datetime) –

        The time that the resource definition was retrieved.

      • Tags (list) –

        The tags.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value (string) –

            The tag value.

            Constraints: Maximum length of 256 characters.

      • Metadata (dict) –

        The resource metadata.

        • (string) –

          • (string) –

  • 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