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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new group in the specified user pool.

Calling this action requires developer credentials.

Synopsis

Creating a Request

data CreateGroup Source #

See: newCreateGroup smart constructor.

Constructors

CreateGroup'

Fields

precedence :: Maybe Natural
A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens.
Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens.
The default Precedence value is null.
description :: Maybe Text
A string containing the description of the group.
roleArn :: Maybe Text
The role ARN for the group.
groupName :: Text
The name of the group. Must be unique.
userPoolId :: Text
The user pool ID for the user pool.

Instances

Instances details

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

newCreateGroup Source #

Arguments

:: Text	`$sel:groupName:CreateGroup'`
-> Text	`$sel:userPoolId:CreateGroup'`
-> CreateGroup

Create a value of CreateGroup 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:precedence:CreateGroup', createGroup_precedence - A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens.

The default Precedence value is null.

$sel:description:CreateGroup', createGroup_description - A string containing the description of the group.

$sel:roleArn:CreateGroup', createGroup_roleArn - The role ARN for the group.

$sel:groupName:CreateGroup', createGroup_groupName - The name of the group. Must be unique.

$sel:userPoolId:CreateGroup', createGroup_userPoolId - The user pool ID for the user pool.

Request Lenses

createGroup_precedence :: Lens' CreateGroup (Maybe Natural) Source #

A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens.

The default Precedence value is null.

createGroup_description :: Lens' CreateGroup (Maybe Text) Source #

A string containing the description of the group.

createGroup_roleArn :: Lens' CreateGroup (Maybe Text) Source #

The role ARN for the group.

createGroup_groupName :: Lens' CreateGroup Text Source #

The name of the group. Must be unique.

createGroup_userPoolId :: Lens' CreateGroup Text Source #

The user pool ID for the user pool.

Destructuring the Response

data CreateGroupResponse Source #

See: newCreateGroupResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateGroupResponse Source #

Arguments

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

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

$sel:httpStatus:CreateGroupResponse', createGroupResponse_httpStatus - The response's http status code.

Response Lenses

createGroupResponse_group :: Lens' CreateGroupResponse (Maybe GroupType) Source #

The group object for the group.

createGroupResponse_httpStatus :: Lens' CreateGroupResponse Int Source #

The response's http status code.