IoT / Client / list_ota_updates

list_ota_updates#

IoT.Client.list_ota_updates(**kwargs)#

Lists OTA updates.

Requires permission to access the ListOTAUpdates action.

See also: AWS API Documentation

Request Syntax

response = client.list_ota_updates(
    maxResults=123,
    nextToken='string',
    otaUpdateStatus='CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'
)
Parameters:

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

  • nextToken (string) – A token used to retrieve the next set of results.

  • otaUpdateStatus (string) – The OTA update job status.

Return type:

dict

Returns:

Response Syntax

{
    'otaUpdates': [
        {
            'otaUpdateId': 'string',
            'otaUpdateArn': 'string',
            'creationDate': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • otaUpdates (list) –

      A list of OTA update jobs.

      • (dict) –

        An OTA update summary.

        • otaUpdateId (string) –

          The OTA update ID.

        • otaUpdateArn (string) –

          The OTA update ARN.

        • creationDate (datetime) –

          The date when the OTA update was created.

    • nextToken (string) –

      A token to use to get the next set of results.

Exceptions