- 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.
UpdateDestinationCommand
Updates properties of a destination.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IoTWirelessClient, UpdateDestinationCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import
// const { IoTWirelessClient, UpdateDestinationCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import
const client = new IoTWirelessClient(config);
const input = { // UpdateDestinationRequest
Name: "STRING_VALUE", // required
ExpressionType: "RuleName" || "MqttTopic",
Expression: "STRING_VALUE",
Description: "STRING_VALUE",
RoleArn: "STRING_VALUE",
};
const command = new UpdateDestinationCommand(input);
const response = await client.send(command);
// {};
UpdateDestinationCommand Input
See UpdateDestinationCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
Name Required | string | undefined | The new name of the resource. |
Description | string | undefined | A new description of the resource. |
Expression | string | undefined | The new rule name or topic rule to send messages to. |
ExpressionType | ExpressionType | undefined | The type of value in |
RoleArn | string | undefined | The ARN of the IAM Role that authorizes the destination. |
UpdateDestinationCommand Output
See UpdateDestinationCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | User does not have permission to perform this action. |
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. |