:doc:`SnowDeviceManagement <../../snow-device-management>` / Client / describe_task

*************
describe_task
*************



.. py:method:: SnowDeviceManagement.Client.describe_task(**kwargs)

  

  Checks the metadata for a given task on a device.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeTask>`_  


  **Request Syntax**
  ::

    response = client.describe_task(
        taskId='string'
    )
    
  :type taskId: string
  :param taskId: **[REQUIRED]** 

    The ID of the task to be described.

    

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

    
    ::

      {
          'completedAt': datetime(2015, 1, 1),
          'createdAt': datetime(2015, 1, 1),
          'description': 'string',
          'lastUpdatedAt': datetime(2015, 1, 1),
          'state': 'IN_PROGRESS'|'CANCELED'|'COMPLETED',
          'tags': {
              'string': 'string'
          },
          'targets': [
              'string',
          ],
          'taskArn': 'string',
          'taskId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **completedAt** *(datetime) --* 

        When the task was completed.

        
      

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

        When the ``CreateTask`` operation was called.

        
      

      - **description** *(string) --* 

        The description provided of the task and managed devices.

        
      

      - **lastUpdatedAt** *(datetime) --* 

        When the state of the task was last updated.

        
      

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

        The current state of the task.

        
      

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

        Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
      

      - **targets** *(list) --* 

        The managed devices that the task was sent to.

        
        

        - *(string) --* 
    
      

      - **taskArn** *(string) --* 

        The Amazon Resource Name (ARN) of the task.

        
      

      - **taskId** *(string) --* 

        The ID of the task.

        
  
  **Exceptions**
  
  *   :py:class:`SnowDeviceManagement.Client.exceptions.ThrottlingException`

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

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

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

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

  