list-devices¶
Description¶
Retrieves a list of devices registered with the specified fleet.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
list-devices
--fleet-arn <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--fleet-arn (string)
The ARN of the fleet.
--next-token (string)
The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
--max-results (integer)
The maximum number of results to be included in the next page.
--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.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Output¶
Devices -> (list)
Information about the devices.
(structure)
The summary of devices.
DeviceId -> (string)
The ID of the device.
DeviceStatus -> (string)
The status of the device.
NextToken -> (string)
The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.