Class: Aws::CognitoIdentityProvider::Types::AdminGetUserRequest

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

Overview

Represents the request to get the specified user as an administrator.

See Also:

Constant Summary collapse

SENSITIVE = 
[:username]

Instance Attribute Summary collapse

Instance Attribute Details

#user_pool_id ⇒ String

The ID of the user pool where you want to get information about the user.

Returns:

  • (String) 


774
775
776
777
778
779
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 774

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

#username ⇒ String

The name 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) 


774
775
776
777
778
779
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 774

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