Amazon Personalize

Amazon Personalize Personalize Data Deletion Job API

The Personalize Data Deletion Job API from Amazon Personalize — 3 operation(s) for personalize data deletion job.

GitHub OpenAPI

Operations 3

POST /#CreateDataDeletionJob Create Data Deletion Job #
POST /#DescribeDataDeletionJob Describe Data Deletion Job #
POST /#ListDataDeletionJobs List Data Deletion Jobs #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-personalize/openapi/amazon-personalize-data-deletion-job-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-personalize:amazon-personalize-data-deletion-job-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-personalize-data-deletion-job-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon Personalize Data Deletion Job API
  version: '2018-05-22'
  description: Generated from AWS's published Smithy model for Amazon Personalize. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://personalize.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Data Deletion Job
paths:
  /#CreateDataDeletionJob:
    post:
      operationId: CreateDataDeletionJob
      summary: Create Data Deletion Job
      description: Creates a batch job that deletes all references to specific users from an Amazon Personalize dataset group in batches. You specify the users to delete in a CSV file of userIds in an Amazon S3 bucket. After a job completes, Amazon Personalize no longer trains on the users’ data and no longer considers the users when generating user segments. For more information about creating a data deletion job, see Deleting users. Your input file must be a CSV file with a single USER_ID column that lists the users IDs. For more information about preparing the CSV file, see Preparing your data deletion file and uploading it to Amazon S3. To give Amazon Personalize permission to access your input CSV file of userIds, you must specify an IAM service role that has permission to read from the data source. This role needs GetObject and ListBucket permissions for the bucket and its content. These permissions are the same as importing data. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources. After you create a job, it can take up to a day to delete all references to the users from datasets and models. Until the job completes, Amazon Pe
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateDataDeletionJobResponse'
        '400':
          description: InvalidInputException; TooManyTagsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '409':
          description: LimitExceededException; ResourceInUseException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '403':
          description: ResourceAlreadyExistsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceAlreadyExistsException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.CreateDataDeletionJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateDataDeletionJobRequest'
      tags:
      - Data Deletion Job
  /#DescribeDataDeletionJob:
    post:
      operationId: DescribeDataDeletionJob
      summary: Describe Data Deletion Job
      description: Describes the data deletion job created by CreateDataDeletionJob, including the job status.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeDataDeletionJobResponse'
        '400':
          description: InvalidInputException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.DescribeDataDeletionJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeDataDeletionJobRequest'
      tags:
      - Data Deletion Job
  /#ListDataDeletionJobs:
    post:
      operationId: ListDataDeletionJobs
      summary: List Data Deletion Jobs
      description: Returns a list of data deletion jobs for a dataset group ordered by creation time, with the most recent first. When a dataset group is not specified, all the data deletion jobs associated with the account are listed. The response provides the properties for each job, including the Amazon Resource Name (ARN). For more information on data deletion jobs, see Deleting users.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListDataDeletionJobsResponse'
        '400':
          description: InvalidInputException; InvalidNextTokenException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.ListDataDeletionJobs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListDataDeletionJobsRequest'
      tags:
      - Data Deletion Job
components:
  schemas:
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
    DataDeletionJob:
      type: object
      properties:
        jobName:
          type: string
          description: The name of the data deletion job.
        dataDeletionJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the data deletion job.
        datasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset group the job deletes records from.
        dataSource:
          $ref: '#/components/schemas/DataSource'
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role that has permissions to read from the Amazon S3 data source.
        status:
          type: string
          description: 'The status of the data deletion job. A data deletion job can have one of the following statuses: PENDING > IN_PROGRESS > COMPLETED -or- FAILED'
        numDeleted:
          type: integer
          description: The number of records deleted by a COMPLETED job.
        creationDateTime:
          type: string
          format: date-time
          description: The creation date and time (in Unix time) of the data deletion job.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) the data deletion job was last updated.
        failureReason:
          type: string
          description: If a data deletion job fails, provides the reason why.
    CreateDataDeletionJobRequest:
      type: object
      properties:
        jobName:
          type: string
          description: The name for the data deletion job.
        datasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset group that has the datasets you want to delete records from.
        dataSource:
          $ref: '#/components/schemas/DataSource'
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role that has permissions to read from the Amazon S3 data source.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to apply to the data deletion job.
      required:
      - jobName
      - datasetGroupArn
      - dataSource
      - roleArn
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ResourceAlreadyExistsException:
      type: object
      properties:
        message:
          type: string
    ListDataDeletionJobsResponse:
      type: object
      properties:
        dataDeletionJobs:
          type: array
          items:
            $ref: '#/components/schemas/DataDeletionJobSummary'
          description: The list of data deletion jobs.
        nextToken:
          type: string
          description: A token for getting the next set of data deletion jobs (if they exist).
    CreateDataDeletionJobResponse:
      type: object
      properties:
        dataDeletionJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the data deletion job.
    DataDeletionJobSummary:
      type: object
      properties:
        dataDeletionJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the data deletion job.
        datasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset group the job deleted records from.
        jobName:
          type: string
          description: The name of the data deletion job.
        status:
          type: string
          description: 'The status of the data deletion job. A data deletion job can have one of the following statuses: PENDING > IN_PROGRESS > COMPLETED -or- FAILED'
        creationDateTime:
          type: string
          format: date-time
          description: The creation date and time (in Unix time) of the data deletion job.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) the data deletion job was last updated.
        failureReason:
          type: string
          description: If a data deletion job fails, provides the reason why.
    DescribeDataDeletionJobResponse:
      type: object
      properties:
        dataDeletionJob:
          $ref: '#/components/schemas/DataDeletionJob'
    Tag:
      type: object
      properties:
        tagKey:
          type: string
          description: One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
        tagValue:
          type: string
          description: The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
      required:
      - tagKey
      - tagValue
    DataSource:
      type: object
      properties:
        dataLocation:
          type: string
          description: 'For dataset import jobs, the path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For data deletion jobs, the path to the Amazon S3 bucket that stores the list of records to delete. For example: s3://bucket-name/folder-name/fileName.csv If your CSV files are in a folder in your Amazon S3 bucket and you want your import job or data deletion job to consider multiple files, you can specify the path to the folder. With a data deletion job, Amazon Personalize uses all files in the folder and any sub folder. Use the following syntax with a / after the folder'
    DescribeDataDeletionJobRequest:
      type: object
      properties:
        dataDeletionJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the data deletion job.
      required:
      - dataDeletionJobArn
    ListDataDeletionJobsRequest:
      type: object
      properties:
        datasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset group to list data deletion jobs for.
        nextToken:
          type: string
          description: A token returned from the previous call to ListDataDeletionJobs for getting the next set of jobs (if they exist).
        maxResults:
          type: integer
          description: The maximum number of data deletion jobs to return.
    InvalidInputException:
      type: object
      properties:
        message:
          type: string
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: personalize
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/personalize/service/2018-05-22/personalize-2018-05-22.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)