CreateWirelessGateway - AWS IoT Wireless


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.

Request Syntax

POST /wireless-gateways HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "Description": "string", "LoRaWAN": { "Beaconing": { "DataRate": number, "Frequencies": [ number ] }, "GatewayEui": "string", "JoinEuiFilters": [ [ "string" ] ], "MaxEirp": number, "NetIdFilters": [ "string" ], "RfRegion": "string", "SubBands": [ number ] }, "Name": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

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

Required: No


The description of the new resource.

Type: String

Length Constraints: Maximum length of 2048.

Required: No


The gateway configuration information to use to create the wireless gateway.

Type: LoRaWANGateway object

Required: Yes


The name of the new resource.

Type: String

Length Constraints: Maximum length of 256.

Required: No


The tags to attach to the new wireless gateway. Tags are metadata that you can use to manage a resource.

Type: Array of Tag objects

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

Required: No

Response Syntax

HTTP/1.1 201 Content-type: application/json { "Arn": "string", "Id": "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.


The Amazon Resource Name of the new resource.

Type: String


The ID of the new wireless gateway.

Type: String

Length Constraints: Maximum length of 256.


For information about the errors that are common to all actions, see Common Errors.


User does not have permission to perform this action.

HTTP Status Code: 403


Adding, updating, or deleting the resource can cause an inconsistent state.

HTTP Status Code: 409


An unexpected error occurred while processing a request.

HTTP Status Code: 500


The request was denied because it exceeded the allowed API request rate.

HTTP Status Code: 429


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: