cognitoidentityprovider_admin_update_device_status: Updates the status of a user's device so that it is marked as...

In paws.security.identity: 'Amazon Web Services' Security, Identity, & Compliance Services

Updates the status of a user's device so that it is marked as remembered or not remembered for the purpose of device authentication

Description

Updates the status of a user's device so that it is marked as remembered or not remembered for the purpose of device authentication. Device authentication is a "remember me" mechanism that silently completes sign-in from trusted devices with a device key instead of a user-provided MFA code. This operation changes the status of a device without deleting it, so you can enable it again later. For more information about device authentication, see Working with devices.

See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_admin_update_device_status/ for full documentation.

Usage

cognitoidentityprovider_admin_update_device_status(
  UserPoolId,
  Username,
  DeviceKey,
  DeviceRememberedStatus = NULL
)

Arguments

UserPoolId	[required] The ID of the user pool where you want to change a user's device status.
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 unique identifier, or device key, of the device that you want to update the status for.
DeviceRememberedStatus	To enable device authentication with the specified device, set to remembered.To disable, set to not_remembered.

paws.security.identity documentation built on April 3, 2025, 10:59 p.m.