Amazonka.CognitoIdentityProvider.AdminGetUser

Gets the specified user by user name in a user pool as an administrator. Works on any user.

Calling this action requires developer credentials.

Creating a Request

data AdminGetUser

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

See: newAdminGetUser smart constructor.

Constructors

AdminGetUser'

Fields

• userPoolId :: Text

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

• username :: Sensitive Text

  The user name of the user you want to retrieve.

Instances

ToJSON AdminGetUser

Defined in Amazonka.CognitoIdentityProvider.AdminGetUser

Methods

toJSON :: AdminGetUser -> Value

toEncoding :: AdminGetUser -> Encoding

toJSONList :: [AdminGetUser] -> Value

toEncodingList :: [AdminGetUser] -> Encoding

ToHeaders AdminGetUser

Defined in Amazonka.CognitoIdentityProvider.AdminGetUser

Methods

toHeaders :: AdminGetUser -> [Header]

ToPath AdminGetUser

Defined in Amazonka.CognitoIdentityProvider.AdminGetUser

Methods

toPath :: AdminGetUser -> ByteString

ToQuery AdminGetUser

Defined in Amazonka.CognitoIdentityProvider.AdminGetUser

Methods

toQuery :: AdminGetUser -> QueryString

AWSRequest AdminGetUser

Defined in Amazonka.CognitoIdentityProvider.AdminGetUser

Associated Types

type AWSResponse AdminGetUser

Methods

request :: (Service -> Service) -> AdminGetUser -> Request AdminGetUser

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AdminGetUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AdminGetUser)))

Generic AdminGetUser

Defined in Amazonka.CognitoIdentityProvider.AdminGetUser

Associated Types

type Rep AdminGetUser :: Type -> Type

Methods

from :: AdminGetUser -> Rep AdminGetUser x

to :: Rep AdminGetUser x -> AdminGetUser

Show AdminGetUser

Defined in Amazonka.CognitoIdentityProvider.AdminGetUser

Methods

showsPrec :: Int -> AdminGetUser -> ShowS

show :: AdminGetUser -> String

showList :: [AdminGetUser] -> ShowS

NFData AdminGetUser

Defined in Amazonka.CognitoIdentityProvider.AdminGetUser

Methods

rnf :: AdminGetUser -> ()

Eq AdminGetUser

Defined in Amazonka.CognitoIdentityProvider.AdminGetUser

Methods

(==) :: AdminGetUser -> AdminGetUser -> Bool

(/=) :: AdminGetUser -> AdminGetUser -> Bool

Hashable AdminGetUser

Defined in Amazonka.CognitoIdentityProvider.AdminGetUser

Methods

hashWithSalt :: Int -> AdminGetUser -> Int

hash :: AdminGetUser -> Int

type AWSResponse AdminGetUser

Defined in Amazonka.CognitoIdentityProvider.AdminGetUser

type AWSResponse AdminGetUser = AdminGetUserResponse

type Rep AdminGetUser

Defined in Amazonka.CognitoIdentityProvider.AdminGetUser

type Rep AdminGetUser = D1 ('MetaData "AdminGetUser" "Amazonka.CognitoIdentityProvider.AdminGetUser" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "AdminGetUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))

newAdminGetUser

Arguments

:: Text

AdminGetUser

-> Text

AdminGetUser

-> AdminGetUser

Create a value of AdminGetUser with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

AdminGetUser, adminGetUser_userPoolId - The user pool ID for the user pool where you want to get information about the user.

AdminGetUser, adminGetUser_username - The user name of the user you want to retrieve.

Request Lenses

adminGetUser_userPoolId :: Lens' AdminGetUser Text

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

adminGetUser_username :: Lens' AdminGetUser Text

The user name of the user you want to retrieve.

Destructuring the Response

data AdminGetUserResponse

Represents the response from the server from the request to get the specified user as an administrator.

See: newAdminGetUserResponse smart constructor.

Constructors

AdminGetUserResponse'

Fields

• enabled :: Maybe Bool

  Indicates that the status is enabled.

• mfaOptions :: Maybe [MFAOptionType]

  This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

• preferredMfaSetting :: Maybe Text

  The user's preferred MFA setting.

• userAttributes :: Maybe [AttributeType]

  An array of name-value pairs representing user attributes.

• userCreateDate :: Maybe POSIX

  The date the user was created.

• userLastModifiedDate :: Maybe POSIX

  The date the user was last modified.

• userMFASettingList :: Maybe [Text]

  The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

• userStatus :: Maybe UserStatusType

  The user status. Can be one of the following:

  • UNCONFIRMED - User has been created but not confirmed.
  • CONFIRMED - User has been confirmed.
  • ARCHIVED - User is no longer active.
  • UNKNOWN - User status isn't known.
  • RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
  • FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
• httpStatus :: Int

  The response's http status code.

• username :: Sensitive Text

  The user name of the user about whom you're receiving information.

Instances

Generic AdminGetUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminGetUser

Associated Types

type Rep AdminGetUserResponse :: Type -> Type

Methods

from :: AdminGetUserResponse -> Rep AdminGetUserResponse x

to :: Rep AdminGetUserResponse x -> AdminGetUserResponse

Show AdminGetUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminGetUser

Methods

showsPrec :: Int -> AdminGetUserResponse -> ShowS

show :: AdminGetUserResponse -> String

showList :: [AdminGetUserResponse] -> ShowS

NFData AdminGetUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminGetUser

Methods

rnf :: AdminGetUserResponse -> ()

Eq AdminGetUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminGetUser

Methods

(==) :: AdminGetUserResponse -> AdminGetUserResponse -> Bool

(/=) :: AdminGetUserResponse -> AdminGetUserResponse -> Bool

type Rep AdminGetUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminGetUser

type Rep AdminGetUserResponse = D1 ('MetaData "AdminGetUserResponse" "Amazonka.CognitoIdentityProvider.AdminGetUser" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "AdminGetUserResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "mfaOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MFAOptionType]))) :*: (S1 ('MetaSel ('Just "preferredMfaSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "userAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttributeType])) :*: S1 ('MetaSel ('Just "userCreateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "userLastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "userMFASettingList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "userStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserStatusType)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))))

newAdminGetUserResponse

Arguments

:: Int

$sel:httpStatus:AdminGetUserResponse'

-> Text

AdminGetUser

-> AdminGetUserResponse

Create a value of AdminGetUserResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

AdminGetUserResponse, adminGetUserResponse_enabled - Indicates that the status is enabled.

AdminGetUserResponse, adminGetUserResponse_mfaOptions - This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

$sel:preferredMfaSetting:AdminGetUserResponse', adminGetUserResponse_preferredMfaSetting - The user's preferred MFA setting.

$sel:userAttributes:AdminGetUserResponse', adminGetUserResponse_userAttributes - An array of name-value pairs representing user attributes.

AdminGetUserResponse, adminGetUserResponse_userCreateDate - The date the user was created.

AdminGetUserResponse, adminGetUserResponse_userLastModifiedDate - The date the user was last modified.

$sel:userMFASettingList:AdminGetUserResponse', adminGetUserResponse_userMFASettingList - The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

AdminGetUserResponse, adminGetUserResponse_userStatus - The user status. Can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.
• CONFIRMED - User has been confirmed.
• ARCHIVED - User is no longer active.
• UNKNOWN - User status isn't known.
• RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.

$sel:httpStatus:AdminGetUserResponse', adminGetUserResponse_httpStatus - The response's http status code.

AdminGetUser, adminGetUserResponse_username - The user name of the user about whom you're receiving information.

Response Lenses

adminGetUserResponse_enabled :: Lens' AdminGetUserResponse (Maybe Bool)

Indicates that the status is enabled.

adminGetUserResponse_mfaOptions :: Lens' AdminGetUserResponse (Maybe [MFAOptionType])

This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

adminGetUserResponse_preferredMfaSetting :: Lens' AdminGetUserResponse (Maybe Text)

The user's preferred MFA setting.

adminGetUserResponse_userAttributes :: Lens' AdminGetUserResponse (Maybe [AttributeType])

An array of name-value pairs representing user attributes.

adminGetUserResponse_userCreateDate :: Lens' AdminGetUserResponse (Maybe UTCTime)

The date the user was created.

adminGetUserResponse_userLastModifiedDate :: Lens' AdminGetUserResponse (Maybe UTCTime)

The date the user was last modified.

adminGetUserResponse_userMFASettingList :: Lens' AdminGetUserResponse (Maybe [Text])

The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

adminGetUserResponse_userStatus :: Lens' AdminGetUserResponse (Maybe UserStatusType)

The user status. Can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.
• CONFIRMED - User has been confirmed.
• ARCHIVED - User is no longer active.
• UNKNOWN - User status isn't known.
• RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.

adminGetUserResponse_httpStatus :: Lens' AdminGetUserResponse Int

The response's http status code.

adminGetUserResponse_username :: Lens' AdminGetUserResponse Text

The user name of the user about whom you're receiving information.