wireless_gateways

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

Overview

Name	wireless_gateways
Type	Resource
Id	aws.iotwireless.wireless_gateways

Fields

The following fields are returned by SELECT queries:

get_wireless_gateway

Name	Datatype	Description
arn	string	The Amazon Resource Name of the resource.
description	string	The description of the new resource.
id	string	The ID of the wireless gateway.
lo_ra_wan	object	LoRaWANGateway object.
name	string	The name of the resource.
thing_arn	string	The ARN of the thing associated with the wireless gateway.
thing_name	string	The name of the thing associated with the wireless gateway. The value is empty if a thing isn't associated with the gateway.

list_wireless_gateways

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.
wireless_gateway_list	array	The ID of the wireless gateway.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_wireless_gateway	select	identifier, identifierType, region		Gets information about a wireless gateway.
list_wireless_gateways	select	region	nextToken, maxResults	Lists the wireless gateways registered to your AWS account.
create_wireless_gateway	insert	region, LoRaWAN		Provisions a wireless gateway. When provisioning a wireless gateway, you might run into duplication errors for the following reasons. If you specify a GatewayEui value that already exists. If you used a ClientRequestToken with the same parameters within the last 10 minutes. To avoid this error, make sure that you use unique identifiers and parameters for each request within the specified time period.
associate_wireless_gateway_with_certificate	update	id, region, IotCertificateId		Associates a wireless gateway with a certificate.
associate_wireless_gateway_with_thing	update	id, region, ThingArn		Associates a wireless gateway with a thing.
update_wireless_gateway	update	id, region		Updates properties of a wireless gateway.
delete_wireless_gateway	delete	id, region		Deletes a wireless gateway. When deleting a wireless gateway, you might run into duplication errors for the following reasons. If you specify a GatewayEui value that already exists. If you used a ClientRequestToken with the same parameters within the last 10 minutes. To avoid this error, make sure that you use unique identifiers and parameters for each request within the specified time period.
disassociate_wireless_gateway_from_certificate	exec	id, region		Disassociates a wireless gateway from its currently associated certificate.
disassociate_wireless_gateway_from_thing	exec	id, region		Disassociates a wireless gateway from its currently associated thing.

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 update.
identifier	string	The identifier of the wireless gateway to get.
identifierType	string	The type of identifier used in identifier.
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.

SELECT examples

get_wireless_gateway

Gets information about a wireless gateway.

SELECT
arn,
description,
id,
lo_ra_wan,
name,
thing_arn,
thing_name
FROM aws.iotwireless.wireless_gateways
WHERE identifier = '{{ identifier }}' -- required
AND identifierType = '{{ identifierType }}' -- required
AND region = '{{ region }}' -- required
;

list_wireless_gateways

Lists the wireless gateways registered to your AWS account.

SELECT
next_token,
wireless_gateway_list
FROM aws.iotwireless.wireless_gateways
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_wireless_gateway

Provisions a wireless gateway. When provisioning a wireless gateway, you might run into duplication errors for the following reasons. If you specify a GatewayEui value that already exists. If you used a ClientRequestToken with the same parameters within the last 10 minutes. To avoid this error, make sure that you use unique identifiers and parameters for each request within the specified time period.

INSERT INTO aws.iotwireless.wireless_gateways (
Name,
Description,
LoRaWAN,
Tags,
ClientRequestToken,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ LoRaWAN }}' /* required */,
'{{ Tags }}',
'{{ ClientRequestToken }}',
'{{ region }}'
RETURNING
arn,
id
;

Manifest

# Description fields are for documentation purposes
- name: wireless_gateways
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the wireless_gateways resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
    description: |
      The description of the new resource.
  - name: LoRaWAN
    description: |
      LoRaWANGateway object.
    value:
      GatewayEui: "{{ GatewayEui }}"
      RfRegion: "{{ RfRegion }}"
      JoinEuiFilters:
        - "{{ JoinEuiFilters }}"
      NetIdFilters:
        - "{{ NetIdFilters }}"
      SubBands:
        - {{ SubBands }}
      Beaconing:
        DataRate: {{ DataRate }}
        Frequencies:
          - {{ Frequencies }}
      MaxEirp: {{ MaxEirp }}
  - 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 }}"
  - 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.

UPDATE examples

associate_wireless_gateway_with_certificate

Associates a wireless gateway with a certificate.

UPDATE aws.iotwireless.wireless_gateways
SET 
IotCertificateId = '{{ IotCertificateId }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND IotCertificateId = '{{ IotCertificateId }}' --required
RETURNING
iot_certificate_id;

associate_wireless_gateway_with_thing

Associates a wireless gateway with a thing.

UPDATE aws.iotwireless.wireless_gateways
SET 
ThingArn = '{{ ThingArn }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND ThingArn = '{{ ThingArn }}' --required;

update_wireless_gateway

Updates properties of a wireless gateway.

UPDATE aws.iotwireless.wireless_gateways
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
JoinEuiFilters = '{{ JoinEuiFilters }}',
NetIdFilters = '{{ NetIdFilters }}',
MaxEirp = {{ MaxEirp }}
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_wireless_gateway

Deletes a wireless gateway. When deleting a wireless gateway, you might run into duplication errors for the following reasons. If you specify a GatewayEui value that already exists. If you used a ClientRequestToken with the same parameters within the last 10 minutes. To avoid this error, make sure that you use unique identifiers and parameters for each request within the specified time period.

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

Lifecycle Methods

disassociate_wireless_gateway_from_certificate

Disassociates a wireless gateway from its currently associated certificate.

EXEC aws.iotwireless.wireless_gateways.disassociate_wireless_gateway_from_certificate 
@id='{{ id }}' --required, 
@region='{{ region }}' --required
;

disassociate_wireless_gateway_from_thing

Disassociates a wireless gateway from its currently associated thing.

EXEC aws.iotwireless.wireless_gateways.disassociate_wireless_gateway_from_thing 
@id='{{ id }}' --required, 
@region='{{ region }}' --required
;