- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateWirelessGatewayTaskCommand
Creates a task for a wireless gateway.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IoTWirelessClient, CreateWirelessGatewayTaskCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import
// const { IoTWirelessClient, CreateWirelessGatewayTaskCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import
const client = new IoTWirelessClient(config);
const input = { // CreateWirelessGatewayTaskRequest
Id: "STRING_VALUE", // required
WirelessGatewayTaskDefinitionId: "STRING_VALUE", // required
};
const command = new CreateWirelessGatewayTaskCommand(input);
const response = await client.send(command);
// { // CreateWirelessGatewayTaskResponse
// WirelessGatewayTaskDefinitionId: "STRING_VALUE",
// Status: "PENDING" || "IN_PROGRESS" || "FIRST_RETRY" || "SECOND_RETRY" || "COMPLETED" || "FAILED",
// };
CreateWirelessGatewayTaskCommand Input
See CreateWirelessGatewayTaskCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
IdRequired | string | undefined | The ID of the resource to update. |
WirelessGatewayTaskDefinitionIdRequired | string | undefined | The ID of the WirelessGatewayTaskDefinition. |
CreateWirelessGatewayTaskCommand Output
See CreateWirelessGatewayTaskCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Status | WirelessGatewayTaskStatus | undefined | The status of the request. |
WirelessGatewayTaskDefinitionId | string | undefined | The ID of the WirelessGatewayTaskDefinition. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | User does not have permission to perform this action. |
| ConflictException | client | Adding, updating, or deleting the resource can cause an inconsistent state. |
| InternalServerException | server | An unexpected error occurred while processing a request. |
| ResourceNotFoundException | client | Resource does not exist. |
| ThrottlingException | client | The request was denied because it exceeded the allowed API request rate. |
| ValidationException | client | The input did not meet the specified constraints. |
| IoTWirelessServiceException | Base exception class for all service exceptions from IoTWireless service. |