ota_task_configurations

Creates, updates, deletes, gets or lists an ota_task_configurations resource.

Overview

Name	ota_task_configurations
Type	Resource
Id	aws.iot_managed_integrations.ota_task_configurations

Fields

The following fields are returned by SELECT queries:

get_ota_task_configuration

Name	Datatype	Description
created_at	string (date-time)	The timestamp value of when the over-the-air (OTA) task configuration was created at.
description	string	A description of the over-the-air (OTA) task configuration. (pattern: <code>[0-9A-Za-z_- ]+</code>)
name	string	The name of the over-the-air (OTA) task configuration. (pattern: <code>[A-Za-z0-9-_ ]+</code>)
push_config	object	Structure representing a push config.
task_configuration_id	string	The over-the-air (OTA) task configuration id. (pattern: <code>[a-zA-Z0-9]*</code>)

list_ota_task_configurations

Name	Datatype	Description
created_at	string (date-time)	The timestamp value of when the over-the-air (OTA) task configuration was created at.
name	string	The name of the over-the-air (OTA) task configuration. (pattern: <code>[A-Za-z0-9-_ ]+</code>)
task_configuration_id	string	The id of the over-the-air (OTA) task configuration (pattern: <code>[a-zA-Z0-9]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ota_task_configuration	select	identifier, region		Get a configuraiton for the over-the-air (OTA) task.
list_ota_task_configurations	select	region	NextToken, MaxResults	List all of the over-the-air (OTA) task configurations.
create_ota_task_configuration	insert	region		Create a configuraiton for the over-the-air (OTA) task.
delete_ota_task_configuration	delete	identifier, region		Delete the over-the-air (OTA) task configuration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
identifier	string	The identifier of the over-the-air (OTA) task configuration.
region	string	AWS region (default: us-east-1)
MaxResults	integer	The maximum number of results to return at one time.
NextToken	string	A token that can be used to retrieve the next set of results.

SELECT examples

get_ota_task_configuration

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

SELECT
created_at,
description,
name,
push_config,
task_configuration_id
FROM aws.iot_managed_integrations.ota_task_configurations
WHERE identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_ota_task_configurations

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

SELECT
created_at,
name,
task_configuration_id
FROM aws.iot_managed_integrations.ota_task_configurations
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;

INSERT examples

create_ota_task_configuration

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

INSERT INTO aws.iot_managed_integrations.ota_task_configurations (
Description,
Name,
PushConfig,
ClientToken,
region
)
SELECT 
'{{ Description }}',
'{{ Name }}',
'{{ PushConfig }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
task_configuration_id
;

Manifest

# Description fields are for documentation purposes
- name: ota_task_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ota_task_configurations resource.
  - name: Description
    value: "{{ Description }}"
  - name: Name
    value: "{{ Name }}"
  - name: PushConfig
    description: |
      Structure representing a push config.
    value:
      AbortConfig:
        AbortConfigCriteriaList:
          - Action: "{{ Action }}"
            FailureType: "{{ FailureType }}"
            MinNumberOfExecutedThings: {{ MinNumberOfExecutedThings }}
            ThresholdPercentage: {{ ThresholdPercentage }}
      RolloutConfig:
        ExponentialRolloutRate:
          BaseRatePerMinute: {{ BaseRatePerMinute }}
          IncrementFactor: {{ IncrementFactor }}
          RateIncreaseCriteria:
            numberOfNotifiedThings: {{ numberOfNotifiedThings }}
            numberOfSucceededThings: {{ numberOfSucceededThings }}
        MaximumPerMinute: {{ MaximumPerMinute }}
      TimeoutConfig:
        InProgressTimeoutInMinutes: {{ InProgressTimeoutInMinutes }}
  - name: ClientToken
    value: "{{ ClientToken }}"

DELETE examples

delete_ota_task_configuration

Delete the over-the-air (OTA) task configuration.

DELETE FROM aws.iot_managed_integrations.ota_task_configurations
WHERE identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
;