amazonaws.com – dms

OpenAPI apis-guru cloud

Database Migration Service

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.

For more information about DMS, see in the Database Migration Service User Guide.

Homepage: https://api.apis.guru/v2/specs/amazonaws.com:dms/2016-01-01.json
Provider: amazonaws.com:dms / dms
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/amazonaws.com/dms/2016-01-01/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/amazonaws.com/dms/2016-01-01/openapi.yaml

Tools (71)

Extracted live via the executor SDK.

xAmzTargetAmazonDmSv20160101AddTagsToResource.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 allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS. For more information, see data type description.
xAmzTargetAmazonDmSv20160101ApplyPendingMaintenanceAction.applyPendingMaintenanceAction

Applies a pending maintenance action to a resource (for example, to a replication instance).
xAmzTargetAmazonDmSv20160101BatchStartRecommendations.batchStartRecommendations

Starts the analysis of up to 20 source databases to recommend target engines for each source database. This is a batch version of .

The result of analysis of each source database is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
xAmzTargetAmazonDmSv20160101CancelReplicationTaskAssessmentRun.cancelReplicationTaskAssessmentRun

Cancels a single premigration assessment run.

This operation prevents any individual assessments from running if they haven't started running. It also attempts to cancel any individual assessments that are currently running.
xAmzTargetAmazonDmSv20160101CreateEndpoint.createEndpoint

Creates an endpoint using the provided settings.

For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the CreateEndpoint API call. Specifying DatabaseName when you create a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.
xAmzTargetAmazonDmSv20160101CreateEventSubscription.createEventSubscription

Creates an DMS event notification subscription.

You can specify the type of source (SourceType) you want to be notified of, provide a list of DMS source IDs (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. If you specify both the SourceType and SourceIds, such as SourceType = replication-instance and SourceIdentifier = my-replinstance, you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don't specify a SourceIdentifier, you receive notice of the events for that source type for all your DMS sources. If you don't specify either SourceType nor SourceIdentifier, you will be notified of events generated from all DMS sources belonging to your customer account.

For more information about DMS events, see in the Database Migration Service User Guide.
xAmzTargetAmazonDmSv20160101CreateFleetAdvisorCollector.createFleetAdvisorCollector

Creates a Fleet Advisor collector using the specified parameters.
xAmzTargetAmazonDmSv20160101CreateReplicationInstance.createReplicationInstance

Creates the replication instance using the specified parameters.

DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see . For information on the required permissions, see .
xAmzTargetAmazonDmSv20160101CreateReplicationSubnetGroup.createReplicationSubnetGroup

Creates a replication subnet group given a list of the subnet IDs in a VPC.

The VPC needs to have at least one subnet in at least two availability zones in the Amazon Web Services Region, otherwise the service will throw a ReplicationSubnetGroupDoesNotCoverEnoughAZs exception.
xAmzTargetAmazonDmSv20160101CreateReplicationTask.createReplicationTask

Creates a replication task using the specified parameters.
xAmzTargetAmazonDmSv20160101DeleteCertificate.deleteCertificate

Deletes the specified certificate.
xAmzTargetAmazonDmSv20160101DeleteConnection.deleteConnection

Deletes the connection between a replication instance and an endpoint.
xAmzTargetAmazonDmSv20160101DeleteEndpoint.deleteEndpoint

Deletes the specified endpoint.

All tasks associated with the endpoint must be deleted before you can delete the endpoint.
xAmzTargetAmazonDmSv20160101DeleteEventSubscription.deleteEventSubscription

Deletes an DMS event subscription.
xAmzTargetAmazonDmSv20160101DeleteFleetAdvisorCollector.deleteFleetAdvisorCollector

Deletes the specified Fleet Advisor collector.
xAmzTargetAmazonDmSv20160101DeleteFleetAdvisorDatabases.deleteFleetAdvisorDatabases

Deletes the specified Fleet Advisor collector databases.
xAmzTargetAmazonDmSv20160101DeleteReplicationInstance.deleteReplicationInstance

Deletes the specified replication instance.

You must delete any migration tasks that are associated with the replication instance before you can delete it.
xAmzTargetAmazonDmSv20160101DeleteReplicationSubnetGroup.deleteReplicationSubnetGroup

Deletes a subnet group.
xAmzTargetAmazonDmSv20160101DeleteReplicationTask.deleteReplicationTask

Deletes the specified replication task.
xAmzTargetAmazonDmSv20160101DeleteReplicationTaskAssessmentRun.deleteReplicationTaskAssessmentRun

Deletes the record of a single premigration assessment run.

This operation removes all metadata that DMS maintains about this assessment run. However, the operation leaves untouched all information about this assessment run that is stored in your Amazon S3 bucket.
xAmzTargetAmazonDmSv20160101DescribeAccountAttributes.describeAccountAttributes

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 DMS region. DMS quotas include a list of resource quotas supported by the account, such as the number of replication instances allowed. The description for each resource quota, includes the quota name, current usage toward that quota, and the quota's maximum value. DMS uses the unique account identifier to name each artifact used by DMS in the given region.

This command does not take any parameters.
xAmzTargetAmazonDmSv20160101DescribeApplicableIndividualAssessments.describeApplicableIndividualAssessments

Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters.

If you specify an existing migration task, this operation provides the default individual assessments you can specify for that task. Otherwise, the specified parameters model elements of a possible migration task on which to base a premigration assessment run.

To use these migration task modeling parameters, you must specify an existing replication instance, a source database engine, a target database engine, and a migration type. This combination of parameters potentially limits the default individual assessments available for an assessment run created for a corresponding migration task.

If you specify no parameters, this operation provides a list of all possible individual assessments that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must specify all of them or the operation cannot provide a list of individual assessments. The only parameter that you can specify alone is for an existing migration task. The specified task definition then determines the default list of individual assessments that you can specify in an assessment run for the task.
xAmzTargetAmazonDmSv20160101DescribeCertificates.describeCertificates

Provides a description of the certificate.
xAmzTargetAmazonDmSv20160101DescribeConnections.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.
xAmzTargetAmazonDmSv20160101DescribeEndpoints.describeEndpoints

Returns information about the endpoints for your account in the current region.
xAmzTargetAmazonDmSv20160101DescribeEndpointSettings.describeEndpointSettings

Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.
xAmzTargetAmazonDmSv20160101DescribeEndpointTypes.describeEndpointTypes

Returns information about the type of endpoints available.
xAmzTargetAmazonDmSv20160101DescribeEventCategories.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 in the Database Migration Service User Guide.
xAmzTargetAmazonDmSv20160101DescribeEvents.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 in the Database Migration Service User Guide.
xAmzTargetAmazonDmSv20160101DescribeEventSubscriptions.describeEventSubscriptions

Lists all the event subscriptions for a customer account. The description of a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify SubscriptionName, this action lists the description for that subscription.
xAmzTargetAmazonDmSv20160101DescribeFleetAdvisorCollectors.describeFleetAdvisorCollectors

Returns a list of the Fleet Advisor collectors in your account.
xAmzTargetAmazonDmSv20160101DescribeFleetAdvisorDatabases.describeFleetAdvisorDatabases

Returns a list of Fleet Advisor databases in your account.
xAmzTargetAmazonDmSv20160101DescribeFleetAdvisorLsaAnalysis.describeFleetAdvisorLsaAnalysis

Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet Advisor collectors.
xAmzTargetAmazonDmSv20160101DescribeFleetAdvisorSchemaObjectSummary.describeFleetAdvisorSchemaObjectSummary

Provides descriptions of the schemas discovered by your Fleet Advisor collectors.
xAmzTargetAmazonDmSv20160101DescribeFleetAdvisorSchemas.describeFleetAdvisorSchemas

Returns a list of schemas detected by Fleet Advisor Collectors in your account.
xAmzTargetAmazonDmSv20160101DescribeOrderableReplicationInstances.describeOrderableReplicationInstances

Returns information about the replication instance types that can be created in the specified region.
xAmzTargetAmazonDmSv20160101DescribePendingMaintenanceActions.describePendingMaintenanceActions

For internal use only
xAmzTargetAmazonDmSv20160101DescribeRecommendationLimitations.describeRecommendationLimitations

Returns a paginated list of limitations for recommendations of target Amazon Web Services engines.
xAmzTargetAmazonDmSv20160101DescribeRecommendations.describeRecommendations

Returns a paginated list of target engine recommendations for your source databases.
xAmzTargetAmazonDmSv20160101DescribeRefreshSchemasStatus.describeRefreshSchemasStatus

Returns the status of the RefreshSchemas operation.
xAmzTargetAmazonDmSv20160101DescribeReplicationInstances.describeReplicationInstances

Returns information about replication instances for your account in the current region.
xAmzTargetAmazonDmSv20160101DescribeReplicationInstanceTaskLogs.describeReplicationInstanceTaskLogs

Returns information about the task logs for the specified task.
xAmzTargetAmazonDmSv20160101DescribeReplicationSubnetGroups.describeReplicationSubnetGroups

Returns information about the replication subnet groups.
xAmzTargetAmazonDmSv20160101DescribeReplicationTaskAssessmentResults.describeReplicationTaskAssessmentResults

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 results.

For more information about DMS task assessments, see in the Database Migration Service User Guide.
xAmzTargetAmazonDmSv20160101DescribeReplicationTaskAssessmentRuns.describeReplicationTaskAssessmentRuns

Returns a paginated list of premigration assessment runs based on filter settings.

These filter settings can specify a combination of premigration assessment runs, migration tasks, replication instances, and assessment run status values.

This operation doesn't return information about individual assessments. For this information, see the DescribeReplicationTaskIndividualAssessments operation.
xAmzTargetAmazonDmSv20160101DescribeReplicationTaskIndividualAssessments.describeReplicationTaskIndividualAssessments

Returns a paginated list of individual assessments based on filter settings.

These filter settings can specify a combination of premigration assessment runs, migration tasks, and assessment status values.
xAmzTargetAmazonDmSv20160101DescribeReplicationTasks.describeReplicationTasks

Returns information about replication tasks for your account in the current region.
xAmzTargetAmazonDmSv20160101DescribeSchemas.describeSchemas

Returns information about the schema for the specified endpoint.
xAmzTargetAmazonDmSv20160101DescribeTableStatistics.describeTableStatistics

Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.

Note that the "last updated" column the DMS console only indicates the time that DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.
xAmzTargetAmazonDmSv20160101ImportCertificate.importCertificate

Uploads the specified certificate.
xAmzTargetAmazonDmSv20160101ListTagsForResource.listTagsForResource

Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, subnet group, and migration task. For more information, see data type description.
xAmzTargetAmazonDmSv20160101ModifyEndpoint.modifyEndpoint

Modifies the specified endpoint.

For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the ModifyEndpoint API call. Specifying DatabaseName when you modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.
xAmzTargetAmazonDmSv20160101ModifyEventSubscription.modifyEventSubscription

Modifies an existing DMS event notification subscription.
xAmzTargetAmazonDmSv20160101ModifyReplicationInstance.modifyReplicationInstance

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 request.

Some settings are applied during the maintenance window.
xAmzTargetAmazonDmSv20160101ModifyReplicationSubnetGroup.modifyReplicationSubnetGroup

Modifies the settings for the specified replication subnet group.
xAmzTargetAmazonDmSv20160101ModifyReplicationTask.modifyReplicationTask

Modifies the specified replication task.

You can't modify the task endpoints. The task must be stopped before you can modify it.

For more information about DMS tasks, see in the Database Migration Service User Guide.
xAmzTargetAmazonDmSv20160101MoveReplicationTask.moveReplicationTask

Moves a replication task from its current replication instance to a different target replication instance using the specified parameters. The target replication instance must be created with the same or later DMS version as the current replication instance.
xAmzTargetAmazonDmSv20160101RebootReplicationInstance.rebootReplicationInstance

Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.
xAmzTargetAmazonDmSv20160101RefreshSchemas.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 calling the DescribeRefreshSchemasStatus operation.
xAmzTargetAmazonDmSv20160101ReloadTables.reloadTables

Reloads the target database table with the source data.

You can only use this operation with a task in the RUNNING state, otherwise the service will throw an InvalidResourceStateFault exception.
xAmzTargetAmazonDmSv20160101RemoveTagsFromResource.removeTagsFromResource

Removes metadata tags from an DMS resource, including replication instance, endpoint, subnet group, and migration task. For more information, see data type description.
xAmzTargetAmazonDmSv20160101RunFleetAdvisorLsaAnalysis.runFleetAdvisorLsaAnalysis

Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account.
xAmzTargetAmazonDmSv20160101StartRecommendations.startRecommendations

Starts the analysis of your source database to provide recommendations of target engines.

You can create recommendations for multiple source databases using .
xAmzTargetAmazonDmSv20160101StartReplicationTask.startReplicationTask

Starts the replication task.

For more information about DMS tasks, see in the Database Migration Service User Guide.
xAmzTargetAmazonDmSv20160101StartReplicationTaskAssessment.startReplicationTaskAssessment
Starts the replication task assessment for unsupported data types in the source database.

You can only use this operation for a task if the following conditions are true:
- The task must be in the stopped state.
- The task must have successful connections to the source and target.
If either of these conditions are not met, an InvalidResourceStateFault error will result.

For information about DMS task assessments, see in the Database Migration Service User Guide.
xAmzTargetAmazonDmSv20160101StartReplicationTaskAssessmentRun.startReplicationTaskAssessmentRun

Starts a new premigration assessment run for one or more individual assessments of a migration task.

The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete.
xAmzTargetAmazonDmSv20160101StopReplicationTask.stopReplicationTask

Stops the replication task.
xAmzTargetAmazonDmSv20160101TestConnection.testConnection

Tests the connection between the replication instance and the endpoint.
xAmzTargetAmazonDmSv20160101UpdateSubscriptionsToEventBridge.updateSubscriptionsToEventBridge

Migrates 10 active and enabled Amazon SNS subscriptions at a time and converts them to corresponding Amazon EventBridge rules. By default, this operation migrates subscriptions only when all your replication instance versions are 3.4.6 or higher. If any replication instances are from versions earlier than 3.4.6, the operation raises an error and tells you to upgrade these instances to version 3.4.6 or higher. To enable migration regardless of version, set the Force option to true. However, if you don't upgrade instances earlier than version 3.4.6, some types of events might not be available when you use Amazon EventBridge.

To call this operation, make sure that you have certain permissions added to your user account. For more information, see in the Amazon Web Services Database Migration Service User Guide.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools