SnowDeviceManagement / Paginator / ListExecutions

ListExecutions

class SnowDeviceManagement.Paginator.ListExecutions

paginator = client.get_paginator('list_executions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SnowDeviceManagement.Client.list_executions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    state='QUEUED'|'IN_PROGRESS'|'CANCELED'|'FAILED'|'SUCCEEDED'|'REJECTED'|'TIMED_OUT',
    taskId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• taskId (string) –

  [REQUIRED]

  The ID of the task.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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 token to resume pagination.