ListWirelessGatewayTaskDefinitions
List the wireless gateway tasks definitions registered to your AWS account.
Request Syntax
GET /wireless-gateway-task-definitions?
maxResults=MaxResults&nextToken=NextToken&taskDefinitionType=TaskDefinitionType HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
MaxResults (p. 169)
The maximum number of results to return in this operation.
Valid Range: Minimum value of 0. Maximum value of 250.
NextToken (p. 169)
To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
Length Constraints: Maximum length of 4096.
TaskDefinitionType (p. 169)
A filter to list only the wireless gateway task definitions that use this task definition type.
Valid Values: UPDATE
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"NextToken": "string", "TaskDefinitions": [ {
Response Elements
} } } ] }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
NextToken (p. 169)
The token to use to get the next set of results, or null if there are no additional results.
Type: String
Length Constraints: Maximum length of 4096.
TaskDefinitions (p. 169) The list of task definitions.
Type: Array of UpdateWirelessGatewayTaskEntry (p. 287) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 299).
AccessDeniedException
User does not have permission to perform this action.
HTTP Status Code: 403 InternalServerException
An unexpected error occurred while processing a request.
HTTP Status Code: 500 ThrottlingException
The request was denied because it exceeded the allowed API request rate.
HTTP Status Code: 429 ValidationException
The input did not meet the specified constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
See Also
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
PutResourceLogLevel
PutResourceLogLevel
Sets the log-level override for a resource-ID and resource-type. This option can be specified for a wireless gateway or a wireless device. A limit of 200 log level override can be set per account.
Request Syntax
PUT /log-levels/ResourceIdentifier?resourceType=ResourceType HTTP/1.1 Content-type: application/json
{
"LogLevel": "string"
}
URI Request Parameters
The request uses the following URI parameters.
ResourceIdentifier (p. 172)
The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.
Length Constraints: Maximum length of 256.
Required: Yes ResourceType (p. 172)
The type of the resource, which can be WirelessDevice or WirelessGateway.
Required: Yes
Request Body
The request accepts the following data in JSON format.
LogLevel (p. 172)
The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.
Type: String
Valid Values: INFO | ERROR | DISABLED Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 299).
AccessDeniedException
User does not have permission to perform this action.
HTTP Status Code: 403 InternalServerException
An unexpected error occurred while processing a request.
HTTP Status Code: 500 ResourceNotFoundException
Resource does not exist.
HTTP Status Code: 404 ThrottlingException
The request was denied because it exceeded the allowed API request rate.
HTTP Status Code: 429 ValidationException
The input did not meet the specified constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ResetAllResourceLogLevels
ResetAllResourceLogLevels
Removes the log-level overrides for all resources; both wireless devices and wireless gateways.
Request Syntax
DELETE /log-levels HTTP/1.1
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 204
Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 299).
AccessDeniedException
User does not have permission to perform this action.
HTTP Status Code: 403 InternalServerException
An unexpected error occurred while processing a request.
HTTP Status Code: 500 ResourceNotFoundException
Resource does not exist.
HTTP Status Code: 404 ThrottlingException
The request was denied because it exceeded the allowed API request rate.
HTTP Status Code: 429 ValidationException
The input did not meet the specified constraints.
See Also
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ResetResourceLogLevel
ResetResourceLogLevel
Removes the log-level override, if any, for a specific resource-ID and resource-type. It can be used for a wireless device or a wireless gateway.
Request Syntax
DELETE /log-levels/ResourceIdentifier?resourceType=ResourceType HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
ResourceIdentifier (p. 176)
The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.
Length Constraints: Maximum length of 256.
Required: Yes ResourceType (p. 176)
The type of the resource, which can be WirelessDevice or WirelessGateway.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 204
Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 299).
AccessDeniedException
User does not have permission to perform this action.
HTTP Status Code: 403 InternalServerException
An unexpected error occurred while processing a request.
See Also
HTTP Status Code: 500 ResourceNotFoundException
Resource does not exist.
HTTP Status Code: 404 ThrottlingException
The request was denied because it exceeded the allowed API request rate.
HTTP Status Code: 429 ValidationException
The input did not meet the specified constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
SendDataToMulticastGroup
SendDataToMulticastGroup
Sends the specified data to a multicast group.
Request Syntax
POST /multicast-groups/Id/data HTTP/1.1 Content-type: application/json
{
"PayloadData": "string", "WirelessMetadata": { "LoRaWAN": { "FPort": number }
}}
URI Request Parameters
The request uses the following URI parameters.
Id (p. 178)
The ID of the multicast group.
Length Constraints: Maximum length of 256.
Required: Yes
Request Body
The request accepts the following data in JSON format.
PayloadData (p. 178)
The binary to be sent to the end device, encoded in base64.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
Required: Yes
WirelessMetadata (p. 178)
Wireless metadata that is to be sent to multicast group.
Type: MulticastWirelessMetadata (p. 269) object Required: Yes
Response Syntax
HTTP/1.1 201
Response Elements
Content-type: application/json { "MessageId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
MessageId (p. 178)
ID of a multicast group message.
Type: String
Length Constraints: Maximum length of 256.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 299).
AccessDeniedException
User does not have permission to perform this action.
HTTP Status Code: 403 ConflictException
Adding, updating, or deleting the resource can cause an inconsistent state.
HTTP Status Code: 409 InternalServerException
An unexpected error occurred while processing a request.
HTTP Status Code: 500 ResourceNotFoundException
Resource does not exist.
HTTP Status Code: 404 ThrottlingException
The request was denied because it exceeded the allowed API request rate.
HTTP Status Code: 429 ValidationException
The input did not meet the specified constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
See Also
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
SendDataToWirelessDevice
SendDataToWirelessDevice
Sends a decrypted application data frame to a device.
Request Syntax
POST /wireless-devices/Id/data HTTP/1.1 Content-type: application/json
{
"PayloadData": "string", "TransmitMode": number, "WirelessMetadata": { "LoRaWAN": { "FPort": number },
"Sidewalk": {
"MessageType": "string", "Seq": number
} }}
URI Request Parameters
The request uses the following URI parameters.
Id (p. 181)
The ID of the wireless device to receive the data.
Length Constraints: Maximum length of 256.
Required: Yes
Request Body
The request accepts the following data in JSON format.
PayloadData (p. 181)
The binary to be sent to the end device, encoded in base64.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
Required: Yes TransmitMode (p. 181)
The transmit mode to use to send data to the wireless device. Can be: 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).
Type: Integer
Response Syntax
Valid Range: Minimum value of 0. Maximum value of 1.
Required: Yes
WirelessMetadata (p. 181)
Metadata about the message request.
Type: WirelessMetadata (p. 296) object Required: No
Response Syntax
HTTP/1.1 202
Content-type: application/json {
"MessageId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
MessageId (p. 182)
The ID of the message sent to the wireless device.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 299).
InternalServerException
An unexpected error occurred while processing a request.
HTTP Status Code: 500 ResourceNotFoundException
Resource does not exist.
HTTP Status Code: 404 ThrottlingException
The request was denied because it exceeded the allowed API request rate.
HTTP Status Code: 429 ValidationException
The input did not meet the specified constraints.
HTTP Status Code: 400