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.AdminRemoveUserFromGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Removes the specified user from the specified group.

Calling this action requires developer credentials.

Creating a Request

data AdminRemoveUserFromGroup Source #

See: newAdminRemoveUserFromGroup smart constructor.

Constructors

AdminRemoveUserFromGroup'
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

Eq AdminRemoveUserFromGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminRemoveUserFromGroup Methods (==) :: AdminRemoveUserFromGroup -> AdminRemoveUserFromGroup -> Bool # (/=) :: AdminRemoveUserFromGroup -> AdminRemoveUserFromGroup -> Bool #
Show AdminRemoveUserFromGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminRemoveUserFromGroup Methods showsPrec :: Int -> AdminRemoveUserFromGroup -> ShowS # show :: AdminRemoveUserFromGroup -> String # showList :: [AdminRemoveUserFromGroup] -> ShowS #
Generic AdminRemoveUserFromGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminRemoveUserFromGroup Associated Types type Rep AdminRemoveUserFromGroup :: Type -> Type # Methods from :: AdminRemoveUserFromGroup -> Rep AdminRemoveUserFromGroup x # to :: Rep AdminRemoveUserFromGroup x -> AdminRemoveUserFromGroup #
NFData AdminRemoveUserFromGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminRemoveUserFromGroup Methods rnf :: AdminRemoveUserFromGroup -> () #
Hashable AdminRemoveUserFromGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminRemoveUserFromGroup Methods hashWithSalt :: Int -> AdminRemoveUserFromGroup -> Int # hash :: AdminRemoveUserFromGroup -> Int #
ToJSON AdminRemoveUserFromGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminRemoveUserFromGroup Methods toJSON :: AdminRemoveUserFromGroup -> Value # toEncoding :: AdminRemoveUserFromGroup -> Encoding # toJSONList :: [AdminRemoveUserFromGroup] -> Value # toEncodingList :: [AdminRemoveUserFromGroup] -> Encoding #
AWSRequest AdminRemoveUserFromGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminRemoveUserFromGroup Associated Types type AWSResponse AdminRemoveUserFromGroup # Methods request :: AdminRemoveUserFromGroup -> Request AdminRemoveUserFromGroup # response :: MonadResource m => Logger -> Service -> Proxy AdminRemoveUserFromGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AdminRemoveUserFromGroup))) #
ToHeaders AdminRemoveUserFromGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminRemoveUserFromGroup Methods toHeaders :: AdminRemoveUserFromGroup -> [Header] #
ToPath AdminRemoveUserFromGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminRemoveUserFromGroup Methods toPath :: AdminRemoveUserFromGroup -> ByteString #
ToQuery AdminRemoveUserFromGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminRemoveUserFromGroup Methods toQuery :: AdminRemoveUserFromGroup -> QueryString #
type Rep AdminRemoveUserFromGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminRemoveUserFromGroup type Rep AdminRemoveUserFromGroup = D1 ('MetaData "AdminRemoveUserFromGroup" "Amazonka.CognitoIdentityProvider.AdminRemoveUserFromGroup" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "AdminRemoveUserFromGroup'" '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))))
type AWSResponse AdminRemoveUserFromGroup Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminRemoveUserFromGroup type AWSResponse AdminRemoveUserFromGroup = AdminRemoveUserFromGroupResponse

newAdminRemoveUserFromGroup Source #

Arguments

:: Text	`$sel:userPoolId:AdminRemoveUserFromGroup'`
-> Text	`$sel:username:AdminRemoveUserFromGroup'`
-> Text	`$sel:groupName:AdminRemoveUserFromGroup'`
-> AdminRemoveUserFromGroup

Create a value of AdminRemoveUserFromGroup 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:userPoolId:AdminRemoveUserFromGroup', adminRemoveUserFromGroup_userPoolId - The user pool ID for the user pool.

$sel:username:AdminRemoveUserFromGroup', adminRemoveUserFromGroup_username - The username for the user.

$sel:groupName:AdminRemoveUserFromGroup', adminRemoveUserFromGroup_groupName - The group name.

Request Lenses

adminRemoveUserFromGroup_userPoolId :: Lens' AdminRemoveUserFromGroup Text Source #

The user pool ID for the user pool.

adminRemoveUserFromGroup_username :: Lens' AdminRemoveUserFromGroup Text Source #

The username for the user.

adminRemoveUserFromGroup_groupName :: Lens' AdminRemoveUserFromGroup Text Source #

The group name.

Destructuring the Response

data AdminRemoveUserFromGroupResponse Source #

See: newAdminRemoveUserFromGroupResponse smart constructor.

Constructors

AdminRemoveUserFromGroupResponse'

Instances

Instances details

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

newAdminRemoveUserFromGroupResponse :: AdminRemoveUserFromGroupResponse Source #

Create a value of AdminRemoveUserFromGroupResponse with all optional fields omitted.

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