Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iot1click-devices ]



Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--device-id <value>
[--device-method <value>]
[--device-method-parameters <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--device-id (string)

The unique identifier of the device.

--device-method (structure)

The device method to invoke.

DeviceType -> (string)

The type of the device, such as "button".

MethodName -> (string)

The name of the method applicable to the deviceType.

Shorthand Syntax:


JSON Syntax:

  "DeviceType": "string",
  "MethodName": "string"

--device-method-parameters (string)

A JSON encoded string containing the device method request parameters.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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


To invoke a device method on a device

The following invoke-device-method example invokes the specified method on a device.

aws iot1click-devices invoke-device-method \
    --cli-input-json file://invoke-device-method.json

Contents of invoke-device-method.json:

    "DeviceId": "G030PM0123456789",
    "DeviceMethod": {
        "DeviceType": "device",
        "MethodName": "getDeviceHealthParameters"


    "DeviceMethodResponse": "{\"remainingLife\": 99.8}"

For more information, see Using AWS IoT 1-Click with the AWS CLI in the AWS IoT 1-Click Developer Guide.


DeviceMethodResponse -> (string)

A JSON encoded string containing the device method response.