Skip to content

stop_data_migration

stop_data_migration(
    data_migration_identifier: String,
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
) -> StopDataMigrationResponse

Stops the specified data migration.

Parameters:

  • data_migration_identifier (String) –

    The identifier (name or ARN) of the data migration to stop.

Raises:

Source code in docs_src/capo_database_migration_service/_services/database_migration_service.py
def stop_data_migration(
    self,
    data_migration_identifier: "capo_database_migration_service.types.string.String",
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
) -> "capo_database_migration_service.types.stop_data_migration_response.StopDataMigrationResponse":
    """<p>Stops the specified data migration.</p>

    Args:
        data_migration_identifier: <p>The identifier (name or ARN) of the data migration to stop.</p>

    Raises:
        capo_database_migration_service.errors.failed_dependency_fault.FailedDependencyFault: <p>A dependency threw an exception.</p>
        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.
    """

    def _handler(
        req: "OperationRequest[capo_database_migration_service.types.stop_data_migration_message.StopDataMigrationMessage]",
    ) -> OperationResponse[
        "capo_database_migration_service.types.stop_data_migration_response.StopDataMigrationResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.stop_data_migration

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

    def _redact_output(
        output: "capo_database_migration_service.types.stop_data_migration_response.StopDataMigrationResponse",
    ) -> dict[str, Any]:
        import capo_database_migration_service.types.stop_data_migration_response

        return capo_database_migration_service.types.stop_data_migration_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("StopDataMigration", redact_output=_redact_output),
    )
    input_: capo_database_migration_service.types.stop_data_migration_message.StopDataMigrationMessage = {
        "data_migration_identifier": data_migration_identifier
    }

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