CreateWirelessGatewayTaskDefinition - AWS IoT Wireless


Creates a gateway task definition.

Request Syntax

POST /wireless-gateway-task-definitions HTTP/1.1 Content-type: application/json { "AutoCreateTasks": boolean, "ClientRequestToken": "string", "Name": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Update": { "LoRaWAN": { "CurrentVersion": { "Model": "string", "PackageVersion": "string", "Station": "string" }, "SigKeyCrc": number, "UpdateSignature": "string", "UpdateVersion": { "Model": "string", "PackageVersion": "string", "Station": "string" } }, "UpdateDataRole": "string", "UpdateDataSource": "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.

Type: Boolean

Required: Yes


Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

Type: String

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

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

Required: No


The name of the new resource.

Type: String

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

Required: No


The tags to attach to the specified resource. 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


Information about the gateways to update.

Type: UpdateWirelessGatewayTaskCreate object

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 resource.

Type: String


The ID of the new wireless gateway task definition.

Type: String

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}


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


Resource does not exist.

HTTP Status Code: 404


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: