airflow.providers.amazon.aws.hooks.dms

Module Contents

Classes

DmsTaskWaiterStatus

Available AWS DMS Task Waiter statuses.

DmsHook

Interact with AWS Database Migration Service (DMS).
class airflow.providers.amazon.aws.hooks.dms.DmsTaskWaiterStatus[source]

Bases: str, enum.Enum

Available AWS DMS Task Waiter statuses.

DELETED = 'deleted'[source]
READY = 'ready'[source]
RUNNING = 'running'[source]
STOPPED = 'stopped'[source]
class airflow.providers.amazon.aws.hooks.dms.DmsHook(*args, **kwargs)[source]

Bases: airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook

Interact with AWS Database Migration Service (DMS).

Provide thin wrapper around boto3.client("dms").

Additional arguments (such as aws_conn_id) may be specified and are passed down to the underlying AwsBaseHook.

See also

describe_replication_tasks(**kwargs)[source]

Describe replication tasks.

See also

Returns

Marker and list of replication tasks

Return type

tuple[str | None, list]

find_replication_tasks_by_arn(replication_task_arn, without_settings=False)[source]

Find and describe replication tasks by task ARN.

See also

Parameters

  • replication_task_arn (str) – Replication task arn

  • without_settings (bool | None) – Indicates whether to return task information with settings.

Returns

list of replication tasks that match the ARN

get_task_status(replication_task_arn)[source]

Retrieve task status.

Parameters

replication_task_arn (str) – Replication task ARN

Returns

Current task status

Return type

str | None

create_replication_task(replication_task_id, source_endpoint_arn, target_endpoint_arn, replication_instance_arn, migration_type, table_mappings, **kwargs)[source]

Create DMS replication task.

See also

Parameters

  • replication_task_id (str) – Replication task id

  • source_endpoint_arn (str) – Source endpoint ARN

  • target_endpoint_arn (str) – Target endpoint ARN

  • replication_instance_arn (str) – Replication instance ARN

  • table_mappings (dict) – Table mappings

  • migration_type (str) – Migration type (‘full-load’|’cdc’|’full-load-and-cdc’), full-load by default.

Returns

Replication task ARN

Return type

str

start_replication_task(replication_task_arn, start_replication_task_type, **kwargs)[source]

Start replication task.

See also

Parameters

  • replication_task_arn (str) – Replication task ARN

  • start_replication_task_type (str) – Replication task start type (default=’start-replication’) (‘start-replication’|’resume-processing’|’reload-target’)

stop_replication_task(replication_task_arn)[source]

Stop replication task.

See also

Parameters

replication_task_arn – Replication task ARN

delete_replication_task(replication_task_arn)[source]

Start replication task deletion and waits for it to be deleted.

See also

Parameters

replication_task_arn – Replication task ARN

wait_for_task_status(replication_task_arn, status)[source]

Wait for replication task to reach status; supported statuses: deleted, ready, running, stopped.

Parameters
describe_replication_configs(filters=None, **kwargs)[source]

Return list of serverless replication configs.

See also

Parameters

filters (list[dict] | None) – List of filter objects

Returns

List of replication tasks

Return type

list[dict]

create_replication_config(replication_config_id, source_endpoint_arn, target_endpoint_arn, compute_config, replication_type, table_mappings, additional_config_kwargs=None, **kwargs)[source]

Create an AWS DMS Serverless configuration that can be used to start an DMS Serverless replication.

See also

Parameters

  • replicationConfigId – Unique identifier used to create a ReplicationConfigArn.

  • sourceEndpointArn – ARN of the source endpoint

  • targetEndpointArn – ARN of the target endpoint

  • computeConfig – Parameters for provisioning an DMS Serverless replication.

  • replicationType – type of DMS Serverless replication

  • tableMappings – JSON table mappings

  • tags – Key-value tag pairs

  • resourceId – Unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource.

  • supplementalSettings – JSON settings for specifying supplemental data

  • replicationSettings – JSON settings for DMS Serverless replications

Returns

ReplicationConfigArn

describe_replications(filters=None, **kwargs)[source]

Return list of serverless replications.

See also

Parameters

filters (list[dict[str, Any]] | None) – List of filter objects

Returns

List of replications

Return type

list[dict]

delete_replication_config(replication_config_arn, delay=60, max_attempts=120)[source]

Delete an AWS DMS Serverless configuration.

See also

Parameters

replication_config_arn (str) – ReplicationConfigArn

start_replication(replication_config_arn, start_replication_type, cdc_start_time=None, cdc_start_pos=None, cdc_stop_pos=None)[source]
stop_replication(replication_config_arn)[source]
get_provision_status(replication_config_arn)[source]

Get the provisioning status for a serverless replication.

Was this entry helpful?