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.CognitoIdentity.DeleteIdentities

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.

You must use AWS Developer credentials to call this API.

Creating a Request

data DeleteIdentities Source #

Input to the DeleteIdentities action.

See: newDeleteIdentities smart constructor.

Constructors

DeleteIdentities'
Fields identityIdsToDelete :: NonEmpty Text A list of 1-60 identities that you want to delete.

Instances

Instances details

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

newDeleteIdentities Source #

Arguments

:: NonEmpty Text	`$sel:identityIdsToDelete:DeleteIdentities'`
-> DeleteIdentities

Create a value of DeleteIdentities 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:identityIdsToDelete:DeleteIdentities', deleteIdentities_identityIdsToDelete - A list of 1-60 identities that you want to delete.

Request Lenses

deleteIdentities_identityIdsToDelete :: Lens' DeleteIdentities (NonEmpty Text) Source #

A list of 1-60 identities that you want to delete.

Destructuring the Response

data DeleteIdentitiesResponse Source #

Returned in response to a successful DeleteIdentities operation.

See: newDeleteIdentitiesResponse smart constructor.

Constructors

DeleteIdentitiesResponse'
Fields unprocessedIdentityIds :: Maybe [UnprocessedIdentityId] An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DeleteIdentitiesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.DeleteIdentities Methods (==) :: DeleteIdentitiesResponse -> DeleteIdentitiesResponse -> Bool # (/=) :: DeleteIdentitiesResponse -> DeleteIdentitiesResponse -> Bool #
Read DeleteIdentitiesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.DeleteIdentities Methods readsPrec :: Int -> ReadS DeleteIdentitiesResponse # readList :: ReadS [DeleteIdentitiesResponse] # readPrec :: ReadPrec DeleteIdentitiesResponse # readListPrec :: ReadPrec [DeleteIdentitiesResponse] #
Show DeleteIdentitiesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.DeleteIdentities Methods showsPrec :: Int -> DeleteIdentitiesResponse -> ShowS # show :: DeleteIdentitiesResponse -> String # showList :: [DeleteIdentitiesResponse] -> ShowS #
Generic DeleteIdentitiesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.DeleteIdentities Associated Types type Rep DeleteIdentitiesResponse :: Type -> Type # Methods from :: DeleteIdentitiesResponse -> Rep DeleteIdentitiesResponse x # to :: Rep DeleteIdentitiesResponse x -> DeleteIdentitiesResponse #
NFData DeleteIdentitiesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.DeleteIdentities Methods rnf :: DeleteIdentitiesResponse -> () #
type Rep DeleteIdentitiesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.DeleteIdentities type Rep DeleteIdentitiesResponse = D1 ('MetaData "DeleteIdentitiesResponse" "Amazonka.CognitoIdentity.DeleteIdentities" "libZSservicesZSamazonka-cognito-identityZSamazonka-cognito-identity" 'False) (C1 ('MetaCons "DeleteIdentitiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "unprocessedIdentityIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UnprocessedIdentityId])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteIdentitiesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteIdentitiesResponse'`
-> DeleteIdentitiesResponse

Create a value of DeleteIdentitiesResponse 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:unprocessedIdentityIds:DeleteIdentitiesResponse', deleteIdentitiesResponse_unprocessedIdentityIds - An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.

$sel:httpStatus:DeleteIdentitiesResponse', deleteIdentitiesResponse_httpStatus - The response's http status code.

Response Lenses

deleteIdentitiesResponse_unprocessedIdentityIds :: Lens' DeleteIdentitiesResponse (Maybe [UnprocessedIdentityId]) Source #

An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.

deleteIdentitiesResponse_httpStatus :: Lens' DeleteIdentitiesResponse Int Source #

The response's http status code.