libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CognitoIdentityProvider.CreateGroup

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

Read CreateGroup Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateGroup

Show CreateGroup Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateGroup

Generic CreateGroup Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateGroup

Associated Types

type Rep CreateGroup :: Type -> Type #

NFData CreateGroup Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateGroup

Methods

rnf :: CreateGroup -> () #

Hashable CreateGroup Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateGroup

ToJSON CreateGroup Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateGroup

AWSRequest CreateGroup Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateGroup

Associated Types

type 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

ToQuery CreateGroup Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateGroup

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

newCreateGroup Source #

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

Instances

Instances details
Eq CreateGroupResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateGroup

Read CreateGroupResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateGroup

Show CreateGroupResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateGroup

Generic CreateGroupResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.CreateGroup

Associated Types

type Rep CreateGroupResponse :: Type -> Type #

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 #

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