Amazon Personalize

Amazon Personalize Personalize Dataset Export Job API

The Personalize Dataset Export Job API from Amazon Personalize — 3 operation(s) for personalize dataset export job.

GitHub OpenAPI
Business capability
Model Training & Data AE-110.70

Operations 3

POST /#CreateDatasetExportJob Create Dataset Export Job #
POST /#DescribeDatasetExportJob Describe Dataset Export Job #
POST /#ListDatasetExportJobs List Dataset Export Jobs #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-personalize/openapi/amazon-personalize-dataset-export-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-dataset-export-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-dataset-export-job-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon Personalize Dataset Export 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: Dataset Export Job
paths:
  /#CreateDatasetExportJob:
    post:
      operationId: CreateDatasetExportJob
      summary: Create Dataset Export Job
      description: 'Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide. Status A dataset export job can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateDatasetExportJobResponse'
        '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.CreateDatasetExportJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateDatasetExportJobRequest'
      tags:
      - Dataset Export Job
  /#DescribeDatasetExportJob:
    post:
      operationId: DescribeDatasetExportJob
      summary: Describe Dataset Export Job
      description: Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeDatasetExportJobResponse'
        '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.DescribeDatasetExportJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeDatasetExportJobRequest'
      tags:
      - Dataset Export Job
  /#ListDatasetExportJobs:
    post:
      operationId: ListDatasetExportJobs
      summary: List Dataset Export Jobs
      description: Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListDatasetExportJobsResponse'
        '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.ListDatasetExportJobs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListDatasetExportJobsRequest'
      tags:
      - Dataset Export Job
components:
  schemas:
    CreateDatasetExportJobResponse:
      type: object
      properties:
        datasetExportJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset export job.
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
    S3DataConfig:
      type: object
      properties:
        path:
          type: string
          description: The file path of the Amazon S3 bucket.
        kmsKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
      required:
      - path
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    DatasetExportJobSummary:
      type: object
      properties:
        datasetExportJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset export job.
        jobName:
          type: string
          description: The name of the dataset export job.
        status:
          type: string
          description: 'The status of the dataset export job. A dataset export job can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED'
        creationDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the dataset export job was created.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) that the dataset export job status was last updated.
        failureReason:
          type: string
          description: If a dataset export job fails, the reason behind the failure.
    ResourceAlreadyExistsException:
      type: object
      properties:
        message:
          type: string
    DatasetExportJobOutput:
      type: object
      properties:
        s3DataDestination:
          $ref: '#/components/schemas/S3DataConfig'
      required:
      - s3DataDestination
    ListDatasetExportJobsRequest:
      type: object
      properties:
        datasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset to list the dataset export jobs for.
        nextToken:
          type: string
          description: A token returned from the previous call to ListDatasetExportJobs for getting the next set of dataset export jobs (if they exist).
        maxResults:
          type: integer
          description: The maximum number of dataset export jobs to return.
    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
    DescribeDatasetExportJobRequest:
      type: object
      properties:
        datasetExportJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset export job to describe.
      required:
      - datasetExportJobArn
    CreateDatasetExportJobRequest:
      type: object
      properties:
        jobName:
          type: string
          description: The name for the dataset export job.
        datasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset that contains the data to export.
        ingestionMode:
          type: string
          enum:
          - BULK
          - PUT
          - ALL
          description: The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
        jobOutput:
          $ref: '#/components/schemas/DatasetExportJobOutput'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to apply to the dataset export job.
      required:
      - jobName
      - datasetArn
      - roleArn
      - jobOutput
    ListDatasetExportJobsResponse:
      type: object
      properties:
        datasetExportJobs:
          type: array
          items:
            $ref: '#/components/schemas/DatasetExportJobSummary'
          description: The list of dataset export jobs.
        nextToken:
          type: string
          description: A token for getting the next set of dataset export jobs (if they exist).
    DatasetExportJob:
      type: object
      properties:
        jobName:
          type: string
          description: The name of the export job.
        datasetExportJobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset export job.
        datasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset to export.
        ingestionMode:
          type: string
          enum:
          - BULK
          - PUT
          - ALL
          description: The data to export, based on how you imported the data. You can choose to export BULK data that you imported using a dataset import job, PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
        status:
          type: string
          description: 'The status of the dataset export job. A dataset export job can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED'
        jobOutput:
          $ref: '#/components/schemas/DatasetExportJobOutput'
        creationDateTime:
          type: string
          format: date-time
          description: The creation date and time (in Unix time) of the dataset export job.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time (in Unix time) the status of the dataset export job was last updated.
        failureReason:
          type: string
          description: If a dataset export job fails, provides the reason why.
    InvalidInputException:
      type: object
      properties:
        message:
          type: string
    DescribeDatasetExportJobResponse:
      type: object
      properties:
        datasetExportJob:
          $ref: '#/components/schemas/DatasetExportJob'
  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)