/destinations

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

POST

/destinations

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

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/destinations' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Name": "string",
    "ExpressionType": "RuleName",
    "Expression": "string",
    "Description": "string",
    "RoleArn": "stringstringstringst",
    "Tags": [
        {
            "Key": "string",
            "Value": "string"
        }
    ],
    "ClientRequestToken": "string"
}'

Response Example

201 - Example 1

{
    "Arn": "string",
    "Name": "string"
}

Request

Body Params application/json

Name

string

required

The name of the new resource.

<= 128 characters

Match pattern:

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

ExpressionType

enum<string>

required

The type of value in Expression.

Allowed values:

RuleNameMqttTopic

Expression

string

required

The rule name or topic rule to send messages to.

<= 2048 characters

Description

string

optional

The description of the new resource.

<= 2048 characters

RoleArn

string

required

The ARN of the IAM Role that authorizes the destination.

>= 20 characters<= 2048 characters

Tags

array[object (Tag) {2}]

optional

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

>= 0 items<= 200 items

Key

string

required

The tag's key value.

>= 1 characters<= 128 characters

Value

string

required

The tag's value.

>= 0 characters<= 256 characters

ClientRequestToken

string

optional

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.

>= 1 characters<= 64 characters

Match pattern:

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

Examples

Responses

🟢201Success

application/json

Body

Arn

string

optional

The Amazon Resource Name of the new resource.

Name

string

optional

The name of the new resource.

<= 128 characters

Match pattern:

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

🟠480ValidationException

🟠481ResourceNotFoundException

🟠482AccessDeniedException

🟠483ConflictException

🟠484InternalServerException

🟠485ThrottlingException

Modified at 2022-09-10 19:46:41

/security-profiles/{securityProfileName}/targets

/security-profiles/{securityProfileName}/targets