Package-level declarations

Types

Link copied to clipboard

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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard

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 Tag data type description.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Creates a data provider using the provided settings. A data provider stores a data store type and location information about your database.

Link copied to clipboard

Creates an endpoint using the provided settings.

Link copied to clipboard

Creates an DMS event notification subscription.

Link copied to clipboard

Creates a Fleet Advisor collector using the specified parameters.

Link copied to clipboard

Creates the instance profile using the specified parameters.

Link copied to clipboard

Creates the migration project using the specified parameters.

Link copied to clipboard

Creates a configuration that you can later provide to configure and start an DMS Serverless replication. You can also provide options to validate the configuration inputs before you start the replication.

Link copied to clipboard

Creates the replication instance using the specified parameters.

Link copied to clipboard

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

Link copied to clipboard

Creates a replication task using the specified parameters.

Link copied to clipboard

Deletes the specified certificate.

Link copied to clipboard

Deletes the connection between a replication instance and an endpoint.

Link copied to clipboard

Deletes the specified data provider.

Link copied to clipboard

Deletes the specified endpoint.

Link copied to clipboard

Deletes an DMS event subscription.

Link copied to clipboard

Deletes the specified Fleet Advisor collector.

Link copied to clipboard

Deletes the specified Fleet Advisor collector databases.

Link copied to clipboard

Deletes the specified instance profile.

Link copied to clipboard

Deletes the specified migration project.

Link copied to clipboard

Deletes an DMS Serverless replication configuration. This effectively deprovisions any and all replications that use this configuration. You can't delete the configuration for an DMS Serverless replication that is ongoing. You can delete the configuration when the replication is in a non-RUNNING and non-STARTING state.

Link copied to clipboard

Deletes the specified replication instance.

Link copied to clipboard

Deletes the specified replication task.

Link copied to clipboard

Deletes the record of a single premigration assessment run.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Provides a description of the certificate.

Link copied to clipboard

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.

Link copied to clipboard

Returns configuration parameters for a schema conversion project.

Link copied to clipboard

Returns a paginated list of data providers for your account in the current region.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns information about the type of endpoints available.

Link copied to clipboard

Returns information about the replication instance versions used in the project.

Link copied to clipboard

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 Working with Events and Notifications in the Database Migration Service User Guide.

Link copied to clipboard

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 Working with Events and Notifications in the Database Migration Service User Guide.

Link copied to clipboard

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

Link copied to clipboard

Returns a paginated list of extension pack associations for the specified migration project. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database.

Link copied to clipboard

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

Link copied to clipboard

Returns a list of Fleet Advisor databases in your account.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns a paginated list of instance profiles for your account in the current region.

Link copied to clipboard

Returns a paginated list of metadata model assessments for your account in the current region.

Link copied to clipboard

Returns a paginated list of metadata model conversions for a migration project.

Link copied to clipboard

Returns a paginated list of metadata model imports.

Link copied to clipboard

Returns a paginated list of migration projects for your account in the current region.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns the status of the RefreshSchemas operation.

Link copied to clipboard

Returns one or more existing DMS Serverless replication configurations as a list of structures.

Link copied to clipboard

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

Link copied to clipboard

Returns information about the task logs for the specified task.

Link copied to clipboard

Provides details on replication progress by returning status information for one or more provisioned DMS Serverless replications.

Link copied to clipboard

Returns information about the replication subnet groups.

Link copied to clipboard

Returns table and schema statistics for one or more provisioned replications that use a given DMS Serverless replication configuration.

Link copied to clipboard

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.

Link copied to clipboard

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

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

Link copied to clipboard

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

Link copied to clipboard

Returns information about the schema for the specified endpoint.

Link copied to clipboard

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

Link copied to clipboard

Saves a copy of a database migration assessment report to your Amazon S3 bucket. DMS can save your assessment report as a comma-separated value (CSV) or a PDF file.

Link copied to clipboard

Uploads the specified certificate.

Link copied to clipboard

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

Link copied to clipboard

Modifies the specified schema conversion configuration using the provided parameters.

Link copied to clipboard

Modifies the specified data provider using the provided settings.

Link copied to clipboard

Modifies the specified endpoint.

Link copied to clipboard

Modifies an existing DMS event notification subscription.

Link copied to clipboard

Modifies the specified instance profile using the provided parameters.

Link copied to clipboard

Modifies the specified migration project using the provided parameters.

Link copied to clipboard

Modifies an existing DMS Serverless replication configuration that you can use to start a replication. This command includes input validation and logic to check the state of any replication that uses this configuration. You can only modify a replication configuration before any replication that uses it has started. As soon as you have initially started a replication with a given configuiration, you can't modify that configuration, even if you stop it.

Link copied to clipboard

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.

Link copied to clipboard

Modifies the settings for the specified replication subnet group.

Link copied to clipboard

Modifies the specified replication task.

Link copied to clipboard

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.

Link copied to clipboard

Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.

Link copied to clipboard

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.

Link copied to clipboard

Reloads the target database table with the source data for a given DMS Serverless replication configuration.

Link copied to clipboard

Reloads the target database table with the source data.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Applies the extension pack to your target database. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database.

Link copied to clipboard

Creates a database migration assessment report by assessing the migration complexity for your source database. A database migration assessment report summarizes all of the schema conversion tasks. It also details the action items for database objects that can't be converted to the database engine of your target database instance.

Link copied to clipboard

Converts your source database objects to a format compatible with the target database.

Link copied to clipboard

Saves your converted code to a file as a SQL script, and stores this file on your Amazon S3 bucket.

Link copied to clipboard

Applies converted database objects to your target database.

Link copied to clipboard

Loads the metadata for all the dependent database objects of the parent object.

Link copied to clipboard

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

Link copied to clipboard

For a given DMS Serverless replication configuration, DMS connects to the source endpoint and collects the metadata to analyze the replication workload. Using this metadata, DMS then computes and provisions the required capacity and starts replicating to the target endpoint using the server resources that DMS has provisioned for the DMS Serverless replication.

Link copied to clipboard

Starts the replication task.

Link copied to clipboard

Starts the replication task assessment for unsupported data types in the source database.

Link copied to clipboard

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

Link copied to clipboard

For a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications. This command doesn't deprovision the stopped replications.

Link copied to clipboard

Stops the replication task.

Link copied to clipboard

Tests the connection between the replication instance and the endpoint.

Link copied to clipboard

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.5 or higher. If any replication instances are from versions earlier than 3.4.5, the operation raises an error and tells you to upgrade these instances to version 3.4.5 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.5, some types of events might not be available when you use Amazon EventBridge.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.