DeleteWirelessGatewayTaskDefinition
Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.
Request Syntax
DELETE /wireless-gateway-task-definitions/Id HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Id (p. 72)
The ID of the resource to delete.
Length Constraints: Maximum length of 36.
Pattern: [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}
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.
HTTP Status Code: 500
See Also
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
DisassociateAwsAccountFromPartnerAccount
DisassociateAwsAccountFromPartnerAccount
Disassociates your AWS account from a partner account. If PartnerAccountId and PartnerType are null, disassociates your AWS account from all partner accounts.
Request Syntax
DELETE /partner-accounts/PartnerAccountId?partnerType=PartnerType HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
PartnerAccountId (p. 74)
The partner account ID to disassociate from the AWS account.
Length Constraints: Maximum length of 256.
Required: Yes PartnerType (p. 74)
The partner type.
Valid Values: Sidewalk 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).
InternalServerException
An unexpected error occurred while processing a request.
HTTP Status Code: 500 ResourceNotFoundException
Resource does not exist.
See Also
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
DisassociateMulticastGroupFromFuotaTask
DisassociateMulticastGroupFromFuotaTask
Disassociates a multicast group from a fuota task.
Request Syntax
DELETE /fuota-tasks/Id/multicast-groups/MulticastGroupId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Id (p. 76)
The ID of a FUOTA task.
Length Constraints: Maximum length of 256.
Required: Yes MulticastGroupId (p. 76)
The ID of the multicast group.
Length Constraints: Maximum length of 256.
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 ConflictException
Adding, updating, or deleting the resource can cause an inconsistent state.
See Also
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 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
DisassociateWirelessDeviceFromFuotaTask
DisassociateWirelessDeviceFromFuotaTask
Disassociates a wireless device from a FUOTA task.
Request Syntax
DELETE /fuota-tasks/Id/wireless-devices/WirelessDeviceId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Id (p. 78)
The ID of a FUOTA task.
Length Constraints: Maximum length of 256.
Required: Yes WirelessDeviceId (p. 78)
The ID of the wireless device.
Length Constraints: Maximum length of 256.
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 ConflictException
Adding, updating, or deleting the resource can cause an inconsistent state.
See Also
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:
• 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
DisassociateWirelessDeviceFromMulticastGroup
DisassociateWirelessDeviceFromMulticastGroup
Disassociates a wireless device from a multicast group.
Request Syntax
DELETE /multicast-groups/Id/wireless-devices/WirelessDeviceId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Id (p. 80)
The ID of the multicast group.
Length Constraints: Maximum length of 256.
Required: Yes WirelessDeviceId (p. 80)
The ID of the wireless device.
Length Constraints: Maximum length of 256.
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
DisassociateWirelessDeviceFromThing
DisassociateWirelessDeviceFromThing
Disassociates a wireless device from its currently associated thing.
Request Syntax
DELETE /wireless-devices/Id/thing HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Id (p. 82)
The ID of the resource to update.
Length Constraints: Maximum length of 256.
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 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
See Also
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
DisassociateWirelessGatewayFromCertificate
DisassociateWirelessGatewayFromCertificate
Disassociates a wireless gateway from its currently associated certificate.
Request Syntax
DELETE /wireless-gateways/Id/certificate HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Id (p. 84)
The ID of the resource to update.
Length Constraints: Maximum length of 256.
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.
HTTP Status Code: 500 ResourceNotFoundException
Resource does not exist.
HTTP Status Code: 404
See Also
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
DisassociateWirelessGatewayFromThing
DisassociateWirelessGatewayFromThing
Disassociates a wireless gateway from its currently associated thing.
Request Syntax
DELETE /wireless-gateways/Id/thing HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Id (p. 86)
The ID of the resource to update.
Length Constraints: Maximum length of 256.
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 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
See Also
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
GetDestination
GetDestination
Gets information about a destination.
Request Syntax
GET /destinations/Name HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Name (p. 88)
The name of the resource to get.
Length Constraints: Maximum length of 128.
Pattern: [a-zA-Z0-9-_]+
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"Arn": "string",
"Description": "string", "Expression": "string", "ExpressionType": "string", "Name": "string",
"RoleArn": "string"
}
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.
Arn (p. 88)
The Amazon Resource Name of the resource.
Type: String Description (p. 88)
The description of the resource.
Errors
Type: String
Length Constraints: Maximum length of 2048.
Expression (p. 88)
The rule name or topic rule to send messages to.
Type: String
Length Constraints: Maximum length of 2048.
ExpressionType (p. 88)
The type of value in Expression.
Type: String
Valid Values: RuleName | MqttTopic Name (p. 88)
The name of the resource.
Type: String
Length Constraints: Maximum length of 128.
Pattern: [a-zA-Z0-9-_]+
RoleArn (p. 88)
The ARN of the IAM Role that authorizes the destination.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
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
See Also
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
GetDeviceProfile
GetDeviceProfile
Gets information about a device profile.
Request Syntax
GET /device-profiles/Id HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Id (p. 91)
The ID of the resource to get.
Length Constraints: Maximum length of 256.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"Arn": "string", "Id": "string", "LoRaWAN": {
"ClassBTimeout": number, "ClassCTimeout": number,
"FactoryPresetFreqsList": [ number ], "MacVersion": "string",
"MaxDutyCycle": number, "MaxEirp": number, "PingSlotDr": number, "PingSlotFreq": number, "PingSlotPeriod": number, "RegParamsRevision": "string", "RfRegion": "string",
"RxDataRate2": number, "RxDelay1": number, "RxDrOffset1": number, "RxFreq2": number,
"Supports32BitFCnt": boolean, "SupportsClassB": boolean, "SupportsClassC": boolean, "SupportsJoin": boolean },
"Name": "string"
}
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.
Arn (p. 91)
The Amazon Resource Name of the resource.
Type: String Id (p. 91)
The ID of the device profile.
Type: String
Length Constraints: Maximum length of 256.
LoRaWAN (p. 91)
Information about the device profile.
Type: LoRaWANDeviceProfile (p. 242) object Name (p. 91)
The name of the resource.
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 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
GetFuotaTask
GetFuotaTask
Gets information about a FUOTA task.
Request Syntax
GET /fuota-tasks/Id HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Id (p. 94)
The ID of a FUOTA task.
Length Constraints: Maximum length of 256.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"Arn": "string", "CreatedAt": number, "Description": "string",
"FirmwareUpdateImage": "string", "FirmwareUpdateRole": "string", "Id": "string",
"LoRaWAN": {
"RfRegion": "string", "StartTime": number },
"Name": "string", "Status": "string"
}
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.
Arn (p. 94)
The arn of a FUOTA task.
Type: String
Errors
Length Constraints: Maximum length of 128.
CreatedAt (p. 94)
Created at timestamp for the resource.
Type: Timestamp Description (p. 94)
The description of the new resource.
Type: String
Length Constraints: Maximum length of 2048.
FirmwareUpdateImage (p. 94)
The S3 URI points to a firmware update image that is to be used with a FUOTA task.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
FirmwareUpdateRole (p. 94)
The firmware update role that is to be used with a FUOTA task.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Id (p. 94)
The ID of a FUOTA task.
Type: String
Length Constraints: Maximum length of 256.
LoRaWAN (p. 94)
The LoRaWAN information returned from getting a FUOTA task.
Type: LoRaWANFuotaTaskGetInfo (p. 247) object Name (p. 94)
The name of a FUOTA task.
Type: String
Length Constraints: Maximum length of 256.
Status (p. 94)
The status of a FUOTA task.
Type: String
Valid Values: Pending | FuotaSession_Waiting | In_FuotaSession | FuotaDone | Delete_Waiting
Errors
For information about the errors that are common to all actions, see Common Errors (p. 299).
See Also
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
GetLogLevelsByResourceTypes
GetLogLevelsByResourceTypes
Returns current default log levels or log levels by resource types. Based on resource types, log levels can be for wireless device log options or wireless gateway log options.
Request Syntax
GET /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 200
Content-type: application/json {
"DefaultLogLevel": "string", "WirelessDeviceLogOptions": [ {
"WirelessGatewayLogOptions": [ {
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
DefaultLogLevel (p. 97)
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 WirelessDeviceLogOptions (p. 97)
The list of wireless device log options.
Type: Array of WirelessDeviceLogOption (p. 289) objects WirelessGatewayLogOptions (p. 97)
The list of wireless gateway log options.
Type: Array of WirelessGatewayLogOption (p. 293) 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 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++
See Also
• 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
GetMulticastGroup
GetMulticastGroup
Gets information about a multicast group.
Request Syntax
GET /multicast-groups/Id HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Id (p. 100)
The ID of the multicast group.
Length Constraints: Maximum length of 256.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"Arn": "string", "CreatedAt": number, "Description": "string", "Id": "string",
"LoRaWAN": {
"DlClass": "string",
"NumberOfDevicesInGroup": number, "NumberOfDevicesRequested": number, "RfRegion": "string"
},
"Name": "string", "Status": "string"
}
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.
Arn (p. 100)
The arn of the multicast group.
Errors
Type: String
Length Constraints: Maximum length of 128.
CreatedAt (p. 100)
Created at timestamp for the resource.
Type: Timestamp Description (p. 100)
The description of the new resource.
The description of the new resource.