ManagedintegrationsforIoTDeviceManagement / Client / list_ota_task_executions

list_ota_task_executions

ManagedintegrationsforIoTDeviceManagement.Client.list_ota_task_executions(**kwargs)

List all of the over-the-air (OTA) task executions.

See also: AWS API Documentation

Request Syntax

response = client.list_ota_task_executions(
    Identifier='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • Identifier (string) –

    [REQUIRED]

    The over-the-air (OTA) task id.

  • NextToken (string) – A token that can be used to retrieve the next set of results.

  • MaxResults (integer) – The maximum number of results to return at one time.

Return type:

dict

Returns:

Response Syntax

{
    'ExecutionSummaries': [
        {
            'TaskExecutionSummary': {
                'ExecutionNumber': 123,
                'LastUpdatedAt': datetime(2015, 1, 1),
                'QueuedAt': datetime(2015, 1, 1),
                'RetryAttempt': 123,
                'StartedAt': datetime(2015, 1, 1),
                'Status': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'REJECTED'|'REMOVED'|'CANCELED'
            },
            'ManagedThingId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ExecutionSummaries (list) –

      A list of all of the over-the-air (OTA) task executions.

      • (dict) –

        Structure representing one execution summary.

        • TaskExecutionSummary (dict) –

          Structure representing one over-the-air (OTA) task execution summary

          • ExecutionNumber (integer) –

            The execution number of the over-the-air (OTA) task execution summary.

          • LastUpdatedAt (datetime) –

            The timestamp value of when the over-the-air (OTA) task execution summary was last updated.

          • QueuedAt (datetime) –

            The timestamp value of when the over-the-air (OTA) task execution summary is targeted to start.

          • RetryAttempt (integer) –

            The number of retry attempts for starting the over-the-air (OTA) task execution summary after a failed attempt.

          • StartedAt (datetime) –

            The timestamp value of when the over-the-air (OTA) task execution summary started.

          • Status (string) –

            The status of the over-the-air (OTA) task execution summary.

        • ManagedThingId (string) –

          The id of a managed thing.

    • NextToken (string) –

      A token that can be used to retrieve the next set of results.

Exceptions