get-destination¶

Description¶

Gets information about a destination.

Synopsis¶

  get-destination
--name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--name (string)

The name of the resource to get.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get information about an IoT wireless destination

The following get-destination example gets information about the destination resource with the name IoTWirelessDestination that you created.

aws iotwireless get-destination \
    --name "IoTWirelessDestination"

Output:

{
    "Arn": "arn:aws:iotwireless:us-east-1:123456789012:Destination/IoTWirelessDestination",
    "Name": "IoTWirelessDestination",
    "Expression": "IoTWirelessRule",
    "ExpressionType": "RuleName",
    "RoleArn": "arn:aws:iam::123456789012:role/IoTWirelessDestinationRole"
}

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

Output¶

Arn -> (string)

The Amazon Resource Name of the resource.

Name -> (string)

The name of the resource.

Expression -> (string)

The rule name or topic rule to send messages to.

ExpressionType -> (string)

The type of value in Expression .

Description -> (string)

The description of the resource.

RoleArn -> (string)

The ARN of the IAM Role that authorizes the destination.

Table of Contents

Feedback

User Guide