AdminListDevices
Lists devices, as an administrator.
Calling this action requires developer credentials.
Request Syntax
{ "Limit":number, "PaginationToken": "string", "Username": "string", "UserPoolId": "string" }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Limit
-
The limit of the devices request.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 60.
Required: No
- PaginationToken
-
The pagination token.
Type: String
Length Constraints: Minimum length of 1.
Pattern:
[\S]+Required: No
- Username
-
The user name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+Required: Yes
- UserPoolId
-
The user pool ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+Required: Yes
Response Syntax
{ "Devices": [ { "DeviceAttributes": [ { "Name": "string", "Value": "string" } ], "DeviceCreateDate": number, "DeviceKey": "string", "DeviceLastAuthenticatedDate": number, "DeviceLastModifiedDate": number } ], "PaginationToken": "string" }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Devices
-
The devices in the list of devices response.
Type: Array of DeviceType objects
- PaginationToken
-
The pagination token.
Type: String
Length Constraints: Minimum length of 1.
Pattern:
[\S]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
This exception is thrown when Amazon Cognito encounters an internal error.
HTTP Status Code: 500
- InvalidParameterException
-
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
HTTP Status Code: 400
- InvalidUserPoolConfigurationException
-
This exception is thrown when the user pool configuration is invalid.
HTTP Status Code: 400
- NotAuthorizedException
-
This exception is thrown when a user is not authorized.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service cannot find the requested resource.
HTTP Status Code: 400
- TooManyRequestsException
-
This exception is thrown when the user has made too many requests for a given operation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
