You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass AdminUpdateDeviceStatusRequest data as a hash:

{
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  device_key: "DeviceKeyType", # required
  device_remembered_status: "remembered", # accepts remembered, not_remembered
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#device_keyString

The device key.

Returns:

  • (String)


1674
1675
1676
1677
1678
1679
1680
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1674

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

#device_remembered_statusString

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

Returns:

  • (String)


1674
1675
1676
1677
1678
1679
1680
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1674

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

#user_pool_idString

The user pool ID.

Returns:

  • (String)


1674
1675
1676
1677
1678
1679
1680
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1674

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

#usernameString

The user name.

Returns:

  • (String)


1674
1675
1676
1677
1678
1679
1680
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1674

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