[ aws . iotwireless ]

update-destination

Description

Updates properties of a destination.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-destination
--name <value>
[--expression-type <value>]
[--expression <value>]
[--description <value>]
[--role-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The new name of the resource.

--expression-type (string)

The type of value in Expression .

Possible values:

• RuleName

• MqttTopic

--expression (string)

The new rule name or topic rule to send messages to.

--description (string)

A new description of the resource.

--role-arn (string)

The ARN of the IAM Role that authorizes the destination.

--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.

Examples

To update the properties of a destination

The following update-destination example updates the description property of a wireless destination.

aws iotwireless update-destination \
    --name "IoTWirelessDestination" \
    --description "Destination for messages processed using IoTWirelessRule"

This command produces no output.

For more information, see Add destinations to AWS IoT Core for LoRaWAN in the AWS IoT Developers Guide.

Output

None