describe_task

describe_task(**kwargs)

Checks the metadata for a given task on a device.

See also: AWS API Documentation

Request Syntax

response = client.describe_task(
    taskId='string'
)
Parameters
taskId (string) --

[REQUIRED]

The ID of the task to be described.

Return type
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

  • SnowDeviceManagement.Client.exceptions.ThrottlingException
  • SnowDeviceManagement.Client.exceptions.InternalServerException
  • SnowDeviceManagement.Client.exceptions.ResourceNotFoundException
  • SnowDeviceManagement.Client.exceptions.ValidationException
  • SnowDeviceManagement.Client.exceptions.AccessDeniedException