ManagedintegrationsforIoTDeviceManagement / Client / get_ota_task

get_ota_task

ManagedintegrationsforIoTDeviceManagement.Client.get_ota_task(**kwargs)

Get details of the over-the-air (OTA) task by its task id.

See also: AWS API Documentation

Request Syntax

response = client.get_ota_task(
    Identifier='string'
)
Parameters:

Identifier (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'TaskId': 'string',
    'TaskArn': 'string',
    'Description': 'string',
    'S3Url': 'string',
    'Protocol': 'HTTP',
    'OtaType': 'ONE_TIME'|'CONTINUOUS',
    'OtaTargetQueryString': 'string',
    'OtaMechanism': 'PUSH',
    'Target': [
        'string',
    ],
    'CreatedAt': datetime(2015, 1, 1),
    'LastUpdatedAt': datetime(2015, 1, 1),
    'TaskConfigurationId': 'string',
    'TaskProcessingDetails': {
        'NumberOfCanceledThings': 123,
        'NumberOfFailedThings': 123,
        'NumberOfInProgressThings': 123,
        'numberOfQueuedThings': 123,
        'numberOfRejectedThings': 123,
        'numberOfRemovedThings': 123,
        'numberOfSucceededThings': 123,
        'numberOfTimedOutThings': 123,
        'processingTargets': [
            'string',
        ]
    },
    'OtaSchedulingConfig': {
        'EndBehavior': 'STOP_ROLLOUT'|'CANCEL'|'FORCE_CANCEL',
        'EndTime': 'string',
        'MaintenanceWindows': [
            {
                'DurationInMinutes': 123,
                'StartTime': 'string'
            },
        ],
        'StartTime': 'string'
    },
    'OtaTaskExecutionRetryConfig': {
        'RetryConfigCriteria': [
            {
                'FailureType': 'FAILED'|'TIMED_OUT'|'ALL',
                'MinNumberOfRetries': 123
            },
        ]
    },
    'Status': 'IN_PROGRESS'|'CANCELED'|'COMPLETED'|'DELETION_IN_PROGRESS'|'SCHEDULED',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • 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

    • Description (string) –

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

    • S3Url (string) –

      The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.

    • Protocol (string) –

      The connection protocol the over-the-air (OTA) task uses to update the device.

    • OtaType (string) –

      The frequency type for the over-the-air (OTA) task.

    • OtaTargetQueryString (string) –

      The query string to add things to the thing group.

    • OtaMechanism (string) –

      The deployment mechanism for the over-the-air (OTA) task.

    • Target (list) –

      The device targeted for the over-the-air (OTA) task.

      • (string) –

    • CreatedAt (datetime) –

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

    • 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.

    • TaskProcessingDetails (dict) –

      The processing details of all over-the-air (OTA) tasks.

      • NumberOfCanceledThings (integer) –

        The number of canceled things in an over-the-air (OTA) task.

      • NumberOfFailedThings (integer) –

        The number of failed things in an over-the-air (OTA) task.

      • NumberOfInProgressThings (integer) –

        The number of in progress things in an over-the-air (OTA) task.

      • numberOfQueuedThings (integer) –

        The number of queued things in an over-the-air (OTA) task.

      • numberOfRejectedThings (integer) –

        The number of rejected things in an over-the-air (OTA) task.

      • numberOfRemovedThings (integer) –

        The number of removed things in an over-the-air (OTA) task.

      • numberOfSucceededThings (integer) –

        The number of succeeded things in an over-the-air (OTA) task.

      • numberOfTimedOutThings (integer) –

        The number of timed out things in an over-the-air (OTA) task.

      • processingTargets (list) –

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

        • (string) –

    • OtaSchedulingConfig (dict) –

      Over-the-air (OTA) task scheduling config.

      • EndBehavior (string) –

        Specifies the end behavior for all task executions after a task reaches the selected endTime. If endTime is not selected when creating the task, then endBehavior does not apply.

      • EndTime (string) –

        The time an over-the-air (OTA) task will stop.

      • MaintenanceWindows (list) –

        Maintenance window list for over-the-air (OTA) task scheduling config.

        • (dict) –

          Structure representing scheduling maintenance window.

          • DurationInMinutes (integer) –

            Displays the duration of the next maintenance window.

          • StartTime (string) –

            Displays the start time of the next maintenance window.

      • StartTime (string) –

        The time an over-the-air (OTA) task will start.

    • OtaTaskExecutionRetryConfig (dict) –

      Over-the-air (OTA) task retry config.

      • RetryConfigCriteria (list) –

        The list of retry config criteria.

        • (dict) –

          Structure representing one retry config criteria.

          • FailureType (string) –

            Over-the-air (OTA) retry criteria failure type.

          • MinNumberOfRetries (integer) –

            The number of retries allowed for a failure type for the over-the-air (OTA) task.

    • Status (string) –

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

    • Tags (dict) –

      A set of key/value pairs that are used to manage the over-the-air (OTA) task.

      • (string) –

        • (string) –

Exceptions