/destinations/{Name}

The AWS IoT Wireless multi-region endpoint

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

GET

Gets information about a destination.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/destinations/'

Response Example

200 - Example 1

{
    "Arn": "string",
    "Name": "string",
    "Expression": "string",
    "ExpressionType": "RuleName",
    "Description": "string",
    "RoleArn": "string"
}

Request

Path Params

Name

string

required

The name of the resource to get.

Responses

🟢200Success

application/json

Body

Arn

string

optional

The Amazon Resource Name of the resource.

Name

string

optional

The name of the resource.

<= 128 characters

Match pattern:

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

Expression

string

optional

The rule name or topic rule to send messages to.

<= 2048 characters

ExpressionType

enum<string>

optional

The type of value in Expression.

Allowed values:

RuleNameMqttTopic

Description

string

optional

The description of the resource.

<= 2048 characters

RoleArn

string

optional

The ARN of the IAM Role that authorizes the destination.

>= 20 characters<= 2048 characters

🟠480ValidationException

🟠481ResourceNotFoundException

🟠482AccessDeniedException

🟠483InternalServerException

🟠484ThrottlingException

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

/authorizer/{authorizerName}