libZSservicesZSamazonka-iamZSamazonka-iam
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IAM.UpdateUser

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

Creating a Request

data UpdateUser Source #

See: newUpdateUser smart constructor.

Constructors

UpdateUser' 

Fields

  • 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".

  • 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.

  • 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
Eq UpdateUser Source # 
Instance details

Defined in Amazonka.IAM.UpdateUser

Read UpdateUser Source # 
Instance details

Defined in Amazonka.IAM.UpdateUser

Show UpdateUser Source # 
Instance details

Defined in Amazonka.IAM.UpdateUser

Generic UpdateUser Source # 
Instance details

Defined in Amazonka.IAM.UpdateUser

Associated Types

type Rep UpdateUser :: Type -> Type #

NFData UpdateUser Source # 
Instance details

Defined in Amazonka.IAM.UpdateUser

Methods

rnf :: UpdateUser -> () #

Hashable UpdateUser Source # 
Instance details

Defined in Amazonka.IAM.UpdateUser

AWSRequest UpdateUser Source # 
Instance details

Defined in Amazonka.IAM.UpdateUser

Associated Types

type AWSResponse UpdateUser #

ToHeaders UpdateUser Source # 
Instance details

Defined in Amazonka.IAM.UpdateUser

Methods

toHeaders :: UpdateUser -> [Header] #

ToPath UpdateUser Source # 
Instance details

Defined in Amazonka.IAM.UpdateUser

ToQuery UpdateUser Source # 
Instance details

Defined in Amazonka.IAM.UpdateUser

type Rep UpdateUser Source # 
Instance details

Defined in Amazonka.IAM.UpdateUser

type Rep UpdateUser = D1 ('MetaData "UpdateUser" "Amazonka.IAM.UpdateUser" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "UpdateUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "newUserName'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "newPath'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateUser Source # 
Instance details

Defined in Amazonka.IAM.UpdateUser

newUpdateUser Source #

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: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".

$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:userName: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_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_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_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
Eq UpdateUserResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateUser

Read UpdateUserResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateUser

Show UpdateUserResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateUser

Generic UpdateUserResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateUser

Associated Types

type Rep UpdateUserResponse :: Type -> Type #

NFData UpdateUserResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateUser

Methods

rnf :: UpdateUserResponse -> () #

type Rep UpdateUserResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateUser

type Rep UpdateUserResponse = D1 ('MetaData "UpdateUserResponse" "Amazonka.IAM.UpdateUser" "libZSservicesZSamazonka-iamZSamazonka-iam" '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.