Amazon DMS

Amazon DMS Dms Data Migration API

The Dms Data Migration API from Amazon DMS — 6 operation(s) for dms data migration.

GitHub OpenAPI

Operations 6

POST /#CreateDataMigration Create Data Migration #
POST /#DeleteDataMigration Delete Data Migration #
POST /#DescribeDataMigrations Describe Data Migrations #
POST /#ModifyDataMigration Modify Data Migration #
POST /#StartDataMigration Start Data Migration #
POST /#StopDataMigration Stop Data Migration #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-dms/openapi/amazon-dms-data-migration-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-dms:amazon-dms-data-migration-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-dms-data-migration-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AWS Database Migration Service Data Migration API
  version: '2016-01-01'
  description: Generated from AWS's published Smithy model for AWS Database Migration Service. 6 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://dms.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Data Migration
paths:
  /#CreateDataMigration:
    post:
      operationId: CreateDataMigration
      summary: Create Data Migration
      description: Creates a data migration using the provided settings.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateDataMigrationResponse'
        '400':
          description: FailedDependencyFault; InvalidOperationFault; ResourceAlreadyExistsFault; ResourceNotFoundFault; ResourceQuotaExceededFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/FailedDependencyFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDMSv20160101.CreateDataMigration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateDataMigrationMessage'
      tags:
      - Data Migration
  /#DeleteDataMigration:
    post:
      operationId: DeleteDataMigration
      summary: Delete Data Migration
      description: Deletes the specified data migration.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteDataMigrationResponse'
        '400':
          description: FailedDependencyFault; InvalidResourceStateFault; ResourceNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/FailedDependencyFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDMSv20160101.DeleteDataMigration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteDataMigrationMessage'
      tags:
      - Data Migration
  /#DescribeDataMigrations:
    post:
      operationId: DescribeDataMigrations
      summary: Describe Data Migrations
      description: Returns information about data migrations.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeDataMigrationsResponse'
        '400':
          description: FailedDependencyFault; InvalidResourceStateFault; ResourceNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/FailedDependencyFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDMSv20160101.DescribeDataMigrations
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeDataMigrationsMessage'
      tags:
      - Data Migration
  /#ModifyDataMigration:
    post:
      operationId: ModifyDataMigration
      summary: Modify Data Migration
      description: Modifies an existing DMS data migration.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ModifyDataMigrationResponse'
        '400':
          description: FailedDependencyFault; InvalidResourceStateFault; ResourceNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/FailedDependencyFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDMSv20160101.ModifyDataMigration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ModifyDataMigrationMessage'
      tags:
      - Data Migration
  /#StartDataMigration:
    post:
      operationId: StartDataMigration
      summary: Start Data Migration
      description: Starts the specified data migration.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartDataMigrationResponse'
        '400':
          description: FailedDependencyFault; InvalidOperationFault; InvalidResourceStateFault; ResourceNotFoundFault; ResourceQuotaExceededFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/FailedDependencyFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDMSv20160101.StartDataMigration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartDataMigrationMessage'
      tags:
      - Data Migration
  /#StopDataMigration:
    post:
      operationId: StopDataMigration
      summary: Stop Data Migration
      description: Stops the specified data migration.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StopDataMigrationResponse'
        '400':
          description: FailedDependencyFault; InvalidResourceStateFault; ResourceNotFoundFault
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/FailedDependencyFault'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDMSv20160101.StopDataMigration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopDataMigrationMessage'
      tags:
      - Data Migration
components:
  schemas:
    DataMigrationSettings:
      type: object
      properties:
        NumberOfJobs:
          type: integer
          description: The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.
        CloudwatchLogsEnabled:
          type: boolean
          description: Whether to enable CloudWatch logging for the data migration.
        SelectionRules:
          type: string
          description: A JSON-formatted string that defines what objects to include and exclude from the migration.
    FailedDependencyFault:
      type: object
      properties:
        message:
          type: string
    DescribeDataMigrationsResponse:
      type: object
      properties:
        DataMigrations:
          type: array
          items:
            $ref: '#/components/schemas/DataMigration'
          description: Returns information about the data migrations used in the project.
        Marker:
          type: string
          description: An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    SourceDataSetting:
      type: object
      properties:
        CDCStartPosition:
          type: string
          description: The change data capture (CDC) start position for the source data provider.
        CDCStartTime:
          type: string
          format: date-time
          description: The change data capture (CDC) start time for the source data provider.
        CDCStopTime:
          type: string
          format: date-time
          description: The change data capture (CDC) stop time for the source data provider.
        SlotName:
          type: string
          description: The name of the replication slot on the source data provider. This attribute is only valid for a PostgreSQL or Aurora PostgreSQL source.
    ModifyDataMigrationMessage:
      type: object
      properties:
        DataMigrationIdentifier:
          type: string
          description: The identifier (name or ARN) of the data migration to modify.
        DataMigrationName:
          type: string
          description: The new name for the data migration.
        EnableCloudwatchLogs:
          type: boolean
          description: Whether to enable Cloudwatch logs for the data migration.
        ServiceAccessRoleArn:
          type: string
          description: The new service access role ARN for the data migration.
        DataMigrationType:
          type: string
          enum:
          - full-load
          - cdc
          - full-load-and-cdc
          description: The new migration type for the data migration.
        SourceDataSettings:
          type: array
          items:
            $ref: '#/components/schemas/SourceDataSetting'
          description: The new information about the source data provider for the data migration.
        TargetDataSettings:
          type: array
          items:
            $ref: '#/components/schemas/TargetDataSetting'
          description: The new information about the target data provider for the data migration.
        NumberOfJobs:
          type: integer
          description: The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.
        SelectionRules:
          type: string
          description: A JSON-formatted string that defines what objects to include and exclude from the migration.
      required:
      - DataMigrationIdentifier
    StopDataMigrationMessage:
      type: object
      properties:
        DataMigrationIdentifier:
          type: string
          description: The identifier (name or ARN) of the data migration to stop.
      required:
      - DataMigrationIdentifier
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can''t be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'' (Java regular expressions: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").'
        Value:
          type: string
          description: 'A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can''t be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'' (Java regular expressions: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").'
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.
    CreateDataMigrationMessage:
      type: object
      properties:
        DataMigrationName:
          type: string
          description: 'A user-friendly name for the data migration. Data migration names have the following constraints: Must begin with a letter, and can only contain ASCII letters, digits, and hyphens. Can''t end with a hyphen or contain two consecutive hyphens. Length must be from 1 to 255 characters.'
        MigrationProjectIdentifier:
          type: string
          description: An identifier for the migration project.
        DataMigrationType:
          type: string
          enum:
          - full-load
          - cdc
          - full-load-and-cdc
          description: Specifies if the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.
        ServiceAccessRoleArn:
          type: string
          description: The Amazon Resource Name (ARN) for the service access role that you want to use to create the data migration.
        EnableCloudwatchLogs:
          type: boolean
          description: Specifies whether to enable CloudWatch logs for the data migration.
        SourceDataSettings:
          type: array
          items:
            $ref: '#/components/schemas/SourceDataSetting'
          description: Specifies information about the source data provider.
        TargetDataSettings:
          type: array
          items:
            $ref: '#/components/schemas/TargetDataSetting'
          description: Specifies information about the target data provider.
        NumberOfJobs:
          type: integer
          description: The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: One or more tags to be assigned to the data migration.
        SelectionRules:
          type: string
          description: An optional JSON string specifying what tables, views, and schemas to include or exclude from the migration.
      required:
      - MigrationProjectIdentifier
      - DataMigrationType
      - ServiceAccessRoleArn
    DescribeDataMigrationsMessage:
      type: object
      properties:
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: Filters applied to the data migrations.
        MaxRecords:
          type: integer
          description: The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
        Marker:
          type: string
          description: An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
        WithoutSettings:
          type: boolean
          description: An option to set to avoid returning information about settings. Use this to reduce overhead when setting information is too large. To use this option, choose true; otherwise, choose false (the default).
        WithoutStatistics:
          type: boolean
          description: An option to set to avoid returning information about statistics. Use this to reduce overhead when statistics information is too large. To use this option, choose true; otherwise, choose false (the default).
    DataMigrationStatistics:
      type: object
      properties:
        TablesLoaded:
          type: integer
          description: The number of tables loaded in the current data migration run.
        ElapsedTimeMillis:
          type: integer
          description: The elapsed duration of the data migration run.
        TablesLoading:
          type: integer
          description: The data migration's table loading progress.
        FullLoadPercentage:
          type: integer
          description: The data migration's progress in the full-load migration phase.
        CDCLatency:
          type: integer
          description: The current latency of the change data capture (CDC) operation.
        TablesQueued:
          type: integer
          description: The number of tables that are waiting for processing.
        TablesErrored:
          type: integer
          description: The number of tables that DMS failed to process.
        StartTime:
          type: string
          format: date-time
          description: The time when the migration started.
        StopTime:
          type: string
          format: date-time
          description: The time when the migration stopped or failed.
    DeleteDataMigrationResponse:
      type: object
      properties:
        DataMigration:
          $ref: '#/components/schemas/DataMigration'
    ModifyDataMigrationResponse:
      type: object
      properties:
        DataMigration:
          $ref: '#/components/schemas/DataMigration'
    CreateDataMigrationResponse:
      type: object
      properties:
        DataMigration:
          $ref: '#/components/schemas/DataMigration'
    TargetDataSetting:
      type: object
      properties:
        TablePreparationMode:
          type: string
          enum:
          - do-nothing
          - truncate
          - drop-tables-on-target
          description: This setting determines how DMS handles the target tables before starting a data migration, either by leaving them untouched, dropping and recreating them, or truncating the existing data in the target tables.
    StartDataMigrationResponse:
      type: object
      properties:
        DataMigration:
          $ref: '#/components/schemas/DataMigration'
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter as specified for a Describe* or similar operation.
        Values:
          type: array
          items:
            type: string
          description: The filter value, which can specify one or more values used to narrow the returned results.
      required:
      - Name
      - Values
    DeleteDataMigrationMessage:
      type: object
      properties:
        DataMigrationIdentifier:
          type: string
          description: The identifier (name or ARN) of the data migration to delete.
      required:
      - DataMigrationIdentifier
    StopDataMigrationResponse:
      type: object
      properties:
        DataMigration:
          $ref: '#/components/schemas/DataMigration'
    DataMigration:
      type: object
      properties:
        DataMigrationName:
          type: string
          description: The user-friendly name for the data migration.
        DataMigrationArn:
          type: string
          description: The Amazon Resource Name (ARN) that identifies this replication.
        DataMigrationCreateTime:
          type: string
          format: date-time
          description: The UTC time when DMS created the data migration.
        DataMigrationStartTime:
          type: string
          format: date-time
          description: The UTC time when DMS started the data migration.
        DataMigrationEndTime:
          type: string
          format: date-time
          description: The UTC time when data migration ended.
        ServiceAccessRoleArn:
          type: string
          description: The IAM role that the data migration uses to access Amazon Web Services resources.
        MigrationProjectArn:
          type: string
          description: The Amazon Resource Name (ARN) of the data migration's associated migration project.
        DataMigrationType:
          type: string
          enum:
          - full-load
          - cdc
          - full-load-and-cdc
          description: Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.
        DataMigrationSettings:
          $ref: '#/components/schemas/DataMigrationSettings'
        SourceDataSettings:
          type: array
          items:
            $ref: '#/components/schemas/SourceDataSetting'
          description: Specifies information about the data migration's source data provider.
        TargetDataSettings:
          type: array
          items:
            $ref: '#/components/schemas/TargetDataSetting'
          description: Specifies information about the data migration's target data provider.
        DataMigrationStatistics:
          $ref: '#/components/schemas/DataMigrationStatistics'
        DataMigrationStatus:
          type: string
          description: The current status of the data migration.
        PublicIpAddresses:
          type: array
          items:
            type: string
          description: The IP addresses of the endpoints for the data migration.
        DataMigrationCidrBlocks:
          type: array
          items:
            type: string
          description: The CIDR blocks of the endpoints for the data migration.
        LastFailureMessage:
          type: string
          description: Information about the data migration's most recent error or failure.
        StopReason:
          type: string
          description: The reason the data migration last stopped.
    StartDataMigrationMessage:
      type: object
      properties:
        DataMigrationIdentifier:
          type: string
          description: The identifier (name or ARN) of the data migration to start.
        StartType:
          type: string
          enum:
          - reload-target
          - resume-processing
          - start-replication
          description: Specifies the start type for the data migration. Valid values include start-replication, reload-target, and resume-processing.
      required:
      - DataMigrationIdentifier
      - StartType
  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: dms
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/database-migration-service/service/2016-01-01/database-migration-service-2016-01-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)