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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes a group.

Calling this action requires developer credentials.

Synopsis

data DeleteGroup = DeleteGroup' {
- groupName :: Text
- userPoolId :: Text
}
newDeleteGroup :: Text -> Text -> DeleteGroup
deleteGroup_groupName :: Lens' DeleteGroup Text
deleteGroup_userPoolId :: Lens' DeleteGroup Text
data DeleteGroupResponse = DeleteGroupResponse' {
}
newDeleteGroupResponse :: DeleteGroupResponse

Creating a Request

data DeleteGroup Source #

See: newDeleteGroup smart constructor.

Constructors

DeleteGroup'
Fields groupName :: Text The name of the group. userPoolId :: Text The user pool ID for the user pool.

Instances

Instances details

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

newDeleteGroup Source #

Arguments

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

Create a value of DeleteGroup 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:groupName:DeleteGroup', deleteGroup_groupName - The name of the group.

$sel:userPoolId:DeleteGroup', deleteGroup_userPoolId - The user pool ID for the user pool.

Request Lenses

deleteGroup_groupName :: Lens' DeleteGroup Text Source #

The name of the group.

deleteGroup_userPoolId :: Lens' DeleteGroup Text Source #

The user pool ID for the user pool.

Destructuring the Response

data DeleteGroupResponse Source #

See: newDeleteGroupResponse smart constructor.

Constructors

DeleteGroupResponse'

Instances

Instances details

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

newDeleteGroupResponse :: DeleteGroupResponse Source #

Create a value of DeleteGroupResponse with all optional fields omitted.

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