SnowDeviceManagement / Client / list_executions

list_executions#

SnowDeviceManagement.Client.list_executions(**kwargs)#

Returns the status of tasks for one or more target devices.

See also: AWS API Documentation

Request Syntax

response = client.list_executions(
    maxResults=123,
    nextToken='string',
    state='QUEUED'|'IN_PROGRESS'|'CANCELED'|'FAILED'|'SUCCEEDED'|'REJECTED'|'TIMED_OUT',
    taskId='string'
)
Parameters:

  • maxResults (integer) – The maximum number of tasks to list per page.

  • nextToken (string) – A pagination token to continue to the next page of tasks.

  • state (string) – A structure used to filter the tasks by their current state.

  • taskId (string) –

    [REQUIRED]

    The ID of the task.

Return type:

dict

Returns:

Response Syntax

{
    'executions': [
        {
            'executionId': 'string',
            'managedDeviceId': 'string',
            'state': 'QUEUED'|'IN_PROGRESS'|'CANCELED'|'FAILED'|'SUCCEEDED'|'REJECTED'|'TIMED_OUT',
            'taskId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • executions (list) –

      A list of executions. Each execution contains the task ID, the device that the task is executing on, the execution ID, and the status of the execution.

      • (dict) –

        The summary of a task execution on a specified device.

        • executionId (string) –

          The ID of the execution.

        • managedDeviceId (string) –

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

        • state (string) –

          The state of the execution.

        • taskId (string) –

          The ID of the task.

    • nextToken (string) –

      A pagination token to continue to the next page of executions.

Exceptions