Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Updates the specified group with the specified attributes.
Requires developer credentials.
- updateGroup :: Text -> Text -> UpdateGroup
- data UpdateGroup
- ugPrecedence :: Lens' UpdateGroup (Maybe Natural)
- ugDescription :: Lens' UpdateGroup (Maybe Text)
- ugRoleARN :: Lens' UpdateGroup (Maybe Text)
- ugGroupName :: Lens' UpdateGroup Text
- ugUserPoolId :: Lens' UpdateGroup Text
- updateGroupResponse :: Int -> UpdateGroupResponse
- data UpdateGroupResponse
- ugrsGroup :: Lens' UpdateGroupResponse (Maybe GroupType)
- ugrsResponseStatus :: Lens' UpdateGroupResponse Int
Creating a Request
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 thecognito:roles
andcognito:preferred_role
claims in the token.ugGroupName
- The name of the group.ugUserPoolId
- The user pool ID for the user pool.
data UpdateGroup Source #
See: updateGroup
smart constructor.
Request Lenses
ugPrecedence :: Lens' UpdateGroup (Maybe Natural) Source #
The new precedence value for the group. For more information about this parameter, see .
ugDescription :: Lens' UpdateGroup (Maybe Text) Source #
A string containing the new description of the group.
ugRoleARN :: Lens' UpdateGroup (Maybe Text) Source #
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 Source #
The name of the group.
ugUserPoolId :: Lens' UpdateGroup Text Source #
The user pool ID for the user pool.
Destructuring the Response
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 Source #
See: updateGroupResponse
smart constructor.
Response Lenses
ugrsResponseStatus :: Lens' UpdateGroupResponse Int Source #
- - | The response status code.