UpdateWirelessGateway - AWS IoT Wireless

UpdateWirelessGateway

Updates properties of a wireless gateway.

Request Syntax

PATCH /wireless-gateways/Id HTTP/1.1 Content-type: application/json { "Description": "string", "JoinEuiFilters": [ [ "string" ] ], "MaxEirp": number, "Name": "string", "NetIdFilters": [ "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

JoinEuiFilters

A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.

Type: Array of arrays of strings

Array Members: Minimum number of 0 items. Maximum number of 3 items.

Array Members: Fixed number of 2 items.

Pattern: [a-fA-F0-9]{16}

Required: No

MaxEirp

The MaxEIRP value.

Type: Float

Valid Range: Minimum value of 0. Maximum value of 30.

Required: No

Name

The new name of the resource.

Type: String

Length Constraints: Maximum length of 256.

Required: No

NetIdFilters

A list of NetId values that are used by LoRa gateways to filter the uplink frames.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Pattern: [a-fA-F0-9]{6}

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: