NetworkManager / Client / get_network_telemetry

get_network_telemetry#

NetworkManager.Client.get_network_telemetry(**kwargs)#

Gets the network telemetry of the specified global network.

Request Syntax

response = client.get_network_telemetry(
    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:
- connect-peer
- transit-gateway-connect-peer
- vpn-connection
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

{
    'NetworkTelemetry': [
        {
            'RegisteredGatewayArn': 'string',
            'CoreNetworkId': 'string',
            'AwsRegion': 'string',
            'AccountId': 'string',
            'ResourceType': 'string',
            'ResourceId': 'string',
            'ResourceArn': 'string',
            'Address': 'string',
            'Health': {
                'Type': 'BGP'|'IPSEC',
                'Status': 'UP'|'DOWN',
                'Timestamp': datetime(2015, 1, 1)
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- NetworkTelemetry (list) –
  
  The network telemetry.
  - (dict) –
    
    Describes the telemetry information for a 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.
    - ResourceId (string) –
      
      The ID of the resource.
    - ResourceArn (string) –
      
      The ARN of the resource.
    - Address (string) –
      
      The address.
    - Health (dict) –
      
      The connection health.
      - Type (string) –
        
        The connection type.
      - Status (string) –
        
        The connection status.
      - Timestamp (datetime) –
        
        The time the status was last updated.
- 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