CreateWirelessGatewayTaskDeﬁnition

Creates a gateway task deﬁnition.

Request Syntax

POST /wireless-gateway-task-definitions HTTP/1.1 Content-type: application/json

{

"AutoCreateTasks": boolean, "ClientRequestToken": "string", "Name": "string",

"Tags": [

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

AutoCreateTasks (p. 50)

Whether to automatically create tasks using this task deﬁnition for all gateways with the speciﬁed current version. If false, the task must me created by calling CreateWirelessGatewayTask.

Type: Boolean Required: Yes

Response Syntax

ClientRequestToken (p. 50)

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 Name (p. 50)

The name of the new resource.

Type: String

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

Required: No Tags (p. 50)

The tags to attach to the speciﬁed resource. Tags are metadata that you can use to manage a resource.

Type: Array of Tag (p. 284) objects

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

Required: No Update (p. 50)

Information about the gateways to update.

Type: UpdateWirelessGatewayTaskCreate (p. 286) 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.

Arn (p. 51)

The Amazon Resource Name of the resource.

Errors

Type: String Id (p. 51)

The ID of the new wireless gateway task deﬁnition.

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}

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 ConﬂictException

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 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 speciﬁed constraints.

HTTP Status Code: 400

Request Syntax

DELETE /destinations/Name HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Name (p. 54)

The name of the resource to delete.

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 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 ConﬂictException

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

HTTP Status Code: 409 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 speciﬁed constraints.

HTTP Status Code: 400

Request Syntax

DELETE /device-profiles/Id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Id (p. 56)

The ID of the resource to delete.

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 ConﬂictException

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 speciﬁed constraints.

HTTP Status Code: 400

Request Syntax

DELETE /fuota-tasks/Id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Id (p. 58)

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 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 speciﬁed constraints.

HTTP Status Code: 400

Request Syntax

DELETE /multicast-groups/Id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Id (p. 60)

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 ConﬂictException

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 speciﬁed constraints.

HTTP Status Code: 400

Request Syntax

DELETE /wireless-devices/Id/data?messageId=MessageId&WirelessDeviceType=WirelessDeviceType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Id (p. 62)

The ID of a given wireless device for which downlink messages will be deleted.

Length Constraints: Maximum length of 256.

Required: Yes MessageId (p. 62)

If message ID is "*", it cleares the entire downlink queue for a given device, speciﬁed by the wireless device ID. Otherwise, the downlink message with the speciﬁed message ID will be deleted.

Required: Yes

WirelessDeviceType (p. 62)

The wireless device type, which can be either Sidewalk or LoRaWAN.

Valid Values: Sidewalk | LoRaWAN

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.

See Also

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 speciﬁed constraints.

HTTP Status Code: 400

Request Syntax

DELETE /service-profiles/Id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Id (p. 64)

The ID of the resource to delete.

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 ConﬂictException

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 speciﬁed constraints.

HTTP Status Code: 400

Request Syntax

DELETE /wireless-devices/Id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Id (p. 66)

The ID of the resource to delete.

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 speciﬁed constraints.

HTTP Status Code: 400

Request Syntax

DELETE /wireless-gateways/Id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Id (p. 68)

The ID of the resource to delete.

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 speciﬁed constraints.

HTTP Status Code: 400

Request Syntax

DELETE /wireless-gateways/Id/tasks HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Id (p. 70)

The ID of the resource to delete.

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 speciﬁed constraints.

HTTP Status Code: 400

CreateWirelessGatewayTaskDeﬁnition