Open documentation ↗Overview
<fullname>Database Migration Service</fullname> <p>Database Migration Service (DMS) can migrate your data to and from the most widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as heterogeneous migrations between different database platforms, such as Oracle to MySQL or SQL Server to PostgreSQL.</p> <p>For more information about DMS, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html">What Is Database Migration Service?</a> in the <i>Database Migration Service User Guide.</i> </p>
AWS Database Migration Service is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 69 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2016-01-01
- Endpoints
- 69
- OpenAPI
- Specification ↗
- Spec updated
- 2020-04-27
Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /#X-Amz-Target=AmazonDMSv20160101.AddTagsToResource | Adds metadata tags to an DMS resource, including replication instance, endpoint, subnet group, and migration task. These tags can also be used with cost allocat |
| POST | /#X-Amz-Target=AmazonDMSv20160101.ApplyPendingMaintenanceAction | Applies a pending maintenance action to a resource (for example, to a replication instance). |
| POST | /#X-Amz-Target=AmazonDMSv20160101.BatchStartRecommendations | <p>Starts the analysis of up to 20 source databases to recommend target engines for each source database. This is a batch version of <a href="https://docs.aws.a |
| POST | /#X-Amz-Target=AmazonDMSv20160101.CancelReplicationTaskAssessmentRun | <p>Cancels a single premigration assessment run.</p> <p>This operation prevents any individual assessments from running if they haven't started running. It also |
| POST | /#X-Amz-Target=AmazonDMSv20160101.CreateEndpoint | <p>Creates an endpoint using the provided settings.</p> <note> <p>For a MySQL source or target endpoint, don't explicitly specify the database using the <code>D |
| POST | /#X-Amz-Target=AmazonDMSv20160101.CreateEventSubscription | <p> Creates an DMS event notification subscription. </p> <p>You can specify the type of source (<code>SourceType</code>) you want to be notified of, provide a l |
| POST | /#X-Amz-Target=AmazonDMSv20160101.CreateFleetAdvisorCollector | Creates a Fleet Advisor collector using the specified parameters. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.CreateReplicationInstance | <p>Creates the replication instance using the specified parameters.</p> <p>DMS requires that your account have certain roles with appropriate permissions before |
| POST | /#X-Amz-Target=AmazonDMSv20160101.CreateReplicationSubnetGroup | <p>Creates a replication subnet group given a list of the subnet IDs in a VPC.</p> <p>The VPC needs to have at least one subnet in at least two availability zon |
| POST | /#X-Amz-Target=AmazonDMSv20160101.CreateReplicationTask | Creates a replication task using the specified parameters. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DeleteCertificate | Deletes the specified certificate. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DeleteConnection | Deletes the connection between a replication instance and an endpoint. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DeleteEndpoint | <p>Deletes the specified endpoint.</p> <note> <p>All tasks associated with the endpoint must be deleted before you can delete the endpoint.</p> </note> <p/> |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DeleteEventSubscription | Deletes an DMS event subscription. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DeleteFleetAdvisorCollector | Deletes the specified Fleet Advisor collector. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DeleteFleetAdvisorDatabases | Deletes the specified Fleet Advisor collector databases. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DeleteReplicationInstance | <p>Deletes the specified replication instance.</p> <note> <p>You must delete any migration tasks that are associated with the replication instance before you ca |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DeleteReplicationSubnetGroup | Deletes a subnet group. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DeleteReplicationTask | Deletes the specified replication task. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DeleteReplicationTaskAssessmentRun | <p>Deletes the record of a single premigration assessment run.</p> <p>This operation removes all metadata that DMS maintains about this assessment run. However, |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeAccountAttributes | <p>Lists all of the DMS attributes for a customer account. These attributes include DMS quotas for the account and a unique account identifier in a particular D |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeApplicableIndividualAssessments | <p>Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters.</p> <p>If you specify an |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeCertificates | Provides a description of the certificate. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeConnections | Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeEndpointSettings | Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeEndpointTypes | Returns information about the type of endpoints available. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeEndpoints | Returns information about the endpoints for your account in the current region. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeEventCategories | Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in <a hr |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeEventSubscriptions | <p>Lists all the event subscriptions for a customer account. The description of a subscription includes <code>SubscriptionName</code>, <code>SNSTopicARN</code>, |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeEvents | Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on DMS events, see <a href="https:// |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeFleetAdvisorCollectors | Returns a list of the Fleet Advisor collectors in your account. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeFleetAdvisorDatabases | Returns a list of Fleet Advisor databases in your account. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeFleetAdvisorLsaAnalysis | Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet Advisor collectors. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeFleetAdvisorSchemaObjectSummary | Provides descriptions of the schemas discovered by your Fleet Advisor collectors. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeFleetAdvisorSchemas | Returns a list of schemas detected by Fleet Advisor Collectors in your account. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeOrderableReplicationInstances | Returns information about the replication instance types that can be created in the specified region. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribePendingMaintenanceActions | For internal use only |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeRecommendationLimitations | Returns a paginated list of limitations for recommendations of target Amazon Web Services engines. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeRecommendations | Returns a paginated list of target engine recommendations for your source databases. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeRefreshSchemasStatus | Returns the status of the RefreshSchemas operation. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeReplicationInstanceTaskLogs | Returns information about the task logs for the specified task. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeReplicationInstances | Returns information about replication instances for your account in the current region. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeReplicationSubnetGroups | Returns information about the replication subnet groups. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeReplicationTaskAssessmentResults | <p>Returns the task assessment results from the Amazon S3 bucket that DMS creates in your Amazon Web Services account. This action always returns the latest res |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeReplicationTaskAssessmentRuns | <p>Returns a paginated list of premigration assessment runs based on filter settings.</p> <p>These filter settings can specify a combination of premigration ass |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeReplicationTaskIndividualAssessments | <p>Returns a paginated list of individual assessments based on filter settings.</p> <p>These filter settings can specify a combination of premigration assessmen |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeReplicationTasks | Returns information about replication tasks for your account in the current region. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeSchemas | <p>Returns information about the schema for the specified endpoint.</p> <p/> |
| POST | /#X-Amz-Target=AmazonDMSv20160101.DescribeTableStatistics | <p>Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.</p> <p>Note that the "last upda |
| POST | /#X-Amz-Target=AmazonDMSv20160101.ImportCertificate | Uploads the specified certificate. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.ListTagsForResource | Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, subnet group, and migration task. For more information, see <a hr |
| POST | /#X-Amz-Target=AmazonDMSv20160101.ModifyEndpoint | <p>Modifies the specified endpoint.</p> <note> <p>For a MySQL source or target endpoint, don't explicitly specify the database using the <code>DatabaseName</cod |
| POST | /#X-Amz-Target=AmazonDMSv20160101.ModifyEventSubscription | Modifies an existing DMS event notification subscription. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.ModifyReplicationInstance | <p>Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the reque |
| POST | /#X-Amz-Target=AmazonDMSv20160101.ModifyReplicationSubnetGroup | Modifies the settings for the specified replication subnet group. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.ModifyReplicationTask | <p>Modifies the specified replication task.</p> <p>You can't modify the task endpoints. The task must be stopped before you can modify it. </p> <p>For more info |
| POST | /#X-Amz-Target=AmazonDMSv20160101.MoveReplicationTask | Moves a replication task from its current replication instance to a different target replication instance using the specified parameters. The target replication |
| POST | /#X-Amz-Target=AmazonDMSv20160101.RebootReplicationInstance | Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.RefreshSchemas | Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by c |
| POST | /#X-Amz-Target=AmazonDMSv20160101.ReloadTables | <p>Reloads the target database table with the source data. </p> <p>You can only use this operation with a task in the <code>RUNNING</code> state, otherwise the |
| POST | /#X-Amz-Target=AmazonDMSv20160101.RemoveTagsFromResource | Removes metadata tags from an DMS resource, including replication instance, endpoint, subnet group, and migration task. For more information, see <a href="https |
| POST | /#X-Amz-Target=AmazonDMSv20160101.RunFleetAdvisorLsaAnalysis | Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.StartRecommendations | <p>Starts the analysis of your source database to provide recommendations of target engines.</p> <p>You can create recommendations for multiple source databases |
| POST | /#X-Amz-Target=AmazonDMSv20160101.StartReplicationTask | <p>Starts the replication task.</p> <p>For more information about DMS tasks, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html">Work |
| POST | /#X-Amz-Target=AmazonDMSv20160101.StartReplicationTaskAssessment | <p> Starts the replication task assessment for unsupported data types in the source database. </p> <p>You can only use this operation for a task if the followin |
| POST | /#X-Amz-Target=AmazonDMSv20160101.StartReplicationTaskAssessmentRun | <p>Starts a new premigration assessment run for one or more individual assessments of a migration task.</p> <p>The assessments that you can specify depend on th |
| POST | /#X-Amz-Target=AmazonDMSv20160101.StopReplicationTask | Stops the replication task. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.TestConnection | Tests the connection between the replication instance and the endpoint. |
| POST | /#X-Amz-Target=AmazonDMSv20160101.UpdateSubscriptionsToEventBridge | <p>Migrates 10 active and enabled Amazon SNS subscriptions at a time and converts them to corresponding Amazon EventBridge rules. By default, this operation mig |
Questions
Does the AWS Database Migration Service API need an API key?
Yes. The AWS Database Migration Service API uses API key authentication; the documentation explains how to get credentials.
Does the AWS Database Migration Service API support HTTPS?
Yes, the AWS Database Migration Service API is served over HTTPS.
How many endpoints does the AWS Database Migration Service API have?
Its OpenAPI description lists 69 endpoints in version 2016-01-01. All of them are shown on this page.
What are alternatives to the AWS Database Migration Service API?
Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.
Similar cloud platforms APIs
Compare alternatives →Remote Settings PROD
Cloud PlatformsFirefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.
Linode API
Cloud Platforms## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se
DigitalOcean API
Cloud Platforms# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having
Vercel API
Cloud PlatformsVercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Platform API
Cloud PlatformsThe [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Azure Data Lake Storage
Cloud PlatformsAzure Data Lake Storage provides storage for Hadoop and other big data workloads.
Listed from APIs.guru (CC0).