list-devices¶
Description¶
Returns a list of devices.
See also: AWS API Documentation
Synopsis¶
list-devices
[--device-aggregated-status-filter <value>]
[--max-results <value>]
[--name-filter <value>]
[--next-token <value>]
[--sort-by <value>]
[--sort-order <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--device-aggregated-status-filter (string)
Filter based on a device’s status.
Possible values:
ERROR
AWAITING_PROVISIONING
PENDING
FAILED
DELETING
ONLINE
OFFLINE
LEASE_EXPIRED
UPDATE_NEEDED
REBOOTING
--max-results (integer)
The maximum number of devices to return in one page of results.
--name-filter (string)
Filter based on device’s name. Prefixes supported.
--next-token (string)
Specify the pagination token from a previous request to retrieve the next page of results.
--sort-by (string)
The target column to be sorted on. Default column sort is CREATED_TIME.
Possible values:
DEVICE_ID
CREATED_TIME
NAME
DEVICE_AGGREGATED_STATUS
--sort-order (string)
The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.
Possible values:
ASCENDING
DESCENDING
--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.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
on
off
auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output¶
Devices -> (list)
A list of devices.
(structure)
A device.
Brand -> (string)
The device’s maker.
CreatedTime -> (timestamp)
When the device was created.
CurrentSoftware -> (string)
A device’s current software.
Description -> (string)
A description for the device.
DeviceAggregatedStatus -> (string)
A device’s aggregated status. Including the device’s connection status, provisioning status, and lease status.
DeviceId -> (string)
The device’s ID.
LastUpdatedTime -> (timestamp)
When the device was updated.
LatestDeviceJob -> (structure)
A device’s latest job. Includes the target image version, and the update job status.
ImageVersion -> (string)
The target version of the device software.
JobType -> (string)
The job’s type.
Status -> (string)
Status of the latest device job.
LeaseExpirationTime -> (timestamp)
The device’s lease expiration time.
Name -> (string)
The device’s name.
ProvisioningStatus -> (string)
The device’s provisioning status.
Tags -> (map)
The device’s tags.
key -> (string)
value -> (string)
Type -> (string)
The device’s type.
NextToken -> (string)
A pagination token that’s included if more results are available.