Skip to content

Update Device Status

cognitoidentityprovider_update_device_status R Documentation

Updates the device status

Description

Updates the device status. For more information about device authentication, see Working with user devices in your user pool.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

Usage

cognitoidentityprovider_update_device_status(AccessToken, DeviceKey,
  DeviceRememberedStatus)

Arguments

AccessToken

[required] A valid access token that Amazon Cognito issued to the user whose device status you want to update.

DeviceKey

[required] The device key.

DeviceRememberedStatus

The status of whether a device is remembered.

Value

An empty list.

Request syntax

svc$update_device_status(
  AccessToken = "string",
  DeviceKey = "string",
  DeviceRememberedStatus = "remembered"|"not_remembered"
)