Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . iot1click-devices ]

get-device-methods

Description

Given a device ID, returns the invokable methods associated with the device.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-device-methods
--device-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--device-id (string)

The unique identifier of the device.

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

Examples

To list the available methods for a device

The following get-device-methods example lists the available methods for a device.

aws iot1click-devices get-device-methods \
    --device-id G030PM0123456789

Output:

{
    "DeviceMethods": [
        {
            "MethodName": "getDeviceHealthParameters"
        },
        {
            "MethodName": "setDeviceHealthMonitorCallback"
        },
        {
            "MethodName": "getDeviceHealthMonitorCallback"
        },
        {
            "MethodName": "setOnClickCallback"
        },
        {
            "MethodName": "getOnClickCallback"
        }
    ]
}

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

Output

DeviceMethods -> (list)

List of available device APIs.

(structure)

DeviceType -> (string)

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

MethodName -> (string)

The name of the method applicable to the deviceType.