Skip to content

delete_identities

delete_identities(
    identity_ids_to_delete: IdentityIdList,
    *,
    config_overrides: Optional[CognitoIdentityClientConfig] = None,
) -> DeleteIdentitiesResponse

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

You must use Amazon Web Services developer credentials to call this operation.

Parameters:

  • identity_ids_to_delete (IdentityIdList) –

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

Raises:

Source code in docs_src/capo_cognito_identity/_services/cognito_identity.py
def delete_identities(
    self,
    identity_ids_to_delete: "capo_cognito_identity.types.identity_id_list.IdentityIdList",
    *,
    config_overrides: Optional[CognitoIdentityClientConfig] = None,
) -> "capo_cognito_identity.types.delete_identities_response.DeleteIdentitiesResponse":
    """<p>Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.</p> <p>You must use Amazon Web Services developer credentials to call this operation.</p>

    Args:
        identity_ids_to_delete: <p>A list of 1-60 identities that you want to delete.</p>

    Raises:
        capo_cognito_identity.errors.internal_error_exception.InternalErrorException: <p>Thrown when the service encounters an error during processing the request.</p>
        capo_cognito_identity.errors.invalid_parameter_exception.InvalidParameterException: <p>Thrown for missing or bad input parameter(s).</p>
        capo_cognito_identity.errors.too_many_requests_exception.TooManyRequestsException: <p>Thrown when a request is throttled.</p>
        capo_cognito_identity.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cognito_identity.types.delete_identities_input.DeleteIdentitiesInput]",
    ) -> OperationResponse[
        "capo_cognito_identity.types.delete_identities_response.DeleteIdentitiesResponse"
    ]:
        import capo_cognito_identity._operations.aws_cognito_identity_service.delete_identities

        output, http_response = (
            capo_cognito_identity._operations.aws_cognito_identity_service.delete_identities.delete_identities(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteIdentities")
    )
    input_: capo_cognito_identity.types.delete_identities_input.DeleteIdentitiesInput = {
        "identity_ids_to_delete": identity_ids_to_delete
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output