Skip to content

describe_conversion_configuration

describe_conversion_configuration(
    migration_project_identifier: MigrationProjectIdentifier,
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
) -> DescribeConversionConfigurationResponse

Returns configuration parameters for a schema conversion project.

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

Parameters:

  • migration_project_identifier (MigrationProjectIdentifier) –

    The name or Amazon Resource Name (ARN) for the schema conversion project to describe.

Raises:

Examples:

Retrieving conversion configuration for a migration project The following example retrieves the conversion configuration for a migration project.

>>> client.describe_conversion_configuration(migration_project_identifier='arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS')
Source code in docs_src/capo_database_migration_service/_services/database_migration_service.py
def describe_conversion_configuration(
    self,
    migration_project_identifier: "capo_database_migration_service.types.migration_project_identifier.MigrationProjectIdentifier",
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
) -> "capo_database_migration_service.types.describe_conversion_configuration_response.DescribeConversionConfigurationResponse":
    """<p>Returns configuration parameters for a schema conversion project.</p> <p> <b>Required permissions:</b> <code>dms:DescribeConversionConfiguration</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>

    Args:
        migration_project_identifier: <p>The name or Amazon Resource Name (ARN) for the schema conversion project to describe.</p>

    Raises:
        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:
        Retrieving conversion configuration for a migration project
        The following example retrieves the conversion configuration for a migration project.

        >>> client.describe_conversion_configuration(migration_project_identifier='arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS')
    """

    def _handler(
        req: "OperationRequest[capo_database_migration_service.types.describe_conversion_configuration_message.DescribeConversionConfigurationMessage]",
    ) -> OperationResponse[
        "capo_database_migration_service.types.describe_conversion_configuration_response.DescribeConversionConfigurationResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.describe_conversion_configuration

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeConversionConfiguration")
    )
    input_: capo_database_migration_service.types.describe_conversion_configuration_message.DescribeConversionConfigurationMessage = {
        "migration_project_identifier": migration_project_identifier
    }

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