SnowDeviceManagement / Client / describe_execution

describe_execution#

SnowDeviceManagement.Client.describe_execution(**kwargs)#

Checks the status of a remote task running on one or more target devices.

See also: AWS API Documentation

Request Syntax

response = client.describe_execution(
    managedDeviceId='string',
    taskId='string'
)
Parameters:

  • managedDeviceId (string) –

    [REQUIRED]

    The ID of the managed device.

  • taskId (string) –

    [REQUIRED]

    The ID of the task that the action is describing.

Return type:

dict

Returns:

Response Syntax

{
    'executionId': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'managedDeviceId': 'string',
    'startedAt': datetime(2015, 1, 1),
    'state': 'QUEUED'|'IN_PROGRESS'|'CANCELED'|'FAILED'|'SUCCEEDED'|'REJECTED'|'TIMED_OUT',
    'taskId': 'string'
}

Response Structure

  • (dict) –

    • executionId (string) –

      The ID of the execution.

    • lastUpdatedAt (datetime) –

      When the status of the execution was last updated.

    • managedDeviceId (string) –

      The ID of the managed device that the task is being executed on.

    • startedAt (datetime) –

      When the execution began.

    • state (string) –

      The current state of the execution.

    • taskId (string) –

      The ID of the task being executed on the device.

Exceptions