modify_replication_task ¶

def modify_replication_task(
    self,
    replication_task_arn: "capo_database_migration_service.types.string.String",
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
    replication_task_identifier: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    migration_type: Optional[
        "capo_database_migration_service.types.migration_type_value.MigrationTypeValue"
    ] = None,
    table_mappings: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    replication_task_settings: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    cdc_start_time: Optional[
        "capo_database_migration_service.types.t_stamp.TStamp"
    ] = None,
    cdc_start_position: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    cdc_stop_position: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    task_data: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
) -> "capo_database_migration_service.types.modify_replication_task_response.ModifyReplicationTaskResponse":
    """<p>Modifies the specified replication task.</p> <p>You can't modify the task endpoints. The task must be stopped before you can modify it. </p> <p>For more information about DMS tasks, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html">Working with Migration Tasks</a> in the <i>Database Migration Service User Guide</i>.</p>

    Args:
        replication_task_arn: <p>The Amazon Resource Name (ARN) of the replication task.</p>
        replication_task_identifier: <p>The replication task identifier.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1-255 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>
        migration_type: <p>The migration type. Valid values: <code>full-load</code> | <code>cdc</code> | <code>full-load-and-cdc</code> </p>
        table_mappings: <p>When using the CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with <code>file://</code>. For example, <code>--table-mappings file://mappingfile.json</code>. When working with the DMS API, provide the JSON as the parameter value. </p>
        replication_task_settings: <p>JSON file that contains settings for the task, such as task metadata settings.</p>
        cdc_start_time: <p>Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.</p> <p>Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”</p>
        cdc_start_position: <p>Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.</p> <p> The value can be in date, checkpoint, or LSN/SCN format.</p> <p>Date Example: --cdc-start-position “2018-03-08T12:12:12”</p> <p>Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"</p> <p>LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”</p> <note> <p>When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the <code>slotName</code> extra connection attribute to the name of this logical replication slot. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib">Extra Connection Attributes When Using PostgreSQL as a Source for DMS</a>.</p> </note>
        cdc_stop_position: <p>Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.</p> <p>Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”</p> <p>Commit time example: --cdc-stop-position “commit_time:2018-02-09T12:12:12“</p>
        task_data: <p>Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html">Specifying Supplemental Data for Task Settings</a> in the <i>Database Migration Service User Guide.</i> </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.kms_key_not_accessible_fault.KMSKeyNotAccessibleFault: <p>DMS cannot access the KMS key.</p>
        capo_database_migration_service.errors.resource_already_exists_fault.ResourceAlreadyExistsFault: <p>The resource you are attempting to create already exists.</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.modify_replication_task_message.ModifyReplicationTaskMessage]",
    ) -> OperationResponse[
        "capo_database_migration_service.types.modify_replication_task_response.ModifyReplicationTaskResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.modify_replication_task

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyReplicationTask")
    )
    input_: capo_database_migration_service.types.modify_replication_task_message.ModifyReplicationTaskMessage = {
        "replication_task_arn": replication_task_arn
    }
    if replication_task_identifier is not None:
        input_["replication_task_identifier"] = replication_task_identifier
    if migration_type is not None:
        input_["migration_type"] = migration_type
    if table_mappings is not None:
        input_["table_mappings"] = table_mappings
    if replication_task_settings is not None:
        input_["replication_task_settings"] = replication_task_settings
    if cdc_start_time is not None:
        input_["cdc_start_time"] = cdc_start_time
    if cdc_start_position is not None:
        input_["cdc_start_position"] = cdc_start_position
    if cdc_stop_position is not None:
        input_["cdc_stop_position"] = cdc_stop_position
    if task_data is not None:
        input_["task_data"] = task_data

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