CreateWirelessGatewayTask - AWS IoT Wireless

CreateWirelessGatewayTask

Creates a task for a wireless gateway.

Request Syntax

POST /wireless-gateways/Id/tasks HTTP/1.1 Content-type: application/json { "WirelessGatewayTaskDefinitionId": "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.

WirelessGatewayTaskDefinitionId

The ID of the WirelessGatewayTaskDefinition.

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}

Required: Yes

Response Syntax

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

Status

The status of the request.

Type: String

Valid Values: PENDING | IN_PROGRESS | FIRST_RETRY | SECOND_RETRY | COMPLETED | FAILED

WirelessGatewayTaskDefinitionId

The ID of the WirelessGatewayTaskDefinition.

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.

AccessDeniedException

User does not have permission to perform this action.

HTTP Status Code: 403

ConflictException

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 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: