Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateDestination

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

Request Syntax


POST /destinations HTTP/1.1
Content-type: application/json

{
   "ClientRequestToken": "string",
   "Description": "string",
   "Expression": "string",
   "ExpressionType": "string",
   "Name": "string",
   "RoleArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientRequestToken

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.

Type: String

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

Pattern: ^[a-zA-Z0-9-_]+$

Required: No

Description

The description of the new resource.

Type: String

Length Constraints: Maximum length of 2048.

Required: No

Expression

The rule name or topic rule to send messages to.

Type: String

Length Constraints: Maximum length of 2048.

Required: Yes

ExpressionType

The type of value in Expression.

Type: String

Valid Values: RuleName | MqttTopic

Required: Yes

Name

The name of the new resource.

Type: String

Length Constraints: Maximum length of 128.

Pattern: [a-zA-Z0-9-_]+

Required: Yes

RoleArn

The ARN of the IAM Role that authorizes the destination.

Type: String

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

Required: Yes

Tags

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

Type: Array of Tag objects

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

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "Arn": "string",
   "Name": "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

The Amazon Resource Name of the new resource.

Type: String

Name

The name of the new resource.

Type: String

Length Constraints: Maximum length of 128.

Pattern: [a-zA-Z0-9-_]+

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