invoke-device-method¶

Description¶

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

Synopsis¶

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

Options¶

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

DeviceType=string,MethodName=string

JSON Syntax:

{
  "DeviceType": "string",
  "MethodName": "string"
}

--device-method-parameters (string)

A JSON encoded string containing the device method request parameters.

--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 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"
    }
}

Output:

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

Output¶

DeviceMethodResponse -> (string)

A JSON encoded string containing the device method response.

Table of Contents

Feedback

User Guide