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.CognitoIdentityProvider.UpdateGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the specified group with the specified attributes.

Calling this action requires developer credentials.

Synopsis

Creating a Request

data UpdateGroup Source #

See: newUpdateGroup smart constructor.

Constructors

UpdateGroup'

Fields

description :: Maybe Text
A string containing the new description of the group.
precedence :: Maybe Natural
The new precedence value for the group. For more information about this parameter, see CreateGroup.
roleArn :: Maybe Text
The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.
groupName :: Text
The name of the group.
userPoolId :: Text
The user pool ID for the user pool.

Instances

Instances details

ToJSON UpdateGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup Methods toJSON :: UpdateGroup -> Value # toEncoding :: UpdateGroup -> Encoding # toJSONList :: [UpdateGroup] -> Value # toEncodingList :: [UpdateGroup] -> Encoding #
ToHeaders UpdateGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup Methods toHeaders :: UpdateGroup -> [Header] #
ToPath UpdateGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup Methods toPath :: UpdateGroup -> ByteString #
ToQuery UpdateGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup Methods toQuery :: UpdateGroup -> QueryString #
AWSRequest UpdateGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup Associated Types type AWSResponse UpdateGroup # Methods request :: (Service -> Service) -> UpdateGroup -> Request UpdateGroup # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateGroup))) #
Generic UpdateGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup Associated Types type Rep UpdateGroup :: Type -> Type # Methods from :: UpdateGroup -> Rep UpdateGroup x # to :: Rep UpdateGroup x -> UpdateGroup #
Read UpdateGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup Methods readsPrec :: Int -> ReadS UpdateGroup # readList :: ReadS [UpdateGroup] # readPrec :: ReadPrec UpdateGroup # readListPrec :: ReadPrec [UpdateGroup] #
Show UpdateGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup Methods showsPrec :: Int -> UpdateGroup -> ShowS # show :: UpdateGroup -> String # showList :: [UpdateGroup] -> ShowS #
NFData UpdateGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup Methods rnf :: UpdateGroup -> () #
Eq UpdateGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup Methods (==) :: UpdateGroup -> UpdateGroup -> Bool # (/=) :: UpdateGroup -> UpdateGroup -> Bool #
Hashable UpdateGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup Methods hashWithSalt :: Int -> UpdateGroup -> Int # hash :: UpdateGroup -> Int #
type AWSResponse UpdateGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup type AWSResponse UpdateGroup = UpdateGroupResponse
type Rep UpdateGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup type Rep UpdateGroup = D1 ('MetaData "UpdateGroup" "Amazonka.CognitoIdentityProvider.UpdateGroup" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "UpdateGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "precedence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateGroup Source #

Arguments

:: Text	`UpdateGroup`
-> Text	`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:

UpdateGroup, updateGroup_description - A string containing the new description of the group.

UpdateGroup, updateGroup_precedence - The new precedence value for the group. For more information about this parameter, see CreateGroup.

UpdateGroup, updateGroup_roleArn - The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

UpdateGroup, updateGroup_groupName - The name of the group.

UpdateGroup, updateGroup_userPoolId - The user pool ID for the user pool.

Request Lenses

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

A string containing the new description of the group.

updateGroup_precedence :: Lens' UpdateGroup (Maybe Natural) Source #

The new precedence value for the group. For more information about this parameter, see CreateGroup.

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

The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

updateGroup_groupName :: Lens' UpdateGroup Text Source #

The name of the group.

updateGroup_userPoolId :: Lens' UpdateGroup Text Source #

The user pool ID for the user pool.

Destructuring the Response

data UpdateGroupResponse Source #

See: newUpdateGroupResponse smart constructor.

Constructors

UpdateGroupResponse'
Fields group' :: Maybe GroupType The group object for the group. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateGroupResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup Associated Types type Rep UpdateGroupResponse :: Type -> Type # Methods from :: UpdateGroupResponse -> Rep UpdateGroupResponse x # to :: Rep UpdateGroupResponse x -> UpdateGroupResponse #
Read UpdateGroupResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup Methods readsPrec :: Int -> ReadS UpdateGroupResponse # readList :: ReadS [UpdateGroupResponse] # readPrec :: ReadPrec UpdateGroupResponse # readListPrec :: ReadPrec [UpdateGroupResponse] #
Show UpdateGroupResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup Methods showsPrec :: Int -> UpdateGroupResponse -> ShowS # show :: UpdateGroupResponse -> String # showList :: [UpdateGroupResponse] -> ShowS #
NFData UpdateGroupResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup Methods rnf :: UpdateGroupResponse -> () #
Eq UpdateGroupResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup Methods (==) :: UpdateGroupResponse -> UpdateGroupResponse -> Bool # (/=) :: UpdateGroupResponse -> UpdateGroupResponse -> Bool #
type Rep UpdateGroupResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.UpdateGroup type Rep UpdateGroupResponse = D1 ('MetaData "UpdateGroupResponse" "Amazonka.CognitoIdentityProvider.UpdateGroup" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "UpdateGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "group'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GroupType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateGroupResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateGroupResponse'`
-> UpdateGroupResponse

Create a value of UpdateGroupResponse 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:group':UpdateGroupResponse', updateGroupResponse_group - The group object for the group.

$sel:httpStatus:UpdateGroupResponse', updateGroupResponse_httpStatus - The response's http status code.

Response Lenses

updateGroupResponse_group :: Lens' UpdateGroupResponse (Maybe GroupType) Source #

The group object for the group.

updateGroupResponse_httpStatus :: Lens' UpdateGroupResponse Int Source #

The response's http status code.