Admin Update Device Status

cognitoidentityprovider_admin_update_device_status

R Documentation

Updates the device status as an administrator

Description

Updates the device status as an administrator.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Usage

cognitoidentityprovider_admin_update_device_status(UserPoolId, Username,
  DeviceKey, DeviceRememberedStatus)

Arguments

UserPoolId

[required] The user pool ID.

Username

[required] The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

DeviceKey

[required] The device key.

DeviceRememberedStatus

The status indicating whether a device has been remembered or not.

Value

An empty list.

Request syntax

svc$admin_update_device_status(
  UserPoolId = "string",
  Username = "string",
  DeviceKey = "string",
  DeviceRememberedStatus = "remembered"|"not_remembered"
)