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. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
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.
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: