Amazon Data Exchange

Amazon Data Exchange Jobs API

Operations for import/export jobs

Documentation GitHub OpenAPI

Operations 7

GET /v1/jobs List Jobs #

POST /v1/jobs Create Job #

GET /v1/jobs/{JobId} Get Job #

DELETE /v1/jobs/{JobId} Cancel Job #

PATCH /v1/jobs/{JobId} Start Job #

PATCH /v1/jobs/{JobId}/start Start Job #

DELETE /v1/jobs/{JobId}/cancel Cancel Job #

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-data-exchange:amazon-data-exchange-jobs-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

openapi: 3.2.0
info:
  title: Amazon Data Exchange Jobs API
  version: '1.0'
  description: 'Operations tagged Jobs across 2 of this provider''s published API definitions: amazon-data-exchange-openapi.yml, amazon-data-exchange-jobs-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://dataexchange.amazonaws.com
  description: AWS Data Exchange API
- url: https://dataexchange.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
tags:
- name: Jobs
  description: Operations for import/export jobs
paths:
  /v1/jobs:
    get:
      operationId: listJobs
      summary: List Jobs
      description: Returns a list of jobs created for the account.
      tags:
      - Jobs
      parameters:
      - name: maxResults
        in: query
        schema:
          type: integer
      - name: nextToken
        in: query
        schema:
          type: string
      - name: dataSetId
        in: query
        schema:
          type: string
      - name: revisionId
        in: query
        schema:
          type: string
      responses:
        '200':
          description: List of jobs returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListJobsResponse'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    Jobs:
                    - Id: job-001abc
                      Arn: arn:aws:dataexchange:us-east-1:123456789012:jobs/job-001abc
                      Type: EXPORT_ASSETS_TO_S3
                      State: COMPLETED
                      Details:
                        ExportAssetsToS3:
                          DataSetId: ds-abc123
                          RevisionId: rev-001abc
                      CreatedAt: '2024-01-20T11:00:00Z'
                      UpdatedAt: '2024-01-20T11:05:00Z'
      security:
      - awsSignatureV4: []
    post:
      operationId: createJob
      summary: Create Job
      description: Creates a new import or export job for transferring assets.
      tags:
      - Jobs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateJobRequest'
            examples:
              default:
                x-microcks-default: true
                value:
                  Type: EXPORT_ASSETS_TO_S3
                  Details:
                    ExportAssetsToS3:
                      DataSetId: ds-abc123
                      RevisionId: rev-001abc
                      AssetDestinations:
                      - AssetId: asset-001
                        Bucket: my-data-bucket
                        Key: exports/market-data-q1.csv
      responses:
        '201':
          description: Job created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    Id: job-002xyz
                    Arn: arn:aws:dataexchange:us-east-1:123456789012:jobs/job-002xyz
                    Type: EXPORT_ASSETS_TO_S3
                    State: WAITING
                    Details:
                      ExportAssetsToS3:
                        DataSetId: ds-abc123
                        RevisionId: rev-001abc
                    CreatedAt: '2024-04-15T12:00:00Z'
                    UpdatedAt: '2024-04-15T12:00:00Z'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - awsSignatureV4: []
    servers:
    - url: https://dataexchange.amazonaws.com
      description: AWS Data Exchange API
  /v1/jobs/{JobId}:
    get:
      operationId: getJob
      summary: Get Job
      description: Returns the details and current state of a specific job.
      tags:
      - Jobs
      parameters:
      - name: JobId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Job details returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    Id: job-001abc
                    Arn: arn:aws:dataexchange:us-east-1:123456789012:jobs/job-001abc
                    Type: EXPORT_ASSETS_TO_S3
                    State: COMPLETED
                    Details:
                      ExportAssetsToS3:
                        DataSetId: ds-abc123
                        RevisionId: rev-001abc
                    CreatedAt: '2024-01-20T11:00:00Z'
                    UpdatedAt: '2024-01-20T11:05:00Z'
        '404':
          description: Job not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - awsSignatureV4: []
    delete:
      operationId: CancelJob
      summary: Cancel Job
      description: This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelJobRequest'
      tags:
      - Jobs
      security:
      - awsSignatureV4: []
    patch:
      operationId: StartJob
      summary: Start Job
      description: This operation starts a job.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartJobResponse_2'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartJobRequest'
      tags:
      - Jobs
      security:
      - awsSignatureV4: []
    servers:
    - url: https://dataexchange.amazonaws.com
      description: AWS Data Exchange API
  /v1/jobs/{JobId}/start:
    patch:
      operationId: startJob
      summary: Start Job
      description: Starts a job that has been created but is in the WAITING state.
      tags:
      - Jobs
      parameters:
      - name: JobId
        in: path
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Job started successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartJobResponse'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    JobId: job-002xyz
                    State: IN_PROGRESS
      security:
      - awsSignatureV4: []
    servers:
    - url: https://dataexchange.amazonaws.com
      description: AWS Data Exchange API
  /v1/jobs/{JobId}/cancel:
    delete:
      operationId: cancelJob
      summary: Cancel Job
      description: Cancels a job that is in the WAITING or IN_PROGRESS state.
      tags:
      - Jobs
      parameters:
      - name: JobId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Job cancelled successfully
        '404':
          description: Job not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - awsSignatureV4: []
    servers:
    - url: https://dataexchange.amazonaws.com
      description: AWS Data Exchange API
components:
  schemas:
    CreateJobRequest:
      description: Request body for creating a new job.
      type: object
      required:
      - Type
      - Details
      properties:
        Type:
          type: string
          description: The type of job to create
          enum:
          - IMPORT_ASSETS_FROM_S3
          - IMPORT_ASSET_FROM_SIGNED_URL
          - EXPORT_ASSETS_TO_S3
          - EXPORT_ASSET_TO_SIGNED_URL
          - IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES
          - EXPORT_REVISIONS_TO_S3
          - IMPORT_ASSET_FROM_API_GATEWAY_API
          - CREATE_S3_DATA_ACCESS_FROM_S3_BUCKET
          - IMPORT_ASSETS_FROM_LAKE_FORMATION_TAG_POLICY
        Details:
          type: object
          description: Job-type-specific configuration
    StartJobResponse:
      description: Response after starting a job.
      type: object
      properties:
        JobId:
          type: string
        State:
          type: string
    Job:
      description: A Data Exchange job for importing or exporting assets.
      type: object
      properties:
        Id:
          type: string
          description: The unique identifier of the job
        Arn:
          type: string
          description: The ARN of the job. This ARN uniquely identifies the job.
        Type:
          type: string
          description: The type of job
          enum:
          - IMPORT_ASSETS_FROM_S3
          - IMPORT_ASSET_FROM_SIGNED_URL
          - EXPORT_ASSETS_TO_S3
          - EXPORT_ASSET_TO_SIGNED_URL
          - IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES
          - EXPORT_REVISIONS_TO_S3
          - IMPORT_ASSET_FROM_API_GATEWAY_API
          - CREATE_S3_DATA_ACCESS_FROM_S3_BUCKET
          - IMPORT_ASSETS_FROM_LAKE_FORMATION_TAG_POLICY
        State:
          type: string
          description: Current state of the job
          enum:
          - WAITING
          - IN_PROGRESS
          - ERROR
          - COMPLETED
          - CANCELLED
          - TIMED_OUT
        Details:
          type: object
          description: Job-type-specific details
        Errors:
          type: array
          items:
            type: object
        CreatedAt:
          type: string
          format: date-time
        UpdatedAt:
          type: string
          format: date-time
    ListJobsResponse:
      description: Response containing a list of jobs.
      type: object
      properties:
        Jobs:
          type: array
          items:
            $ref: '#/components/schemas/Job'
        NextToken:
          type: string
    Error:
      description: Standard error response from the Data Exchange API.
      type: object
      properties:
        message:
          type: string
          description: A human-readable error message
        code:
          type: string
          description: An error code identifying the type of error
        requestId:
          type: string
          description: The unique ID of the request that resulted in this error
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The resource couldn't be found.
        ResourceId:
          type: string
          description: The unique identifier for the resource that couldn't be found.
        ResourceType:
          type: string
          description: The type of resource that couldn't be found.
      required:
      - Message
    StartJobResponse_2:
      type: object
      properties: {}
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
          description: The limit on the number of requests per second was exceeded.
      required:
      - Message
    ConflictException:
      type: object
      properties:
        Message:
          type: string
          description: The request couldn't be completed because it conflicted with the current state of the resource.
        ResourceId:
          type: string
          description: The unique identifier for the resource with the conflict.
        ResourceType:
          type: string
          description: The type of the resource with the conflict.
      required:
      - Message
    CancelJobRequest:
      type: object
      properties:
        JobId:
          type: string
          description: The unique identifier for a job.
      required:
      - JobId
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
          description: Access to the resource is denied.
      required:
      - Message
    StartJobRequest:
      type: object
      properties:
        JobId:
          type: string
          description: The unique identifier for a job.
      required:
      - JobId
    ValidationException:
      type: object
      properties:
        Message:
          type: string
          description: The message that informs you about what was invalid about the request.
        ExceptionCause:
          type: string
          description: The unique identifier for the resource that couldn't be found.
      required:
      - Message
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
          description: The message identifying the service exception that occurred.
      required:
      - Message
  securitySchemes:
    awsSignatureV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 authentication
    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: dataexchange
x-refined-from:
- amazon-data-exchange-openapi.yml
- amazon-data-exchange-jobs-api-openapi.yml

Amazon Data Exchange Jobs API

Operations 7

Documentation

Specifications

Schemas & Data

Other Resources