Class: Aws::CognitoIdentityProvider::Types::AdminUpdateDeviceStatusRequest

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::AdminUpdateDeviceStatusRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The request to update the device status, as an administrator.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:username]

Instance Attribute Summary

• #device_key ⇒ String

  The device key.

• #device_remembered_status ⇒ String

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

• #user_pool_id ⇒ String

  The user pool ID.

• #username ⇒ String

  The username of the user that you want to query or modify.

Instance Attribute Details

#device_key ⇒ String

The device key.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1855

class AdminUpdateDeviceStatusRequest < Struct.new(
  :user_pool_id,
  :username,
  :device_key,
  :device_remembered_status)
  SENSITIVE = [:username]
  include Aws::Structure
end

#device_remembered_status ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1855

class AdminUpdateDeviceStatusRequest < Struct.new(
  :user_pool_id,
  :username,
  :device_key,
  :device_remembered_status)
  SENSITIVE = [:username]
  include Aws::Structure
end

#user_pool_id ⇒ String

The user pool ID.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1855

class AdminUpdateDeviceStatusRequest < Struct.new(
  :user_pool_id,
  :username,
  :device_key,
  :device_remembered_status)
  SENSITIVE = [:username]
  include Aws::Structure
end

#username ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1855

class AdminUpdateDeviceStatusRequest < Struct.new(
  :user_pool_id,
  :username,
  :device_key,
  :device_remembered_status)
  SENSITIVE = [:username]
  include Aws::Structure
end