:doc:`CloudWatchNetworkMonitor <../../networkmonitor>` / Client / get_probe

*********
get_probe
*********



.. py:method:: CloudWatchNetworkMonitor.Client.get_probe(**kwargs)

  

  Returns the details about a probe. This action requires both the ``monitorName`` and ``probeId`` parameters. Run ``ListMonitors`` to get a list of monitor names. Run ``GetMonitor`` to get a list of probes and probe IDs.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/GetProbe>`_  


  **Request Syntax**
  ::

    response = client.get_probe(
        monitorName='string',
        probeId='string'
    )
    
  :type monitorName: string
  :param monitorName: **[REQUIRED]** 

    The name of the monitor associated with the probe. Run ``ListMonitors`` to get a list of monitor names.

    

  
  :type probeId: string
  :param probeId: **[REQUIRED]** 

    The ID of the probe to get information about. Run ``GetMonitor`` action to get a list of probes and probe IDs for the monitor.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'probeId': 'string',
          'probeArn': 'string',
          'sourceArn': 'string',
          'destination': 'string',
          'destinationPort': 123,
          'protocol': 'TCP'|'ICMP',
          'packetSize': 123,
          'addressFamily': 'IPV4'|'IPV6',
          'vpcId': 'string',
          'state': 'PENDING'|'ACTIVE'|'INACTIVE'|'ERROR'|'DELETING'|'DELETED',
          'createdAt': datetime(2015, 1, 1),
          'modifiedAt': datetime(2015, 1, 1),
          'tags': {
              'string': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **probeId** *(string) --* 

        The ID of the probe for which details are returned.

        
      

      - **probeArn** *(string) --* 

        The ARN of the probe.

        
      

      - **sourceArn** *(string) --* 

        The ARN of the probe.

        
      

      - **destination** *(string) --* 

        The destination IP address for the monitor. This must be either an IPv4 or IPv6 address.

        
      

      - **destinationPort** *(integer) --* 

        The port associated with the ``destination``. This is required only if the ``protocol`` is ``TCP`` and must be a number between ``1`` and ``65536``.

        
      

      - **protocol** *(string) --* 

        The protocol used for the network traffic between the ``source`` and ``destination``. This must be either ``TCP`` or ``ICMP``.

        
      

      - **packetSize** *(integer) --* 

        The size of the packets sent between the source and destination. This must be a number between ``56`` and ``8500``.

        
      

      - **addressFamily** *(string) --* 

        Indicates whether the IP address is ``IPV4`` or ``IPV6``.

        
      

      - **vpcId** *(string) --* 

        The ID of the source VPC or subnet.

        
      

      - **state** *(string) --* 

        The state of the probe.

        
      

      - **createdAt** *(datetime) --* 

        The time and date that the probe was created.

        
      

      - **modifiedAt** *(datetime) --* 

        The time and date that the probe was last modified.

        
      

      - **tags** *(dict) --* 

        The list of key-value pairs assigned to the probe.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
  
  **Exceptions**
  
  *   :py:class:`CloudWatchNetworkMonitor.Client.exceptions.AccessDeniedException`

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

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

  
  *   :py:class:`CloudWatchNetworkMonitor.Client.exceptions.ValidationException`

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

  