describe_export_tasks ¶

def describe_export_tasks(
    self,
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    export_task_identifier: Optional["capo_rds.types.string.String"] = None,
    source_arn: Optional["capo_rds.types.string.String"] = None,
    filters: Optional["capo_rds.types.filter_list.FilterList"] = None,
    marker: Optional["capo_rds.types.string.String"] = None,
    max_records: Optional["capo_rds.types.max_records.MaxRecords"] = None,
    source_type: Optional[
        "capo_rds.types.export_source_type.ExportSourceType"
    ] = None,
) -> "capo_rds.types.export_tasks_message.ExportTasksMessage":
    """<p>Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.</p>

    Args:
        export_task_identifier: <p>The identifier of the snapshot or cluster export task to be described.</p>
        source_arn: <p>The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.</p>
        filters: <p>Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.</p> <p>Supported filters include the following:</p> <ul> <li> <p> <code>export-task-identifier</code> - An identifier for the snapshot or cluster export task.</p> </li> <li> <p> <code>s3-bucket</code> - The Amazon S3 bucket the data is exported to.</p> </li> <li> <p> <code>source-arn</code> - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.</p> </li> <li> <p> <code>status</code> - The status of the export task. Must be lowercase. Valid statuses are the following:</p> <ul> <li> <p> <code>canceled</code> </p> </li> <li> <p> <code>canceling</code> </p> </li> <li> <p> <code>complete</code> </p> </li> <li> <p> <code>failed</code> </p> </li> <li> <p> <code>in_progress</code> </p> </li> <li> <p> <code>starting</code> </p> </li> </ul> </li> </ul>
        marker: <p>An optional pagination token provided by a previous <code>DescribeExportTasks</code> request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the <code>MaxRecords</code> parameter.</p>
        max_records: <p>The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later <code>DescribeExportTasks</code> request to retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>
        source_type: <p>The type of source for the export.</p>

    Raises:
        capo_rds.errors.export_task_not_found_fault.ExportTaskNotFoundFault: <p>The export task doesn't exist.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To describe snapshot export tasks
        The following example returns information about snapshot exports to Amazon S3.

        >>> client.describe_export_tasks()
    """

    def _handler(
        req: "OperationRequest[capo_rds.types.describe_export_tasks_message.DescribeExportTasksMessage]",
    ) -> OperationResponse[
        "capo_rds.types.export_tasks_message.ExportTasksMessage"
    ]:
        import capo_rds._operations.amazon_rd_sv19.describe_export_tasks

        output, http_response = (
            capo_rds._operations.amazon_rd_sv19.describe_export_tasks.describe_export_tasks(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeExportTasks")
    )
    input_: capo_rds.types.describe_export_tasks_message.DescribeExportTasksMessage = {}
    if export_task_identifier is not None:
        input_["export_task_identifier"] = export_task_identifier
    if source_arn is not None:
        input_["source_arn"] = source_arn
    if filters is not None:
        input_["filters"] = filters
    if marker is not None:
        input_["marker"] = marker
    if max_records is not None:
        input_["max_records"] = max_records
    if source_type is not None:
        input_["source_type"] = source_type

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