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

Class: Aws::CognitoIdentityProvider::Types::GetUserResponse

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

Overview

Represents the response from the server from the request to get information about the user.

Instance Attribute Summary collapse

Instance Attribute Details

#mfa_optionsArray<Types::MFAOptionType>

Specifies the options for MFA (e.g., email or phone number).

Returns:



4026
4027
4028
4029
4030
4031
4032
4033
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4026

class GetUserResponse < Struct.new(
  :username,
  :user_attributes,
  :mfa_options,
  :preferred_mfa_setting,
  :user_mfa_setting_list)
  include Aws::Structure
end

#preferred_mfa_settingString

The user's preferred MFA setting.

Returns:

  • (String)


4026
4027
4028
4029
4030
4031
4032
4033
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4026

class GetUserResponse < Struct.new(
  :username,
  :user_attributes,
  :mfa_options,
  :preferred_mfa_setting,
  :user_mfa_setting_list)
  include Aws::Structure
end

#user_attributesArray<Types::AttributeType>

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Returns:



4026
4027
4028
4029
4030
4031
4032
4033
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4026

class GetUserResponse < Struct.new(
  :username,
  :user_attributes,
  :mfa_options,
  :preferred_mfa_setting,
  :user_mfa_setting_list)
  include Aws::Structure
end

#user_mfa_setting_listArray<String>

The list of the user's MFA settings.

Returns:

  • (Array<String>)


4026
4027
4028
4029
4030
4031
4032
4033
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4026

class GetUserResponse < Struct.new(
  :username,
  :user_attributes,
  :mfa_options,
  :preferred_mfa_setting,
  :user_mfa_setting_list)
  include Aws::Structure
end

#usernameString

The user name of the user you wish to retrieve from the get user request.

Returns:

  • (String)


4026
4027
4028
4029
4030
4031
4032
4033
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4026

class GetUserResponse < Struct.new(
  :username,
  :user_attributes,
  :mfa_options,
  :preferred_mfa_setting,
  :user_mfa_setting_list)
  include Aws::Structure
end