:doc:`NetworkManager <../../networkmanager>` / Client / get_network_telemetry

*********************
get_network_telemetry
*********************



.. py:method:: NetworkManager.Client.get_network_telemetry(**kwargs)

  

  Gets the network telemetry of the specified global network.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/networkmanager-2019-07-05/GetNetworkTelemetry>`_  


  **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'
    )
    
  :type GlobalNetworkId: string
  :param GlobalNetworkId: **[REQUIRED]** 

    The ID of the global network.

    

  
  :type CoreNetworkId: string
  :param CoreNetworkId: 

    The ID of a core network.

    

  
  :type RegisteredGatewayArn: string
  :param RegisteredGatewayArn: 

    The ARN of the gateway.

    

  
  :type AwsRegion: string
  :param AwsRegion: 

    The Amazon Web Services Region.

    

  
  :type AccountId: string
  :param AccountId: 

    The Amazon Web Services account ID.

    

  
  :type ResourceType: string
  :param ResourceType: 

    The resource type. The following are the supported resource types:

     

    
    * ``connect-peer``
     
    * ``transit-gateway-connect-peer``
     
    * ``vpn-connection``
    

    

  
  :type ResourceArn: string
  :param ResourceArn: 

    The ARN of the resource.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return.

    

  
  :type NextToken: string
  :param NextToken: 

    The token for the next page of results.

    

  
  
  :rtype: 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**
  
  *   :py:class:`NetworkManager.Client.exceptions.ValidationException`

  
  *   :py:class:`NetworkManager.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`NetworkManager.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`NetworkManager.Client.exceptions.ThrottlingException`

  
  *   :py:class:`NetworkManager.Client.exceptions.InternalServerException`

  