Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IAM.UpdateGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

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

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

The person making the request (the principal), must have permission to change the role group with the old name and the new name. For example, to change the group named Managers to MGRs, the principal must have a policy that allows them to update both groups. If the principal has permission to update the Managers group, but not the MGRs group, then the update fails. For more information about permissions, see Access management.

Synopsis

data UpdateGroup = UpdateGroup' {
- newGroupName' :: Maybe Text
- newPath' :: Maybe Text
- groupName :: Text
}
newUpdateGroup :: Text -> UpdateGroup
updateGroup_newGroupName :: Lens' UpdateGroup (Maybe Text)
updateGroup_newPath :: Lens' UpdateGroup (Maybe Text)
updateGroup_groupName :: Lens' UpdateGroup Text
data UpdateGroupResponse = UpdateGroupResponse' {
}
newUpdateGroupResponse :: UpdateGroupResponse

Creating a Request

data UpdateGroup Source #

See: newUpdateGroup smart constructor.

Constructors

UpdateGroup'

Fields

newGroupName' :: Maybe Text
New name for the IAM group. Only include this if changing the group'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 group. Only include this if changing the group'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.
groupName :: Text
Name of the IAM group to update. If you're changing the name of the group, this is the original 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 UpdateGroup Source #
Instance details Defined in Amazonka.IAM.UpdateGroup Methods (==) :: UpdateGroup -> UpdateGroup -> Bool # (/=) :: UpdateGroup -> UpdateGroup -> Bool #
Read UpdateGroup Source #
Instance details Defined in Amazonka.IAM.UpdateGroup Methods readsPrec :: Int -> ReadS UpdateGroup # readList :: ReadS [UpdateGroup] # readPrec :: ReadPrec UpdateGroup # readListPrec :: ReadPrec [UpdateGroup] #
Show UpdateGroup Source #
Instance details Defined in Amazonka.IAM.UpdateGroup Methods showsPrec :: Int -> UpdateGroup -> ShowS # show :: UpdateGroup -> String # showList :: [UpdateGroup] -> ShowS #
Generic UpdateGroup Source #
Instance details Defined in Amazonka.IAM.UpdateGroup Associated Types type Rep UpdateGroup :: Type -> Type # Methods from :: UpdateGroup -> Rep UpdateGroup x # to :: Rep UpdateGroup x -> UpdateGroup #
NFData UpdateGroup Source #
Instance details Defined in Amazonka.IAM.UpdateGroup Methods rnf :: UpdateGroup -> () #
Hashable UpdateGroup Source #
Instance details Defined in Amazonka.IAM.UpdateGroup Methods hashWithSalt :: Int -> UpdateGroup -> Int # hash :: UpdateGroup -> Int #
AWSRequest UpdateGroup Source #
Instance details Defined in Amazonka.IAM.UpdateGroup Associated Types type AWSResponse UpdateGroup # Methods request :: UpdateGroup -> Request UpdateGroup # response :: MonadResource m => Logger -> Service -> Proxy UpdateGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateGroup))) #
ToHeaders UpdateGroup Source #
Instance details Defined in Amazonka.IAM.UpdateGroup Methods toHeaders :: UpdateGroup -> [Header] #
ToPath UpdateGroup Source #
Instance details Defined in Amazonka.IAM.UpdateGroup Methods toPath :: UpdateGroup -> ByteString #
ToQuery UpdateGroup Source #
Instance details Defined in Amazonka.IAM.UpdateGroup Methods toQuery :: UpdateGroup -> QueryString #
type Rep UpdateGroup Source #
Instance details Defined in Amazonka.IAM.UpdateGroup type Rep UpdateGroup = D1 ('MetaData "UpdateGroup" "Amazonka.IAM.UpdateGroup" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "UpdateGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "newGroupName'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "newPath'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateGroup Source #
Instance details Defined in Amazonka.IAM.UpdateGroup type AWSResponse UpdateGroup = UpdateGroupResponse

newUpdateGroup Source #

Arguments

:: Text	`$sel:groupName:UpdateGroup'`
-> UpdateGroup

Create a value of UpdateGroup 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:newGroupName':UpdateGroup', updateGroup_newGroupName - New name for the IAM group. Only include this if changing the group'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':UpdateGroup', updateGroup_newPath - New path for the IAM group. Only include this if changing the group'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:groupName:UpdateGroup', updateGroup_groupName - Name of the IAM group to update. If you're changing the name of the group, this is the original 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

updateGroup_newGroupName :: Lens' UpdateGroup (Maybe Text) Source #

New name for the IAM group. Only include this if changing the group'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".

updateGroup_newPath :: Lens' UpdateGroup (Maybe Text) Source #

New path for the IAM group. Only include this if changing the group'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.

updateGroup_groupName :: Lens' UpdateGroup Text Source #

Name of the IAM group to update. If you're changing the name of the group, this is the original 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 UpdateGroupResponse Source #

See: newUpdateGroupResponse smart constructor.

Constructors

UpdateGroupResponse'

Instances

Instances details

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

newUpdateGroupResponse :: UpdateGroupResponse Source #

Create a value of UpdateGroupResponse with all optional fields omitted.

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