Network.AWS.CognitoIdentityProvider.UpdateGroup

Updates the specified group with the specified attributes.

Requires developer credentials.

Creating a Request

updateGroup

Arguments

:: Text

ugGroupName

-> Text

ugUserPoolId

-> UpdateGroup

Creates a value of UpdateGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ugPrecedence - The new precedence value for the group. For more information about this parameter, see .
• ugDescription - A string containing the new description of the group.
• ugRoleARN - The new role ARN for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.
• ugGroupName - The name of the group.
• ugUserPoolId - The user pool ID for the user pool.

data UpdateGroup

See: updateGroup smart constructor.

Instances

Eq UpdateGroup

Methods

(==) :: UpdateGroup -> UpdateGroup -> Bool

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

Data UpdateGroup

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateGroup -> c UpdateGroup

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateGroup

toConstr :: UpdateGroup -> Constr

dataTypeOf :: UpdateGroup -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateGroup)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateGroup)

gmapT :: (forall b. Data b => b -> b) -> UpdateGroup -> UpdateGroup

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateGroup -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateGroup -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateGroup -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateGroup -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateGroup -> m UpdateGroup

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateGroup -> m UpdateGroup

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateGroup -> m UpdateGroup

Read UpdateGroup

Methods

readsPrec :: Int -> ReadS UpdateGroup

readList :: ReadS [UpdateGroup]

readPrec :: ReadPrec UpdateGroup

readListPrec :: ReadPrec [UpdateGroup]

Show UpdateGroup

Methods

showsPrec :: Int -> UpdateGroup -> ShowS

show :: UpdateGroup -> String

showList :: [UpdateGroup] -> ShowS

Generic UpdateGroup

Associated Types

type Rep UpdateGroup :: * -> *

Methods

from :: UpdateGroup -> Rep UpdateGroup x

to :: Rep UpdateGroup x -> UpdateGroup

Hashable UpdateGroup

Methods

hashWithSalt :: Int -> UpdateGroup -> Int

hash :: UpdateGroup -> Int

ToJSON UpdateGroup

Methods

toJSON :: UpdateGroup -> Value

toEncoding :: UpdateGroup -> Encoding

toJSONList :: [UpdateGroup] -> Value

toEncodingList :: [UpdateGroup] -> Encoding

NFData UpdateGroup

Methods

rnf :: UpdateGroup -> ()

AWSRequest UpdateGroup

Associated Types

type Rs UpdateGroup :: *

Methods

request :: UpdateGroup -> Request UpdateGroup

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * UpdateGroup -> ClientResponse -> m (Response UpdateGroup)

ToHeaders UpdateGroup

Methods

toHeaders :: UpdateGroup -> [Header]

ToPath UpdateGroup

Methods

toPath :: UpdateGroup -> ByteString

ToQuery UpdateGroup

Methods

toQuery :: UpdateGroup -> QueryString

type Rep UpdateGroup

type Rep UpdateGroup = D1 * (MetaData "UpdateGroup" "Network.AWS.CognitoIdentityProvider.UpdateGroup" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "UpdateGroup'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ugPrecedence") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_ugDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ugRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ugGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_ugUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs UpdateGroup

type Rs UpdateGroup = UpdateGroupResponse

Request Lenses

ugPrecedence :: Lens' UpdateGroup (Maybe Natural)

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

ugDescription :: Lens' UpdateGroup (Maybe Text)

A string containing the new description of the group.

ugRoleARN :: Lens' UpdateGroup (Maybe Text)

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

ugGroupName :: Lens' UpdateGroup Text

The name of the group.

ugUserPoolId :: Lens' UpdateGroup Text

The user pool ID for the user pool.

Destructuring the Response

updateGroupResponse

Arguments

:: Int

ugrsResponseStatus

-> UpdateGroupResponse

Creates a value of UpdateGroupResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ugrsGroup - The group object for the group.
• ugrsResponseStatus - -- | The response status code.

data UpdateGroupResponse

See: updateGroupResponse smart constructor.

Instances

Eq UpdateGroupResponse

Methods

(==) :: UpdateGroupResponse -> UpdateGroupResponse -> Bool

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

Data UpdateGroupResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateGroupResponse -> c UpdateGroupResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateGroupResponse

toConstr :: UpdateGroupResponse -> Constr

dataTypeOf :: UpdateGroupResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateGroupResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateGroupResponse)

gmapT :: (forall b. Data b => b -> b) -> UpdateGroupResponse -> UpdateGroupResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateGroupResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateGroupResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateGroupResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateGroupResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateGroupResponse -> m UpdateGroupResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateGroupResponse -> m UpdateGroupResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateGroupResponse -> m UpdateGroupResponse

Read UpdateGroupResponse

Methods

readsPrec :: Int -> ReadS UpdateGroupResponse

readList :: ReadS [UpdateGroupResponse]

readPrec :: ReadPrec UpdateGroupResponse

readListPrec :: ReadPrec [UpdateGroupResponse]

Show UpdateGroupResponse

Methods

showsPrec :: Int -> UpdateGroupResponse -> ShowS

show :: UpdateGroupResponse -> String

showList :: [UpdateGroupResponse] -> ShowS

Generic UpdateGroupResponse

Associated Types

type Rep UpdateGroupResponse :: * -> *

Methods

from :: UpdateGroupResponse -> Rep UpdateGroupResponse x

to :: Rep UpdateGroupResponse x -> UpdateGroupResponse

NFData UpdateGroupResponse

Methods

rnf :: UpdateGroupResponse -> ()

type Rep UpdateGroupResponse

type Rep UpdateGroupResponse = D1 * (MetaData "UpdateGroupResponse" "Network.AWS.CognitoIdentityProvider.UpdateGroup" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "UpdateGroupResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ugrsGroup") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe GroupType))) (S1 * (MetaSel (Just Symbol "_ugrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

ugrsGroup :: Lens' UpdateGroupResponse (Maybe GroupType)

The group object for the group.

ugrsResponseStatus :: Lens' UpdateGroupResponse Int

• - | The response status code.