Amazonka.CognitoIdentity.DeleteIdentities

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

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

ToJSON DeleteIdentities

Defined in Amazonka.CognitoIdentity.DeleteIdentities

Methods

toJSON :: DeleteIdentities -> Value

toEncoding :: DeleteIdentities -> Encoding

toJSONList :: [DeleteIdentities] -> Value

toEncodingList :: [DeleteIdentities] -> Encoding

ToHeaders DeleteIdentities

Defined in Amazonka.CognitoIdentity.DeleteIdentities

Methods

toHeaders :: DeleteIdentities -> [Header]

ToPath DeleteIdentities

Defined in Amazonka.CognitoIdentity.DeleteIdentities

Methods

toPath :: DeleteIdentities -> ByteString

ToQuery DeleteIdentities

Defined in Amazonka.CognitoIdentity.DeleteIdentities

Methods

toQuery :: DeleteIdentities -> QueryString

AWSRequest DeleteIdentities

Defined in Amazonka.CognitoIdentity.DeleteIdentities

Associated Types

type AWSResponse DeleteIdentities

Methods

request :: (Service -> Service) -> DeleteIdentities -> Request DeleteIdentities

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteIdentities -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteIdentities)))

Generic DeleteIdentities

Defined in Amazonka.CognitoIdentity.DeleteIdentities

Associated Types

type Rep DeleteIdentities :: Type -> Type

Methods

from :: DeleteIdentities -> Rep DeleteIdentities x

to :: Rep DeleteIdentities x -> DeleteIdentities

Read DeleteIdentities

Defined in Amazonka.CognitoIdentity.DeleteIdentities

Methods

readsPrec :: Int -> ReadS DeleteIdentities

readList :: ReadS [DeleteIdentities]

readPrec :: ReadPrec DeleteIdentities

readListPrec :: ReadPrec [DeleteIdentities]

Show DeleteIdentities

Defined in Amazonka.CognitoIdentity.DeleteIdentities

Methods

showsPrec :: Int -> DeleteIdentities -> ShowS

show :: DeleteIdentities -> String

showList :: [DeleteIdentities] -> ShowS

NFData DeleteIdentities

Defined in Amazonka.CognitoIdentity.DeleteIdentities

Methods

rnf :: DeleteIdentities -> ()

Eq DeleteIdentities

Defined in Amazonka.CognitoIdentity.DeleteIdentities

Methods

(==) :: DeleteIdentities -> DeleteIdentities -> Bool

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

Hashable DeleteIdentities

Defined in Amazonka.CognitoIdentity.DeleteIdentities

Methods

hashWithSalt :: Int -> DeleteIdentities -> Int

hash :: DeleteIdentities -> Int

type AWSResponse DeleteIdentities

Defined in Amazonka.CognitoIdentity.DeleteIdentities

type AWSResponse DeleteIdentities = DeleteIdentitiesResponse

type Rep DeleteIdentities

Defined in Amazonka.CognitoIdentity.DeleteIdentities

type Rep DeleteIdentities = D1 ('MetaData "DeleteIdentities" "Amazonka.CognitoIdentity.DeleteIdentities" "amazonka-cognito-identity-2.0-9cap08KVWNhAJ5mbkAF9NH" 'False) (C1 ('MetaCons "DeleteIdentities'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identityIdsToDelete") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))

newDeleteIdentities

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)

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

Destructuring the Response

data DeleteIdentitiesResponse

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

Generic DeleteIdentitiesResponse

Defined in Amazonka.CognitoIdentity.DeleteIdentities

Associated Types

type Rep DeleteIdentitiesResponse :: Type -> Type

Methods

from :: DeleteIdentitiesResponse -> Rep DeleteIdentitiesResponse x

to :: Rep DeleteIdentitiesResponse x -> DeleteIdentitiesResponse

Read DeleteIdentitiesResponse

Defined in Amazonka.CognitoIdentity.DeleteIdentities

Methods

readsPrec :: Int -> ReadS DeleteIdentitiesResponse

readList :: ReadS [DeleteIdentitiesResponse]

readPrec :: ReadPrec DeleteIdentitiesResponse

readListPrec :: ReadPrec [DeleteIdentitiesResponse]

Show DeleteIdentitiesResponse

Defined in Amazonka.CognitoIdentity.DeleteIdentities

Methods

showsPrec :: Int -> DeleteIdentitiesResponse -> ShowS

show :: DeleteIdentitiesResponse -> String

showList :: [DeleteIdentitiesResponse] -> ShowS

NFData DeleteIdentitiesResponse

Defined in Amazonka.CognitoIdentity.DeleteIdentities

Methods

rnf :: DeleteIdentitiesResponse -> ()

Eq DeleteIdentitiesResponse

Defined in Amazonka.CognitoIdentity.DeleteIdentities

Methods

(==) :: DeleteIdentitiesResponse -> DeleteIdentitiesResponse -> Bool

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

type Rep DeleteIdentitiesResponse

Defined in Amazonka.CognitoIdentity.DeleteIdentities

type Rep DeleteIdentitiesResponse = D1 ('MetaData "DeleteIdentitiesResponse" "Amazonka.CognitoIdentity.DeleteIdentities" "amazonka-cognito-identity-2.0-9cap08KVWNhAJ5mbkAF9NH" '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

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])

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

deleteIdentitiesResponse_httpStatus :: Lens' DeleteIdentitiesResponse Int

The response's http status code.