aws_sdk_rds/client/
describe_export_tasks.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeExportTasks`](crate::operation::describe_export_tasks::builders::DescribeExportTasksFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_export_tasks::builders::DescribeExportTasksFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`export_task_identifier(impl Into<String>)`](crate::operation::describe_export_tasks::builders::DescribeExportTasksFluentBuilder::export_task_identifier) / [`set_export_task_identifier(Option<String>)`](crate::operation::describe_export_tasks::builders::DescribeExportTasksFluentBuilder::set_export_task_identifier):<br>required: **false**<br><p>The identifier of the snapshot or cluster export task to be described.</p><br>
    ///   - [`source_arn(impl Into<String>)`](crate::operation::describe_export_tasks::builders::DescribeExportTasksFluentBuilder::source_arn) / [`set_source_arn(Option<String>)`](crate::operation::describe_export_tasks::builders::DescribeExportTasksFluentBuilder::set_source_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.</p><br>
    ///   - [`filters(Filter)`](crate::operation::describe_export_tasks::builders::DescribeExportTasksFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_export_tasks::builders::DescribeExportTasksFluentBuilder::set_filters):<br>required: **false**<br><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><br>
    ///   - [`marker(impl Into<String>)`](crate::operation::describe_export_tasks::builders::DescribeExportTasksFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_export_tasks::builders::DescribeExportTasksFluentBuilder::set_marker):<br>required: **false**<br><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><br>
    ///   - [`max_records(i32)`](crate::operation::describe_export_tasks::builders::DescribeExportTasksFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_export_tasks::builders::DescribeExportTasksFluentBuilder::set_max_records):<br>required: **false**<br><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><br>
    ///   - [`source_type(ExportSourceType)`](crate::operation::describe_export_tasks::builders::DescribeExportTasksFluentBuilder::source_type) / [`set_source_type(Option<ExportSourceType>)`](crate::operation::describe_export_tasks::builders::DescribeExportTasksFluentBuilder::set_source_type):<br>required: **false**<br><p>The type of source for the export.</p><br>
    /// - On success, responds with [`DescribeExportTasksOutput`](crate::operation::describe_export_tasks::DescribeExportTasksOutput) with field(s):
    ///   - [`marker(Option<String>)`](crate::operation::describe_export_tasks::DescribeExportTasksOutput::marker): <p>A pagination token that can be used in a later <code>DescribeExportTasks</code> request. A marker is used for pagination to identify the location to begin output for the next response of <code>DescribeExportTasks</code>.</p>
    ///   - [`export_tasks(Option<Vec::<ExportTask>>)`](crate::operation::describe_export_tasks::DescribeExportTasksOutput::export_tasks): <p>Information about an export of a snapshot or cluster to Amazon S3.</p>
    /// - On failure, responds with [`SdkError<DescribeExportTasksError>`](crate::operation::describe_export_tasks::DescribeExportTasksError)
    pub fn describe_export_tasks(&self) -> crate::operation::describe_export_tasks::builders::DescribeExportTasksFluentBuilder {
        crate::operation::describe_export_tasks::builders::DescribeExportTasksFluentBuilder::new(self.handle.clone())
    }
}