AWS.DatabaseMigration (aws-elixir v0.8.0) View Source

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 What Is Database Migration Service? in the Database Migration Service User Guide.

Link to this section Summary

Functions

Adds metadata tags to an DMS resource, including replication instance, endpoint, security group, and migration task.

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

Cancels a single premigration assessment run.

Creates an endpoint using the provided settings.

Creates an DMS event notification subscription.

Creates the replication instance using the specified parameters.

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

Creates a replication task using the specified parameters.

Deletes the specified certificate.

Deletes the connection between a replication instance and an endpoint.

Deletes the specified endpoint.

Deletes an DMS event subscription.

Deletes the specified replication instance.

Deletes the specified replication task.

Deletes the record of a single premigration assessment run.

Lists all of the DMS attributes for a customer account.

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

Provides a description of the certificate.

Describes the status of the connections that have been made between the replication instance and an endpoint.

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

Returns information about the type of endpoints available.

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

Lists categories for all event source types, or, if specified, for a specified source type.

Lists all the event subscriptions for a customer account.

Lists events for a given source identifier and source type.

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

Returns the status of the RefreshSchemas operation.

Returns information about the task logs for the specified task.

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

Returns information about the replication subnet groups.

Returns the task assessment results from the Amazon S3 bucket that DMS creates in your account.

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

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

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

Returns information about the schema for the specified endpoint.

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

Uploads the specified certificate.

Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, security group, and migration task.

Modifies the specified endpoint.

Modifies an existing DMS event notification subscription.

Modifies the replication instance to apply new settings.

Modifies the settings for the specified replication subnet group.

Modifies the specified replication task.

Moves a replication task from its current replication instance to a different target replication instance using the specified parameters.

Populates the schema for the specified endpoint.

Reloads the target database table with the source data.

Removes metadata tags from an DMS resource, including replication instance, endpoint, security group, and migration task.

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

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

Tests the connection between the replication instance and the endpoint.

Link to this section Functions

Link to this function

add_tags_to_resource(client, input, options \\ [])

View Source

Adds metadata tags to an DMS resource, including replication instance, endpoint, security 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 to this function

apply_pending_maintenance_action(client, input, options \\ [])

View Source

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

Link to this function

cancel_replication_task_assessment_run(client, input, options \\ [])

View Source

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.

Link to this function

create_endpoint(client, input, options \\ [])

View Source

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.

Link to this function

create_event_subscription(client, input, options \\ [])

View Source

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

Link to this function

create_replication_instance(client, input, options \\ [])

View Source

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 Creating the IAM Roles to Use With the CLI and DMS API. For information on the required permissions, see IAM Permissions Needed to Use DMS.

Link to this function

create_replication_subnet_group(client, input, options \\ [])

View Source

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

Link to this function

create_replication_task(client, input, options \\ [])

View Source

Creates a replication task using the specified parameters.

Link to this function

delete_certificate(client, input, options \\ [])

View Source

Deletes the specified certificate.

Link to this function

delete_connection(client, input, options \\ [])

View Source

Deletes the connection between a replication instance and an endpoint.

Link to this function

delete_endpoint(client, input, options \\ [])

View Source

Deletes the specified endpoint.

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

Link to this function

delete_event_subscription(client, input, options \\ [])

View Source

Deletes an DMS event subscription.

Link to this function

delete_replication_instance(client, input, options \\ [])

View Source

Deletes the specified replication instance.

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

Link to this function

delete_replication_subnet_group(client, input, options \\ [])

View Source

Deletes a subnet group.

Link to this function

delete_replication_task(client, input, options \\ [])

View Source

Deletes the specified replication task.

Link to this function

delete_replication_task_assessment_run(client, input, options \\ [])

View Source

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.

Link to this function

describe_account_attributes(client, input, options \\ [])

View Source

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.

Link to this function

describe_applicable_individual_assessments(client, input, options \\ [])

View Source

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.

Link to this function

describe_certificates(client, input, options \\ [])

View Source

Provides a description of the certificate.

Link to this function

describe_connections(client, input, options \\ [])

View Source

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 to this function

describe_endpoint_settings(client, input, options \\ [])

View Source

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

Link to this function

describe_endpoint_types(client, input, options \\ [])

View Source

Returns information about the type of endpoints available.

Link to this function

describe_endpoints(client, input, options \\ [])

View Source

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

Link to this function

describe_event_categories(client, input, options \\ [])

View Source

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 to this function

describe_event_subscriptions(client, input, options \\ [])

View Source

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.

Link to this function

describe_events(client, input, options \\ [])

View Source

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 to this function

describe_orderable_replication_instances(client, input, options \\ [])

View Source

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

Link to this function

describe_pending_maintenance_actions(client, input, options \\ [])

View Source

For internal use only

Link to this function

describe_refresh_schemas_status(client, input, options \\ [])

View Source

Returns the status of the RefreshSchemas operation.

Link to this function

describe_replication_instance_task_logs(client, input, options \\ [])

View Source

Returns information about the task logs for the specified task.

Link to this function

describe_replication_instances(client, input, options \\ [])

View Source

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

Link to this function

describe_replication_subnet_groups(client, input, options \\ [])

View Source

Returns information about the replication subnet groups.

Link to this function

describe_replication_task_assessment_results(client, input, options \\ [])

View Source

Returns the task assessment results from the Amazon S3 bucket that DMS creates in your account.

This action always returns the latest results.

For more information about DMS task assessments, see Creating a task assessment report in the Database Migration Service User Guide.

Link to this function

describe_replication_task_assessment_runs(client, input, options \\ [])

View Source

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.

Link to this function

describe_replication_task_individual_assessments(client, input, options \\ [])

View Source

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.

Link to this function

describe_replication_tasks(client, input, options \\ [])

View Source

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

Link to this function

describe_schemas(client, input, options \\ [])

View Source

Returns information about the schema for the specified endpoint.

Link to this function

describe_table_statistics(client, input, options \\ [])

View Source

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.

Link to this function

import_certificate(client, input, options \\ [])

View Source

Uploads the specified certificate.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, security group, and migration task.

For more information, see Tag data type description.

Link to this function

modify_endpoint(client, input, options \\ [])

View Source

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.

Link to this function

modify_event_subscription(client, input, options \\ [])

View Source

Modifies an existing DMS event notification subscription.

Link to this function

modify_replication_instance(client, input, options \\ [])

View Source

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.

Link to this function

modify_replication_subnet_group(client, input, options \\ [])

View Source

Modifies the settings for the specified replication subnet group.

Link to this function

modify_replication_task(client, input, options \\ [])

View Source

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

Link to this function

move_replication_task(client, input, options \\ [])

View Source

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 to this function

reboot_replication_instance(client, input, options \\ [])

View Source

Reboots a replication instance.

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

Link to this function

refresh_schemas(client, input, options \\ [])

View Source

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 to this function

reload_tables(client, input, options \\ [])

View Source

Reloads the target database table with the source data.

Link to this function

remove_tags_from_resource(client, input, options \\ [])

View Source

Removes metadata tags from an DMS resource, including replication instance, endpoint, security group, and migration task.

For more information, see Tag data type description.

Link to this function

start_replication_task(client, input, options \\ [])

View Source

Starts the replication task.

For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.

Link to this function

start_replication_task_assessment(client, input, options \\ [])

View Source

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

Link to this function

start_replication_task_assessment_run(client, input, options \\ [])

View Source

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.

Link to this function

stop_replication_task(client, input, options \\ [])

View Source

Stops the replication task.

Link to this function

test_connection(client, input, options \\ [])

View Source

Tests the connection between the replication instance and the endpoint.