POST

/destinations

http://api.iotwireless.{region}.amazonaws.com/destinations

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

Access Token Required: API Key

Body Params

Namestringrequired

The name of the new resource.

Tagsarray

The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

RoleArnstringrequired

The ARN of the IAM Role that authorizes the destination.

Expressionstringrequired

The rule name or topic rule to send messages to.

Descriptionstring

The description of the new resource.

ExpressionTypestringrequired

The type of value in <code>Expression</code>.

ClientRequestTokenstring

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://api.iotwireless.{region}.amazonaws.com/destinations' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}