CreateDestinationCommand

Suggest an Edit

Creates a new destination that maps a device message to an AWS IoT rule.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IoTWirelessClient, CreateDestinationCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import
// const { IoTWirelessClient, CreateDestinationCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import
const client = new IoTWirelessClient(config);
const input = { // CreateDestinationRequest
  Name: "STRING_VALUE", // required
  ExpressionType: "RuleName" || "MqttTopic", // required
  Expression: "STRING_VALUE", // required
  Description: "STRING_VALUE",
  RoleArn: "STRING_VALUE", // required
  Tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
  ClientRequestToken: "STRING_VALUE",
};
const command = new CreateDestinationCommand(input);
const response = await client.send(command);
// { // CreateDestinationResponse
//   Arn: "STRING_VALUE",
//   Name: "STRING_VALUE",
// };

CreateDestinationCommand Input

See CreateDestinationCommandInput for more details

Parameter
Type
Description
Expression
Required
string | undefined

The rule name or topic rule to send messages to.

ExpressionType
Required
ExpressionType | undefined

The type of value in Expression.

Name
Required
string | undefined

The name of the new resource.

RoleArn
Required
string | undefined

The ARN of the IAM Role that authorizes the destination.

ClientRequestToken
string | undefined

Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests .

Description
string | undefined

The description of the new resource.

Tags
Tag[] | undefined

The tags to attach to the new destination. Tags are metadata that you can use to manage a resource.

CreateDestinationCommand Output

See CreateDestinationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Arn
string | undefined

The Amazon Resource Name of the new resource.

Name
string | undefined

The name of the new resource.

Throws

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.