ManagedintegrationsforIoTDeviceManagement / Client / list_ota_tasks

list_ota_tasks#

ManagedintegrationsforIoTDeviceManagement.Client.list_ota_tasks(**kwargs)#

List all of the over-the-air (OTA) tasks.

See also: AWS API Documentation

Request Syntax

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

  • 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

{
    'Tasks': [
        {
            'TaskId': 'string',
            'TaskArn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'LastUpdatedAt': datetime(2015, 1, 1),
            'TaskConfigurationId': 'string',
            'Status': 'IN_PROGRESS'|'CANCELED'|'COMPLETED'|'DELETION_IN_PROGRESS'|'SCHEDULED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Tasks (list) –

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

      • (dict) –

        Structure representing one over-the-air (OTA) task.

        • TaskId (string) –

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

        • TaskArn (string) –

          The Amazon Resource Name (ARN) of the over-the-air (OTA) task.

        • CreatedAt (datetime) –

          The timestamp value of when the over-the-air (OTA) task was created at.

        • LastUpdatedAt (datetime) –

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

        • TaskConfigurationId (string) –

          The identifier for the over-the-air (OTA) task configuration.

        • Status (string) –

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

    • NextToken (string) –

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

Exceptions