Skip to content

describe_replication_tasks async

describe_replication_tasks(
    *,
    config_overrides: Optional[AsyncDatabaseMigrationServiceClientConfig] = None,
    filters: Optional[FilterList] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
    without_settings: Optional[BooleanOptional] = None,
) -> DescribeReplicationTasksResponse

Returns information about replication tasks for your account in the current region.

Parameters:

  • filters (Optional[FilterList], default: None ) –

    Filters applied to replication tasks.

    Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn

  • max_records (Optional[IntegerOptional], default: None ) –

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

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

    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 MaxRecords.

  • without_settings (Optional[BooleanOptional], default: None ) –

    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 true; otherwise, choose false (the default).

Raises:

Examples:

Describe replication tasks Returns information about replication tasks for your account in the current region.

>>> await client.describe_replication_tasks(filters=[{'Name': 'string', 'Values': ['string', 'string']}], max_records=123, marker='')
Source code in docs_src/capo_database_migration_service/_services/async_database_migration_service.py
async def describe_replication_tasks(
    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.string.String"] = None,
    without_settings: Optional[
        "capo_database_migration_service.types.boolean_optional.BooleanOptional"
    ] = None,
) -> "capo_database_migration_service.types.describe_replication_tasks_response.DescribeReplicationTasksResponse":
    """<p>Returns information about replication tasks for your account in the current region.</p>

    Args:
        filters: <p>Filters applied to replication tasks.</p> <p>Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn</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> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</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>

    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:
        Describe replication tasks
        Returns information about replication tasks for your account in the current region.

        >>> await client.describe_replication_tasks(filters=[{'Name': 'string', 'Values': ['string', 'string']}], max_records=123, marker='')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_database_migration_service.types.describe_replication_tasks_message.DescribeReplicationTasksMessage]",
    ) -> AsyncOperationResponse[
        "capo_database_migration_service.types.describe_replication_tasks_response.DescribeReplicationTasksResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.describe_replication_tasks

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeReplicationTasks")
    )
    input_: capo_database_migration_service.types.describe_replication_tasks_message.DescribeReplicationTasksMessage = {}
    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

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