[ aws . cognito-idp ]
Lists devices, as an administrator.
Calling this action requires developer credentials.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
admin-list-devices
--user-pool-id <value>
--username <value>
[--limit <value>]
[--pagination-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--user-pool-id
(string)
The user pool ID.
--username
(string)
The user name.
--limit
(integer)
The limit of the devices request.
--pagination-token
(string)
The pagination token.
--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.
See ‘aws help’ for descriptions of global parameters.
To list devices for a user
This example lists devices for username jane@example.com.
Command:
aws cognito-idp admin-list-devices --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com
Devices -> (list)
The devices in the list of devices response.
(structure)
The device type.
DeviceKey -> (string)
The device key.
DeviceAttributes -> (list)
The device attributes.
(structure)
Specifies whether the attribute is standard or custom.
Name -> (string)
The name of the attribute.
Value -> (string)
The value of the attribute.
DeviceCreateDate -> (timestamp)
The creation date of the device.
DeviceLastModifiedDate -> (timestamp)
The last modified date of the device.
DeviceLastAuthenticatedDate -> (timestamp)
The date in which the device was last authenticated.
PaginationToken -> (string)
The pagination token.