/ - Amazon Cognito Identity Provider

Lists devices, as an administrator.

Calling this action requires developer credentials.

curl --location --request POST '/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "UserPoolId": "string", "Username": "string", "Limit": 0, "PaginationToken": "string" }'

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Represents the request to list devices, as an administrator.

UserPoolId

string

required

The user pool ID.

>= 1 characters<= 55 characters

Match pattern:

[\w-]+_[0-9a-zA-Z]+

Username

string <password>

required

The user name.

>= 1 characters<= 128 characters

Match pattern:

[\p{L}\p{M}\p{S}\p{N}\p{P}]+

Limit

integer

optional

The limit of the devices request.

>= 0<= 60

PaginationToken

string

optional

The pagination token.

>= 1 characters

Match pattern:

[\S]+

Examples

Responses

🟢200Success

application/json

Body

Lists the device's response, as an administrator.

Devices

array[object (DeviceType) {5}]

optional

The devices in the list of devices response.

DeviceKey

string

optional

The device key.

>= 1 characters<= 55 characters

Match pattern:

[\w-]+_[0-9a-f-]+

DeviceAttributes

array[object (AttributeType) {2}]

optional

The device attributes.

DeviceCreateDate

string <date-time>

optional

The creation date of the device.

DeviceLastModifiedDate

string <date-time>

optional

The last modified date of the device.

DeviceLastAuthenticatedDate

string <date-time>

optional

The date when the device was last authenticated.

PaginationToken

string

optional

The pagination token.

>= 1 characters

Match pattern:

[\S]+

🟠480InvalidParameterException

🟠481ResourceNotFoundException

🟠482InvalidUserPoolConfigurationException

🟠483TooManyRequestsException

🟠484InternalErrorException

🟠485NotAuthorizedException