wireless_gateway_task_definitions

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

Overview

Name	wireless_gateway_task_definitions
Type	Resource
Id	aws.iotwireless.wireless_gateway_task_definitions

Fields

The following fields are returned by SELECT queries:

get_wireless_gateway_task_definition

Name	Datatype	Description
arn	string	The Amazon Resource Name of the resource.
auto_create_tasks	boolean	Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.
name	string	The name of the resource.
update	object	UpdateWirelessGatewayTaskCreate object.

list_wireless_gateway_task_definitions

Name	Datatype	Description
next_token	string	The token to use to get the next set of results, or null if there are no additional results.
task_definitions	array	The list of task definitions.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_wireless_gateway_task_definition	select	id, region		Gets information about a wireless gateway task definition.
list_wireless_gateway_task_definitions	select	region	maxResults, nextToken, taskDefinitionType	List the wireless gateway tasks definitions registered to your AWS account.
create_wireless_gateway_task_definition	insert	region, AutoCreateTasks		Creates a gateway task definition.
delete_wireless_gateway_task_definition	delete	id, region		Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.

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)
maxResults	integer	The maximum number of results to return in this operation.
nextToken	string	To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
taskDefinitionType	string	A filter to list only the wireless gateway task definitions that use this task definition type.

SELECT examples

get_wireless_gateway_task_definition

Gets information about a wireless gateway task definition.

SELECT
arn,
auto_create_tasks,
name,
update
FROM aws.iotwireless.wireless_gateway_task_definitions
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_wireless_gateway_task_definitions

List the wireless gateway tasks definitions registered to your AWS account.

SELECT
next_token,
task_definitions
FROM aws.iotwireless.wireless_gateway_task_definitions
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND taskDefinitionType = '{{ taskDefinitionType }}'
;

INSERT examples

create_wireless_gateway_task_definition

Creates a gateway task definition.

INSERT INTO aws.iotwireless.wireless_gateway_task_definitions (
AutoCreateTasks,
Name,
Update,
ClientRequestToken,
Tags,
region
)
SELECT 
{{ AutoCreateTasks }} /* required */,
'{{ Name }}',
'{{ Update }}',
'{{ ClientRequestToken }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
arn,
id
;

Manifest

# Description fields are for documentation purposes
- name: wireless_gateway_task_definitions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the wireless_gateway_task_definitions resource.
  - name: AutoCreateTasks
    value: {{ AutoCreateTasks }}
  - name: Name
    value: "{{ Name }}"
  - name: Update
    description: |
      UpdateWirelessGatewayTaskCreate object.
    value:
      UpdateDataSource: "{{ UpdateDataSource }}"
      UpdateDataRole: "{{ UpdateDataRole }}"
      LoRaWAN:
        UpdateSignature: "{{ UpdateSignature }}"
        SigKeyCrc: {{ SigKeyCrc }}
        CurrentVersion:
          PackageVersion: "{{ PackageVersion }}"
          Model: "{{ Model }}"
          Station: "{{ Station }}"
        UpdateVersion:
          PackageVersion: "{{ PackageVersion }}"
          Model: "{{ Model }}"
          Station: "{{ Station }}"
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
    description: |
      Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
  - name: Tags
    description: |
      The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_wireless_gateway_task_definition

Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.

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