Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CognitoIdentityProvider.AdminAddUserToGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Adds the specified user to the specified group.

Calling this action requires developer credentials.

Creating a Request

data AdminAddUserToGroup Source #

See: newAdminAddUserToGroup smart constructor.

Constructors

AdminAddUserToGroup'
Fields userPoolId :: Text The user pool ID for the user pool. username :: Sensitive Text The username for the user. groupName :: Text The group name.

Instances

Instances details

ToJSON AdminAddUserToGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminAddUserToGroup Methods toJSON :: AdminAddUserToGroup -> Value # toEncoding :: AdminAddUserToGroup -> Encoding # toJSONList :: [AdminAddUserToGroup] -> Value # toEncodingList :: [AdminAddUserToGroup] -> Encoding #
ToHeaders AdminAddUserToGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminAddUserToGroup Methods toHeaders :: AdminAddUserToGroup -> [Header] #
ToPath AdminAddUserToGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminAddUserToGroup Methods toPath :: AdminAddUserToGroup -> ByteString #
ToQuery AdminAddUserToGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminAddUserToGroup Methods toQuery :: AdminAddUserToGroup -> QueryString #
AWSRequest AdminAddUserToGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminAddUserToGroup Associated Types type AWSResponse AdminAddUserToGroup # Methods request :: (Service -> Service) -> AdminAddUserToGroup -> Request AdminAddUserToGroup # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AdminAddUserToGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AdminAddUserToGroup))) #
Generic AdminAddUserToGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminAddUserToGroup Associated Types type Rep AdminAddUserToGroup :: Type -> Type # Methods from :: AdminAddUserToGroup -> Rep AdminAddUserToGroup x # to :: Rep AdminAddUserToGroup x -> AdminAddUserToGroup #
Show AdminAddUserToGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminAddUserToGroup Methods showsPrec :: Int -> AdminAddUserToGroup -> ShowS # show :: AdminAddUserToGroup -> String # showList :: [AdminAddUserToGroup] -> ShowS #
NFData AdminAddUserToGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminAddUserToGroup Methods rnf :: AdminAddUserToGroup -> () #
Eq AdminAddUserToGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminAddUserToGroup Methods (==) :: AdminAddUserToGroup -> AdminAddUserToGroup -> Bool # (/=) :: AdminAddUserToGroup -> AdminAddUserToGroup -> Bool #
Hashable AdminAddUserToGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminAddUserToGroup Methods hashWithSalt :: Int -> AdminAddUserToGroup -> Int # hash :: AdminAddUserToGroup -> Int #
type AWSResponse AdminAddUserToGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminAddUserToGroup type AWSResponse AdminAddUserToGroup = AdminAddUserToGroupResponse
type Rep AdminAddUserToGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminAddUserToGroup type Rep AdminAddUserToGroup = D1 ('MetaData "AdminAddUserToGroup" "Amazonka.CognitoIdentityProvider.AdminAddUserToGroup" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "AdminAddUserToGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :: S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newAdminAddUserToGroup Source #

Arguments

:: Text	`AdminAddUserToGroup`
-> Text	`AdminAddUserToGroup`
-> Text	`AdminAddUserToGroup`
-> AdminAddUserToGroup

Create a value of AdminAddUserToGroup 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:

AdminAddUserToGroup, adminAddUserToGroup_userPoolId - The user pool ID for the user pool.

AdminAddUserToGroup, adminAddUserToGroup_username - The username for the user.

AdminAddUserToGroup, adminAddUserToGroup_groupName - The group name.

Request Lenses

adminAddUserToGroup_userPoolId :: Lens' AdminAddUserToGroup Text Source #

The user pool ID for the user pool.

adminAddUserToGroup_username :: Lens' AdminAddUserToGroup Text Source #

The username for the user.

adminAddUserToGroup_groupName :: Lens' AdminAddUserToGroup Text Source #

The group name.

Destructuring the Response

data AdminAddUserToGroupResponse Source #

See: newAdminAddUserToGroupResponse smart constructor.

Constructors

AdminAddUserToGroupResponse'

Instances

Instances details

Generic AdminAddUserToGroupResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminAddUserToGroup Associated Types type Rep AdminAddUserToGroupResponse :: Type -> Type # Methods from :: AdminAddUserToGroupResponse -> Rep AdminAddUserToGroupResponse x # to :: Rep AdminAddUserToGroupResponse x -> AdminAddUserToGroupResponse #
Read AdminAddUserToGroupResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminAddUserToGroup Methods readsPrec :: Int -> ReadS AdminAddUserToGroupResponse # readList :: ReadS [AdminAddUserToGroupResponse] # readPrec :: ReadPrec AdminAddUserToGroupResponse # readListPrec :: ReadPrec [AdminAddUserToGroupResponse] #
Show AdminAddUserToGroupResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminAddUserToGroup Methods showsPrec :: Int -> AdminAddUserToGroupResponse -> ShowS # show :: AdminAddUserToGroupResponse -> String # showList :: [AdminAddUserToGroupResponse] -> ShowS #
NFData AdminAddUserToGroupResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminAddUserToGroup Methods rnf :: AdminAddUserToGroupResponse -> () #
Eq AdminAddUserToGroupResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminAddUserToGroup Methods (==) :: AdminAddUserToGroupResponse -> AdminAddUserToGroupResponse -> Bool # (/=) :: AdminAddUserToGroupResponse -> AdminAddUserToGroupResponse -> Bool #
type Rep AdminAddUserToGroupResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminAddUserToGroup type Rep AdminAddUserToGroupResponse = D1 ('MetaData "AdminAddUserToGroupResponse" "Amazonka.CognitoIdentityProvider.AdminAddUserToGroup" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "AdminAddUserToGroupResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newAdminAddUserToGroupResponse :: AdminAddUserToGroupResponse Source #

Create a value of AdminAddUserToGroupResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.