UpdateWirelessDevice - AWS IoT Wireless

UpdateWirelessDevice

Updates properties of a wireless device.

Request Syntax

PATCH /wireless-devices/Id HTTP/1.1 Content-type: application/json { "Description": "string", "DestinationName": "string", "LoRaWAN": { "AbpV1_0_x": { "FCntStart": number }, "AbpV1_1": { "FCntStart": number }, "DeviceProfileId": "string", "FPorts": { "Applications": [ { "DestinationName": "string", "FPort": number, "Type": "string" } ], "Positioning": { "ClockSync": number, "Gnss": number, "Stream": number } }, "ServiceProfileId": "string" }, "Name": "string", "Positioning": "string" }

URI Request Parameters

The request uses the following URI parameters.

Id

The ID of the resource to update.

Length Constraints: Maximum length of 256.

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

A new description of the resource.

Type: String

Length Constraints: Maximum length of 2048.

Required: No

DestinationName

The name of the new destination for the device.

Type: String

Length Constraints: Maximum length of 128.

Pattern: [a-zA-Z0-9-_]+

Required: No

LoRaWAN

The updated wireless device's configuration.

Type: LoRaWANUpdateDevice object

Required: No

Name

The new name of the resource.

Type: String

Length Constraints: Maximum length of 256.

Required: No

Positioning

FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

Type: String

Valid Values: Enabled | Disabled

Required: No

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.

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: