[ aws . sagemaker ]

list-devices

Description

A list of devices.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-devices is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: DeviceSummaries

Synopsis

  list-devices
[--latest-heartbeat-after <value>]
[--model-name <value>]
[--device-fleet-name <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--latest-heartbeat-after (timestamp)

Select fleets where the job was updated after X

--model-name (string)

A filter that searches devices that contains this name in any of their models.

--device-fleet-name (string)

Filter for fleets containing this name in their device fleet name.

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

See ‘aws help’ for descriptions of global parameters.

Output

DeviceSummaries -> (list)

Summary of devices.

(structure)

Summary of the device.

DeviceName -> (string)

The unique identifier of the device.

DeviceArn -> (string)

Amazon Resource Name (ARN) of the device.

Description -> (string)

A description of the device.

DeviceFleetName -> (string)

The name of the fleet the device belongs to.

IotThingName -> (string)

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..

RegistrationTime -> (timestamp)

The timestamp of the last registration or de-reregistration.

LatestHeartbeat -> (timestamp)

The last heartbeat received from the device.

Models -> (list)

Models on the device.

(structure)

Summary of model on edge device.

ModelName -> (string)

The name of the model.

ModelVersion -> (string)

The version model.

NextToken -> (string)

The response from the last list when returning a list large enough to need tokening.