aws_sdk_backupsearch/client/
start_search_result_export_job.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 [`StartSearchResultExportJob`](crate::operation::start_search_result_export_job::builders::StartSearchResultExportJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`search_job_identifier(impl Into<String>)`](crate::operation::start_search_result_export_job::builders::StartSearchResultExportJobFluentBuilder::search_job_identifier) / [`set_search_job_identifier(Option<String>)`](crate::operation::start_search_result_export_job::builders::StartSearchResultExportJobFluentBuilder::set_search_job_identifier):<br>required: **true**<br><p>The unique string that specifies the search job.</p><br>
    ///   - [`export_specification(ExportSpecification)`](crate::operation::start_search_result_export_job::builders::StartSearchResultExportJobFluentBuilder::export_specification) / [`set_export_specification(Option<ExportSpecification>)`](crate::operation::start_search_result_export_job::builders::StartSearchResultExportJobFluentBuilder::set_export_specification):<br>required: **true**<br><p>This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::start_search_result_export_job::builders::StartSearchResultExportJobFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_search_result_export_job::builders::StartSearchResultExportJobFluentBuilder::set_client_token):<br>required: **false**<br><p>Include this parameter to allow multiple identical calls for idempotency.</p> <p>A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.</p><br>
    ///   - [`tags(impl Into<String>, Option<String>)`](crate::operation::start_search_result_export_job::builders::StartSearchResultExportJobFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, Option<String>>>)`](crate::operation::start_search_result_export_job::builders::StartSearchResultExportJobFluentBuilder::set_tags):<br>required: **false**<br><p>Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.</p><br>
    ///   - [`role_arn(impl Into<String>)`](crate::operation::start_search_result_export_job::builders::StartSearchResultExportJobFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::start_search_result_export_job::builders::StartSearchResultExportJobFluentBuilder::set_role_arn):<br>required: **false**<br><p>This parameter specifies the role ARN used to start the search results export jobs.</p><br>
    /// - On success, responds with [`StartSearchResultExportJobOutput`](crate::operation::start_search_result_export_job::StartSearchResultExportJobOutput) with field(s):
    ///   - [`export_job_arn(Option<String>)`](crate::operation::start_search_result_export_job::StartSearchResultExportJobOutput::export_job_arn): <p>This is the unique ARN (Amazon Resource Name) that belongs to the new export job.</p>
    ///   - [`export_job_identifier(String)`](crate::operation::start_search_result_export_job::StartSearchResultExportJobOutput::export_job_identifier): <p>This is the unique identifier that specifies the new export job.</p>
    /// - On failure, responds with [`SdkError<StartSearchResultExportJobError>`](crate::operation::start_search_result_export_job::StartSearchResultExportJobError)
    pub fn start_search_result_export_job(
        &self,
    ) -> crate::operation::start_search_result_export_job::builders::StartSearchResultExportJobFluentBuilder {
        crate::operation::start_search_result_export_job::builders::StartSearchResultExportJobFluentBuilder::new(self.handle.clone())
    }
}