Class: Aws::CognitoIdentityProvider::Types::AdminGetDeviceRequest

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

Overview

Represents the request to get the device, as an administrator.

Constant Summary collapse

SENSITIVE =
[:username]

Instance Attribute Summary collapse

Instance Attribute Details

#device_keyString

The device key.

Returns:

  • (String)


661
662
663
664
665
666
667
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 661

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

#user_pool_idString

The user pool ID.

Returns:

  • (String)


661
662
663
664
665
666
667
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 661

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

#usernameString

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)


661
662
663
664
665
666
667
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 661

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