Skip to content

stop_replication_task

stop_replication_task(
    replication_task_arn: String,
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
) -> StopReplicationTaskResponse

Stops the replication task.

Parameters:

  • replication_task_arn (String) –

    The Amazon Resource Name(ARN) of the replication task to be stopped.

Raises:

Examples:

Stop replication task Stops the replication task.

>>> client.stop_replication_task(replication_task_arn='arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E')
Source code in docs_src/capo_database_migration_service/_services/database_migration_service.py
def stop_replication_task(
    self,
    replication_task_arn: "capo_database_migration_service.types.string.String",
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
) -> "capo_database_migration_service.types.stop_replication_task_response.StopReplicationTaskResponse":
    """<p>Stops the replication task.</p>

    Args:
        replication_task_arn: <p>The Amazon Resource Name(ARN) of the replication task to be stopped.</p>

    Raises:
        capo_database_migration_service.errors.invalid_resource_state_fault.InvalidResourceStateFault: <p>The resource is in a state that prevents it from being used for database migration.</p>
        capo_database_migration_service.errors.resource_not_found_fault.ResourceNotFoundFault: <p>The resource could not be found.</p>
        capo_database_migration_service.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Stop replication task
        Stops the replication task.

        >>> client.stop_replication_task(replication_task_arn='arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E')
    """

    def _handler(
        req: "OperationRequest[capo_database_migration_service.types.stop_replication_task_message.StopReplicationTaskMessage]",
    ) -> OperationResponse[
        "capo_database_migration_service.types.stop_replication_task_response.StopReplicationTaskResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.stop_replication_task

        output, http_response = (
            capo_database_migration_service._operations.amazon_dm_sv20160101.stop_replication_task.stop_replication_task(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopReplicationTask")
    )
    input_: capo_database_migration_service.types.stop_replication_task_message.StopReplicationTaskMessage = {
        "replication_task_arn": replication_task_arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output