Skip to content

modify_migration_project async

modify_migration_project(
    migration_project_identifier: String,
    *,
    config_overrides: Optional[AsyncDatabaseMigrationServiceClientConfig] = None,
    migration_project_name: Optional[String] = None,
    source_data_provider_descriptors: Optional[
        DataProviderDescriptorDefinitionList
    ] = None,
    target_data_provider_descriptors: Optional[
        DataProviderDescriptorDefinitionList
    ] = None,
    instance_profile_identifier: Optional[String] = None,
    transformation_rules: Optional[String] = None,
    description: Optional[String] = None,
    schema_conversion_application_attributes: Optional[SCApplicationAttributes] = None,
) -> ModifyMigrationProjectResponse

Modifies the specified migration project using the provided parameters.

Required permissions: dms:UpdateMigrationProject. For more information, see Actions, resources, and condition keys for Database Migration Service.

The migration project must be closed before you can modify it.

Parameters:

  • migration_project_identifier (String) –

    The identifier of the migration project. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.

  • migration_project_name (Optional[String], default: None ) –

    A user-friendly name for the migration project.

  • source_data_provider_descriptors (Optional[DataProviderDescriptorDefinitionList], default: None ) –

    Information about the source data provider, including the name, ARN, and Amazon Web Services Secrets Manager parameters.

  • target_data_provider_descriptors (Optional[DataProviderDescriptorDefinitionList], default: None ) –

    Information about the target data provider, including the name, ARN, and Amazon Web Services Secrets Manager parameters.

  • instance_profile_identifier (Optional[String], default: None ) –

    The name or Amazon Resource Name (ARN) for the instance profile.

  • transformation_rules (Optional[String], default: None ) –

    A JSON string that specifies the transformation rules for the migration project. Transformation rules let you customize how DMS Schema Conversion converts your source database objects, including renaming, adding prefixes or suffixes, and changing data types. For the transformation rule format and examples, see Transformation rules in DMS Schema Conversion.

    Homogeneous data migrations do not support transformation rules.

  • description (Optional[String], default: None ) –

    A user-friendly description of the migration project.

  • schema_conversion_application_attributes (Optional[SCApplicationAttributes], default: None ) –

    The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.

Raises:

Examples:

Modify a migration project The following example updates the source data provider and description of a migration project.

>>> await client.modify_migration_project(migration_project_identifier='arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS', description='Updated migration project description', source_data_provider_descriptors=[{'DataProviderIdentifier': 'arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS'}])
Source code in docs_src/capo_database_migration_service/_services/async_database_migration_service.py
async def modify_migration_project(
    self,
    migration_project_identifier: "capo_database_migration_service.types.string.String",
    *,
    config_overrides: Optional[AsyncDatabaseMigrationServiceClientConfig] = None,
    migration_project_name: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    source_data_provider_descriptors: Optional[
        "capo_database_migration_service.types.data_provider_descriptor_definition_list.DataProviderDescriptorDefinitionList"
    ] = None,
    target_data_provider_descriptors: Optional[
        "capo_database_migration_service.types.data_provider_descriptor_definition_list.DataProviderDescriptorDefinitionList"
    ] = None,
    instance_profile_identifier: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    transformation_rules: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    description: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    schema_conversion_application_attributes: Optional[
        "capo_database_migration_service.types.sc_application_attributes.SCApplicationAttributes"
    ] = None,
) -> "capo_database_migration_service.types.modify_migration_project_response.ModifyMigrationProjectResponse":
    """<p>Modifies the specified migration project using the provided parameters.</p> <p> <b>Required permissions:</b> <code>dms:UpdateMigrationProject</code>. For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p> <note> <p>The migration project must be closed before you can modify it.</p> </note>

    Args:
        migration_project_identifier: <p>The identifier of the migration project. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.</p>
        migration_project_name: <p>A user-friendly name for the migration project.</p>
        source_data_provider_descriptors: <p>Information about the source data provider, including the name, ARN, and Amazon Web Services Secrets Manager parameters.</p>
        target_data_provider_descriptors: <p>Information about the target data provider, including the name, ARN, and Amazon Web Services Secrets Manager parameters.</p>
        instance_profile_identifier: <p>The name or Amazon Resource Name (ARN) for the instance profile.</p>
        transformation_rules: <p>A JSON string that specifies the transformation rules for the migration project. Transformation rules let you customize how DMS Schema Conversion converts your source database objects, including renaming, adding prefixes or suffixes, and changing data types. For the transformation rule format and examples, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/sc-transformation-rules.html">Transformation rules in DMS Schema Conversion</a>.</p> <note> <p>Homogeneous data migrations do not support transformation rules.</p> </note>
        description: <p>A user-friendly description of the migration project.</p>
        schema_conversion_application_attributes: <p>The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.</p>

    Raises:
        capo_database_migration_service.errors.access_denied_fault.AccessDeniedFault: <p>DMS was denied access to the endpoint. Check that the role is correctly configured.</p>
        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.s3_access_denied_fault.S3AccessDeniedFault: <p>Insufficient privileges are preventing access to an Amazon S3 object.</p>
        capo_database_migration_service.errors.s3_resource_not_found_fault.S3ResourceNotFoundFault: <p>A specified Amazon S3 bucket, bucket folder, or other object can't be found.</p>
        capo_database_migration_service.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Modify a migration project
        The following example updates the source data provider and description of a migration project.

        >>> await client.modify_migration_project(migration_project_identifier='arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS', description='Updated migration project description', source_data_provider_descriptors=[{'DataProviderIdentifier': 'arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS'}])
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_database_migration_service.types.modify_migration_project_message.ModifyMigrationProjectMessage]",
    ) -> AsyncOperationResponse[
        "capo_database_migration_service.types.modify_migration_project_response.ModifyMigrationProjectResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.modify_migration_project

        (
            output,
            http_response,
        ) = await capo_database_migration_service._operations.amazon_dm_sv20160101.modify_migration_project.async_modify_migration_project(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyMigrationProject")
    )
    input_: capo_database_migration_service.types.modify_migration_project_message.ModifyMigrationProjectMessage = {
        "migration_project_identifier": migration_project_identifier
    }
    if migration_project_name is not None:
        input_["migration_project_name"] = migration_project_name
    if source_data_provider_descriptors is not None:
        input_["source_data_provider_descriptors"] = (
            source_data_provider_descriptors
        )
    if target_data_provider_descriptors is not None:
        input_["target_data_provider_descriptors"] = (
            target_data_provider_descriptors
        )
    if instance_profile_identifier is not None:
        input_["instance_profile_identifier"] = instance_profile_identifier
    if transformation_rules is not None:
        input_["transformation_rules"] = transformation_rules
    if description is not None:
        input_["description"] = description
    if schema_conversion_application_attributes is not None:
        input_["schema_conversion_application_attributes"] = (
            schema_conversion_application_attributes
        )

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output