AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the AdminUpdateDeviceStatus operation. 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.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.AdminUpdateDeviceStatusRequest

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C# 
public class AdminUpdateDeviceStatusRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The AdminUpdateDeviceStatusRequest type exposes the following members

Constructors

NameDescription
Public Method AdminUpdateDeviceStatusRequest()

Properties

NameTypeDescription
Public Property DeviceKey System.String

Gets and sets the property DeviceKey.

The unique identifier, or device key, of the device that you want to update the status for.

Public Property DeviceRememberedStatus Amazon.CognitoIdentityProvider.DeviceRememberedStatusType

Gets and sets the property DeviceRememberedStatus.

To enable device authentication with the specified device, set to remembered.To disable, set to not_remembered.

Public Property Username System.String

Gets and sets the property Username.

The name 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.

Public Property UserPoolId System.String

Gets and sets the property UserPoolId.

The ID of the user pool where you want to change a user's device status.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5