ManagedintegrationsforIoTDeviceManagement / Client / get_ota_task_configuration

get_ota_task_configuration#

ManagedintegrationsforIoTDeviceManagement.Client.get_ota_task_configuration(**kwargs)#

Get a configuraiton for the over-the-air (OTA) task.

See also: AWS API Documentation

Request Syntax

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

Identifier (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'TaskConfigurationId': 'string',
    'Name': 'string',
    'PushConfig': {
        'AbortConfig': {
            'AbortConfigCriteriaList': [
                {
                    'Action': 'CANCEL',
                    'FailureType': 'FAILED'|'REJECTED'|'TIMED_OUT'|'ALL',
                    'MinNumberOfExecutedThings': 123,
                    'ThresholdPercentage': 123.0
                },
            ]
        },
        'RolloutConfig': {
            'ExponentialRolloutRate': {
                'BaseRatePerMinute': 123,
                'IncrementFactor': 123.0,
                'RateIncreaseCriteria': {
                    'numberOfNotifiedThings': 123,
                    'numberOfSucceededThings': 123
                }
            },
            'MaximumPerMinute': 123
        },
        'TimeoutConfig': {
            'InProgressTimeoutInMinutes': 123
        }
    },
    'Description': 'string',
    'CreatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • TaskConfigurationId (string) –

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

    • Name (string) –

      The name of the over-the-air (OTA) task configuration.

    • PushConfig (dict) –

      Describes the type of configuration used for the over-the-air (OTA) task.

      • AbortConfig (dict) –

        Structure representing one abort config.

        • AbortConfigCriteriaList (list) –

          The list of criteria for the abort config.

          • (dict) –

            Structure representing one abort config criteria.

            • Action (string) –

              The action taken by the abort configuration.

            • FailureType (string) –

              Over-the-air (OTA) task abort criteria failure type.

            • MinNumberOfExecutedThings (integer) –

              The minimum number of things that must receive task execution notifications before the task can be aborted.

            • ThresholdPercentage (float) –

              The minimum percentage of over-the-air (OTA) task execution failures that must occur to initiate the last abort.

      • RolloutConfig (dict) –

        Structure representing one rollout config.

        • ExponentialRolloutRate (dict) –

          Structure representing exponential rate of rollout for an over-the-air (OTA) task.

          • BaseRatePerMinute (integer) –

            The base rate per minute for the rollout of an over-the-air (OTA) task.

          • IncrementFactor (float) –

            The incremental factor for increasing the rollout rate of an over-the-air (OTA) task.

          • RateIncreaseCriteria (dict) –

            The criteria for increasing the rollout rate of an over-the-air (OTA) task.

            • numberOfNotifiedThings (integer) –

              The threshold for number of notified things that will initiate the increase in rate of rollout.

            • numberOfSucceededThings (integer) –

              The threshold for number of succeeded things that will initiate the increase in rate of rollout.

        • MaximumPerMinute (integer) –

          The maximum number of things that will be notified of a pending task, per minute.

      • TimeoutConfig (dict) –

        Structure representing one timeout config.

        • InProgressTimeoutInMinutes (integer) –

          Specifies the amount of time the device has to finish execution of this task. The timeout interval can be anywhere between 1 minute and 7 days.

    • Description (string) –

      A description of the over-the-air (OTA) task configuration.

    • CreatedAt (datetime) –

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

Exceptions