:doc:`NetworkFlowMonitor <../../networkflowmonitor>` / Client / get_monitor

***********
get_monitor
***********



.. py:method:: NetworkFlowMonitor.Client.get_monitor(**kwargs)

  

  Gets information about a monitor in Network Flow Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time, modified time, resources included in the monitor, and status information.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetMonitor>`_  


  **Request Syntax**
  ::

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

    The name of the monitor.

    

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

    
    ::

      {
          'monitorArn': 'string',
          'monitorName': 'string',
          'monitorStatus': 'PENDING'|'ACTIVE'|'INACTIVE'|'ERROR'|'DELETING',
          'localResources': [
              {
                  'type': 'AWS::EC2::VPC'|'AWS::AvailabilityZone'|'AWS::EC2::Subnet'|'AWS::Region'|'AWS::EKS::Cluster',
                  'identifier': 'string'
              },
          ],
          'remoteResources': [
              {
                  'type': 'AWS::EC2::VPC'|'AWS::AvailabilityZone'|'AWS::EC2::Subnet'|'AWS::AWSService'|'AWS::Region',
                  'identifier': 'string'
              },
          ],
          'createdAt': datetime(2015, 1, 1),
          'modifiedAt': datetime(2015, 1, 1),
          'tags': {
              'string': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **monitorArn** *(string) --* 

        The Amazon Resource Name (ARN) of the monitor.

        
      

      - **monitorName** *(string) --* 

        The name of the monitor.

        
      

      - **monitorStatus** *(string) --* 

        The status of a monitor. The status can be one of the following

         

        
        * ``PENDING``: The monitor is in the process of being created.
         
        * ``ACTIVE``: The monitor is active.
         
        * ``INACTIVE``: The monitor is inactive.
         
        * ``ERROR``: Monitor creation failed due to an error.
         
        * ``DELETING``: The monitor is in the process of being deleted.
        

        
      

      - **localResources** *(list) --* 

        The local resources to monitor. A local resource in a workload is the location of the hosts where the Network Flow Monitor agent is installed.

        
        

        - *(dict) --* 

          A local resource is the host where the agent is installed. Local resources can be a a subnet, a VPC, an Availability Zone, an EKS cluster or an Amazon Web Services Region.

          
          

          - **type** *(string) --* 

            The type of the local resource. Valid values are ``AWS::EC2::VPC`` ``AWS::AvailabilityZone``, ``AWS::EC2::Subnet``, ``AWS::EKS::Cluster``, or ``AWS::Region``.

            
          

          - **identifier** *(string) --* 

            The identifier of the local resource. The values you can specify are the following:

             

            
            * For a VPC, subnet or EKS cluster, this identifier is the VPC Amazon Resource Name (ARN), subnet ARN or cluster ARN.
             
            * For an Availability Zone, this identifier is the AZ name, for example, us-west-2b.
             
            * For a Region, this identifier is the Region name, for example, us-west-2.
            

            
      
    
      

      - **remoteResources** *(list) --* 

        The remote resources to monitor. A remote resource is the other endpoint specified for the network flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.

        
        

        - *(dict) --* 

          A remote resource is the other endpoint in a network flow. That is, one endpoint is the local resource and the other is the remote resource. The values you can specify are the following:

           

          
          * For a VPC or subnet, this identifier is the VPC Amazon Resource Name (ARN) or subnet ARN.
           
          * For a service, this identifier is one of the following strings: ``S3`` or ``DynamoDB``.
           
          * For an Availability Zone, this identifier is the AZ name, for example, us-west-2b.
           
          * For a Region, this identifier is the Region name, for example, us-west-2.
          

           

          When a remote resource is an Amazon Web Services Region, Network Flow Monitor provides network performance measurements up to the edge of the Region that you specify.

          
          

          - **type** *(string) --* 

            The type of the remote resource. Valid values are ``AWS::EC2::VPC`` ``AWS::AvailabilityZone``, ``AWS::EC2::Subnet``, ``AWS::AWSService``, or ``AWS::Region``.

            
          

          - **identifier** *(string) --* 

            The identifier of the remote resource. For a VPC or subnet, this identifier is the VPC Amazon Resource Name (ARN) or subnet ARN. For an Availability Zone, this identifier is the AZ name, for example, us-west-2b. For an Amazon Web Services Region , this identifier is the Region name, for example, us-west-2.

            
      
    
      

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

        The date and time when the monitor was created.

        
      

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

        The date and time when the monitor was last modified.

        
      

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

        The tags for a monitor.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
  
  **Exceptions**
  
  *   :py:class:`NetworkFlowMonitor.Client.exceptions.ResourceNotFoundException`

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

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

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

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

  