describe_data_migrations async ¶

async def describe_data_migrations(
    self,
    *,
    config_overrides: Optional[AsyncDatabaseMigrationServiceClientConfig] = None,
    filters: Optional[
        "capo_database_migration_service.types.filter_list.FilterList"
    ] = None,
    max_records: Optional[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_database_migration_service.types.marker.Marker"] = None,
    without_settings: Optional[
        "capo_database_migration_service.types.boolean_optional.BooleanOptional"
    ] = None,
    without_statistics: Optional[
        "capo_database_migration_service.types.boolean_optional.BooleanOptional"
    ] = None,
) -> "capo_database_migration_service.types.describe_data_migrations_response.DescribeDataMigrationsResponse":
    """<p>Returns information about data migrations.</p>

    Args:
        filters: <p>Filters applied to the data migrations.</p>
        max_records: <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p>
        marker: <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>
        without_settings: <p>An option to set to avoid returning information about settings. Use this to reduce overhead when setting information is too large. To use this option, choose <code>true</code>; otherwise, choose <code>false</code> (the default).</p>
        without_statistics: <p>An option to set to avoid returning information about statistics. Use this to reduce overhead when statistics information is too large. To use this option, choose <code>true</code>; otherwise, choose <code>false</code> (the default).</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_database_migration_service.types.describe_data_migrations_message.DescribeDataMigrationsMessage]",
    ) -> AsyncOperationResponse[
        "capo_database_migration_service.types.describe_data_migrations_response.DescribeDataMigrationsResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.describe_data_migrations

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

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

        return capo_database_migration_service.types.describe_data_migrations_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeDataMigrations", redact_output=_redact_output),
    )
    input_: capo_database_migration_service.types.describe_data_migrations_message.DescribeDataMigrationsMessage = {}
    if filters is not None:
        input_["filters"] = filters
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker
    if without_settings is not None:
        input_["without_settings"] = without_settings
    if without_statistics is not None:
        input_["without_statistics"] = without_statistics

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