/ - Amazon Cognito Identity Provider

Gets the device, as an administrator.

Calling this action requires developer credentials.

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

{ "Device": { "DeviceKey": "string", "DeviceAttributes": [], "DeviceCreateDate": "string", "DeviceLastModifiedDate": "string", "DeviceLastAuthenticatedDate": "string" } }

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Represents the request to get the device, as an administrator.

DeviceKey

string

required

The device key.

>= 1 characters<= 55 characters

Match pattern:

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

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}]+

Examples

Responses

🟢200Success

application/json

Body

Gets the device response, as an administrator.

Device

object

required

The device.

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.

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482InvalidUserPoolConfigurationException

🟠483TooManyRequestsException

🟠484InternalErrorException

🟠485NotAuthorizedException