Class: Aws::CognitoIdentityProvider::Types::UpdateDeviceStatusRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Represents the request to update the device status.

Constant Summary collapse

SENSITIVE =
[:access_token]

Instance Attribute Summary collapse

Instance Attribute Details

#access_tokenString

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

Returns:

  • (String)


10744
10745
10746
10747
10748
10749
10750
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10744

class UpdateDeviceStatusRequest < Struct.new(
  :access_token,
  :device_key,
  :device_remembered_status)
  SENSITIVE = [:access_token]
  include Aws::Structure
end

#device_keyString

The device key of the device you want to update, for example us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

Returns:

  • (String)


10744
10745
10746
10747
10748
10749
10750
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10744

class UpdateDeviceStatusRequest < Struct.new(
  :access_token,
  :device_key,
  :device_remembered_status)
  SENSITIVE = [:access_token]
  include Aws::Structure
end

#device_remembered_statusString

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

Returns:

  • (String)


10744
10745
10746
10747
10748
10749
10750
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10744

class UpdateDeviceStatusRequest < Struct.new(
  :access_token,
  :device_key,
  :device_remembered_status)
  SENSITIVE = [:access_token]
  include Aws::Structure
end