[ aws . iotwireless ]

create-destination

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-destination
--name <value>
--expression-type <value>
--expression <value>
[--description <value>]
--role-arn <value>
[--tags <value>]
[--client-request-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the new resource.

--expression-type (string)

The type of value in Expression .

Possible values:

• RuleName

--expression (string)

The rule name or topic rule to send messages to.

--description (string)

The description of the new resource.

--role-arn (string)

The ARN of the IAM Role that authorizes the destination.

--tags (list)

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

(structure)

A simple label consisting of a customer-defined key-value pair

Key -> (string)

The tag’s key value.

Value -> (string)

The tag’s value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--client-request-token (string)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Arn -> (string)

The Amazon Resource Name of the new resource.

Name -> (string)

The name of the new resource.