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.

See Also:

Constant Summary collapse

SENSITIVE = 
[:username]

Instance Attribute Summary collapse

Instance Attribute Details

#device_key ⇒ String

The key of the device that you want to delete. You can get device IDs in the response to an [AdminListDevices] request.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListDevices.html

Returns:

  • (String) 


811
812
813
814
815
816
817
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 811

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

#user_pool_id ⇒ String

The ID of the user pool where the device owner is a user.

Returns:

  • (String) 


811
812
813
814
815
816
817
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 811

class AdminGetDeviceRequest < Struct.new(
  :device_key,
  :user_pool_id,
  :username)
  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) 


811
812
813
814
815
816
817
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 811

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