:doc:`DeadlineCloud <../../deadline>` / Client / get_monitor

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



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

  

  Gets information about the specified monitor.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/GetMonitor>`_  


  **Request Syntax**
  ::

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

    The unique identifier for the monitor. This ID is returned by the ``CreateMonitor`` operation.

    

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

    
    ::

      {
          'monitorId': 'string',
          'displayName': 'string',
          'subdomain': 'string',
          'url': 'string',
          'roleArn': 'string',
          'identityCenterInstanceArn': 'string',
          'identityCenterApplicationArn': 'string',
          'createdAt': datetime(2015, 1, 1),
          'createdBy': 'string',
          'updatedAt': datetime(2015, 1, 1),
          'updatedBy': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **monitorId** *(string) --* 

        The unique identifier for the monitor.

        
      

      - **displayName** *(string) --* 

        The name used to identify the monitor on the Deadline Cloud console.

         

        .. warning::

           

          This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

          

        
      

      - **subdomain** *(string) --* 

        The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

        
      

      - **url** *(string) --* 

        The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

        
      

      - **roleArn** *(string) --* 

        The Amazon Resource Name of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.

        
      

      - **identityCenterInstanceArn** *(string) --* 

        The Amazon Resource Name of the IAM Identity Center instance responsible for authenticating monitor users.

        
      

      - **identityCenterApplicationArn** *(string) --* 

        The Amazon Resource Name that the IAM Identity Center assigned to the monitor when it was created.

        
      

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

        The UNIX timestamp of the date and time that the monitor was created.

        
      

      - **createdBy** *(string) --* 

        The user name of the person that created the monitor.

        
      

      - **updatedAt** *(datetime) --* 

        The UNIX timestamp of the last date and time that the monitor was updated.

        
      

      - **updatedBy** *(string) --* 

        The user name of the person that last updated the monitor.

        
  
  **Exceptions**
  
  *   :py:class:`DeadlineCloud.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DeadlineCloud.Client.exceptions.InternalServerErrorException`

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

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

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

  