wireless_gateway_tasks

Creates, updates, deletes, gets or lists a wireless_gateway_tasks resource.

Overview

Name	wireless_gateway_tasks
Type	Resource
Id	aws.iotwireless.wireless_gateway_tasks

Fields

The following fields are returned by SELECT queries:

get_wireless_gateway_task

Name	Datatype	Description
last_uplink_received_at	string	The date and time when the most recent uplink was received. This value is only valid for 3 months. (pattern: <code>^([+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24:?00)([.,]\d+(?!:))?)?(\17[0-5]\d([.,]\d+)?)?([zZ]|([+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$</code>)
status	string	The status of the request. (PENDING, IN_PROGRESS, FIRST_RETRY, SECOND_RETRY, COMPLETED, FAILED)
task_created_at	string	The date and time when the task was created. (pattern: <code>^([+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24:?00)([.,]\d+(?!:))?)?(\17[0-5]\d([.,]\d+)?)?([zZ]|([+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$</code>)
wireless_gateway_id	string	The ID of the wireless gateway.
wireless_gateway_task_definition_id	string	The ID of the WirelessGatewayTask. (pattern: <code>[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_wireless_gateway_task	select	id, region		Gets information about a wireless gateway task.
create_wireless_gateway_task	insert	id, region, WirelessGatewayTaskDefinitionId		Creates a task for a wireless gateway.
delete_wireless_gateway_task	delete	id, region		Deletes a wireless gateway task.

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
id	string	The ID of the resource to delete.
region	string	AWS region (default: us-east-1)

SELECT examples

get_wireless_gateway_task

Gets information about a wireless gateway task.

SELECT
last_uplink_received_at,
status,
task_created_at,
wireless_gateway_id,
wireless_gateway_task_definition_id
FROM aws.iotwireless.wireless_gateway_tasks
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_wireless_gateway_task

Creates a task for a wireless gateway.

INSERT INTO aws.iotwireless.wireless_gateway_tasks (
WirelessGatewayTaskDefinitionId,
id,
region
)
SELECT 
'{{ WirelessGatewayTaskDefinitionId }}' /* required */,
'{{ id }}',
'{{ region }}'
RETURNING
status,
wireless_gateway_task_definition_id
;

Manifest

# Description fields are for documentation purposes
- name: wireless_gateway_tasks
props:
  - name: id
    value: "{{ id }}"
    description: Required parameter for the wireless_gateway_tasks resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the wireless_gateway_tasks resource.
  - name: WirelessGatewayTaskDefinitionId
    value: "{{ WirelessGatewayTaskDefinitionId }}"

DELETE examples

delete_wireless_gateway_task

Deletes a wireless gateway task.

DELETE FROM aws.iotwireless.wireless_gateway_tasks
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;