Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IAM.UpdateUser

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Updates the name and/or the path of the specified IAM user.

You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM user and Renaming an IAM group in the IAM User Guide.

To change a user name, the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and policies.

Synopsis

data UpdateUser = UpdateUser' {
- newPath' :: Maybe Text
- newUserName' :: Maybe Text
- userName :: Text
}
newUpdateUser :: Text -> UpdateUser
updateUser_newPath :: Lens' UpdateUser (Maybe Text)
updateUser_newUserName :: Lens' UpdateUser (Maybe Text)
updateUser_userName :: Lens' UpdateUser Text
data UpdateUserResponse = UpdateUserResponse' {
}
newUpdateUserResponse :: UpdateUserResponse

Creating a Request

data UpdateUser Source #

See: newUpdateUser smart constructor.

Constructors

UpdateUser'

Fields

newPath' :: Maybe Text
New path for the IAM user. Include this parameter only if you're changing the user's path.
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
newUserName' :: Maybe Text
New name for the user. Include this parameter only if you're changing the user's name.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
userName :: Text
Name of the user to update. If you're changing the name of the user, this is the original user name.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Instances

Instances details

ToHeaders UpdateUser Source #
Instance details Defined in Amazonka.IAM.UpdateUser Methods toHeaders :: UpdateUser -> [Header] #
ToPath UpdateUser Source #
Instance details Defined in Amazonka.IAM.UpdateUser Methods toPath :: UpdateUser -> ByteString #
ToQuery UpdateUser Source #
Instance details Defined in Amazonka.IAM.UpdateUser Methods toQuery :: UpdateUser -> QueryString #
AWSRequest UpdateUser Source #
Instance details Defined in Amazonka.IAM.UpdateUser Associated Types type AWSResponse UpdateUser # Methods request :: (Service -> Service) -> UpdateUser -> Request UpdateUser # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateUser))) #
Generic UpdateUser Source #
Instance details Defined in Amazonka.IAM.UpdateUser Associated Types type Rep UpdateUser :: Type -> Type # Methods from :: UpdateUser -> Rep UpdateUser x # to :: Rep UpdateUser x -> UpdateUser #
Read UpdateUser Source #
Instance details Defined in Amazonka.IAM.UpdateUser Methods readsPrec :: Int -> ReadS UpdateUser # readList :: ReadS [UpdateUser] # readPrec :: ReadPrec UpdateUser # readListPrec :: ReadPrec [UpdateUser] #
Show UpdateUser Source #
Instance details Defined in Amazonka.IAM.UpdateUser Methods showsPrec :: Int -> UpdateUser -> ShowS # show :: UpdateUser -> String # showList :: [UpdateUser] -> ShowS #
NFData UpdateUser Source #
Instance details Defined in Amazonka.IAM.UpdateUser Methods rnf :: UpdateUser -> () #
Eq UpdateUser Source #
Instance details Defined in Amazonka.IAM.UpdateUser Methods (==) :: UpdateUser -> UpdateUser -> Bool # (/=) :: UpdateUser -> UpdateUser -> Bool #
Hashable UpdateUser Source #
Instance details Defined in Amazonka.IAM.UpdateUser Methods hashWithSalt :: Int -> UpdateUser -> Int # hash :: UpdateUser -> Int #
type AWSResponse UpdateUser Source #
Instance details Defined in Amazonka.IAM.UpdateUser type AWSResponse UpdateUser = UpdateUserResponse
type Rep UpdateUser Source #
Instance details Defined in Amazonka.IAM.UpdateUser type Rep UpdateUser = D1 ('MetaData "UpdateUser" "Amazonka.IAM.UpdateUser" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "UpdateUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "newPath'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "newUserName'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateUser Source #

Arguments

:: Text	`UpdateUser`
-> UpdateUser

Create a value of UpdateUser 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:

$sel:newPath':UpdateUser', updateUser_newPath - New path for the IAM user. Include this parameter only if you're changing the user's path.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

$sel:newUserName':UpdateUser', updateUser_newUserName - New name for the user. Include this parameter only if you're changing the user's name.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

UpdateUser, updateUser_userName - Name of the user to update. If you're changing the name of the user, this is the original user name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Request Lenses

updateUser_newPath :: Lens' UpdateUser (Maybe Text) Source #

New path for the IAM user. Include this parameter only if you're changing the user's path.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

updateUser_newUserName :: Lens' UpdateUser (Maybe Text) Source #

New name for the user. Include this parameter only if you're changing the user's name.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

updateUser_userName :: Lens' UpdateUser Text Source #

Name of the user to update. If you're changing the name of the user, this is the original user name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Destructuring the Response

data UpdateUserResponse Source #

See: newUpdateUserResponse smart constructor.

Constructors

UpdateUserResponse'

Instances

Instances details

Generic UpdateUserResponse Source #
Instance details Defined in Amazonka.IAM.UpdateUser Associated Types type Rep UpdateUserResponse :: Type -> Type # Methods from :: UpdateUserResponse -> Rep UpdateUserResponse x # to :: Rep UpdateUserResponse x -> UpdateUserResponse #
Read UpdateUserResponse Source #
Instance details Defined in Amazonka.IAM.UpdateUser Methods readsPrec :: Int -> ReadS UpdateUserResponse # readList :: ReadS [UpdateUserResponse] # readPrec :: ReadPrec UpdateUserResponse # readListPrec :: ReadPrec [UpdateUserResponse] #
Show UpdateUserResponse Source #
Instance details Defined in Amazonka.IAM.UpdateUser Methods showsPrec :: Int -> UpdateUserResponse -> ShowS # show :: UpdateUserResponse -> String # showList :: [UpdateUserResponse] -> ShowS #
NFData UpdateUserResponse Source #
Instance details Defined in Amazonka.IAM.UpdateUser Methods rnf :: UpdateUserResponse -> () #
Eq UpdateUserResponse Source #
Instance details Defined in Amazonka.IAM.UpdateUser Methods (==) :: UpdateUserResponse -> UpdateUserResponse -> Bool # (/=) :: UpdateUserResponse -> UpdateUserResponse -> Bool #
type Rep UpdateUserResponse Source #
Instance details Defined in Amazonka.IAM.UpdateUser type Rep UpdateUserResponse = D1 ('MetaData "UpdateUserResponse" "Amazonka.IAM.UpdateUser" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "UpdateUserResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateUserResponse :: UpdateUserResponse Source #

Create a value of UpdateUserResponse with all optional fields omitted.

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