Network.AWS.CognitoIdentityProvider.CreateGroup

Creates a new group in the specified user pool.

Requires developer credentials.

Creating a Request

createGroup

Arguments

:: Text

cgGroupName

-> Text

cgUserPoolId

-> CreateGroup

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

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

• cgPrecedence - 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.
• cgDescription - A string containing the description of the group.
• cgRoleARN - The role ARN for the group.
• cgGroupName - The name of the group. Must be unique.
• cgUserPoolId - The user pool ID for the user pool.

data CreateGroup

See: createGroup smart constructor.

Instances

Eq CreateGroup

Methods

(==) :: CreateGroup -> CreateGroup -> Bool

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

Data CreateGroup

Methods

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

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

toConstr :: CreateGroup -> Constr

dataTypeOf :: CreateGroup -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateGroup

Methods

readsPrec :: Int -> ReadS CreateGroup

readList :: ReadS [CreateGroup]

readPrec :: ReadPrec CreateGroup

readListPrec :: ReadPrec [CreateGroup]

Show CreateGroup

Methods

showsPrec :: Int -> CreateGroup -> ShowS

show :: CreateGroup -> String

showList :: [CreateGroup] -> ShowS

Generic CreateGroup

Associated Types

type Rep CreateGroup :: * -> *

Methods

from :: CreateGroup -> Rep CreateGroup x

to :: Rep CreateGroup x -> CreateGroup

Hashable CreateGroup

Methods

hashWithSalt :: Int -> CreateGroup -> Int

hash :: CreateGroup -> Int

ToJSON CreateGroup

Methods

toJSON :: CreateGroup -> Value

toEncoding :: CreateGroup -> Encoding

toJSONList :: [CreateGroup] -> Value

toEncodingList :: [CreateGroup] -> Encoding

NFData CreateGroup

Methods

rnf :: CreateGroup -> ()

AWSRequest CreateGroup

Associated Types

type Rs CreateGroup :: *

Methods

request :: CreateGroup -> Request CreateGroup

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

ToHeaders CreateGroup

Methods

toHeaders :: CreateGroup -> [Header]

ToPath CreateGroup

Methods

toPath :: CreateGroup -> ByteString

ToQuery CreateGroup

Methods

toQuery :: CreateGroup -> QueryString

type Rep CreateGroup

type Rep CreateGroup = D1 * (MetaData "CreateGroup" "Network.AWS.CognitoIdentityProvider.CreateGroup" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "CreateGroup'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cgPrecedence") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_cgDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cgRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cgGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cgUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs CreateGroup

type Rs CreateGroup = CreateGroupResponse

Request Lenses

cgPrecedence :: Lens' CreateGroup (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.

cgDescription :: Lens' CreateGroup (Maybe Text)

A string containing the description of the group.

cgRoleARN :: Lens' CreateGroup (Maybe Text)

The role ARN for the group.

cgGroupName :: Lens' CreateGroup Text

The name of the group. Must be unique.

cgUserPoolId :: Lens' CreateGroup Text

The user pool ID for the user pool.

Destructuring the Response

createGroupResponse

Arguments

:: Int

cgrsResponseStatus

-> CreateGroupResponse

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

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

• cgrsGroup - The group object for the group.
• cgrsResponseStatus - -- | The response status code.

data CreateGroupResponse

See: createGroupResponse smart constructor.

Instances

Eq CreateGroupResponse

Methods

(==) :: CreateGroupResponse -> CreateGroupResponse -> Bool

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

Data CreateGroupResponse

Methods

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

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

toConstr :: CreateGroupResponse -> Constr

dataTypeOf :: CreateGroupResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateGroupResponse

Methods

readsPrec :: Int -> ReadS CreateGroupResponse

readList :: ReadS [CreateGroupResponse]

readPrec :: ReadPrec CreateGroupResponse

readListPrec :: ReadPrec [CreateGroupResponse]

Show CreateGroupResponse

Methods

showsPrec :: Int -> CreateGroupResponse -> ShowS

show :: CreateGroupResponse -> String

showList :: [CreateGroupResponse] -> ShowS

Generic CreateGroupResponse

Associated Types

type Rep CreateGroupResponse :: * -> *

Methods

from :: CreateGroupResponse -> Rep CreateGroupResponse x

to :: Rep CreateGroupResponse x -> CreateGroupResponse

NFData CreateGroupResponse

Methods

rnf :: CreateGroupResponse -> ()

type Rep CreateGroupResponse

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

Response Lenses

cgrsGroup :: Lens' CreateGroupResponse (Maybe GroupType)

The group object for the group.

cgrsResponseStatus :: Lens' CreateGroupResponse Int

• - | The response status code.