aws_sdk_backupsearch/client/
get_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 [`GetSearchResultExportJob`](crate::operation::get_search_result_export_job::builders::GetSearchResultExportJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`export_job_identifier(impl Into<String>)`](crate::operation::get_search_result_export_job::builders::GetSearchResultExportJobFluentBuilder::export_job_identifier) / [`set_export_job_identifier(Option<String>)`](crate::operation::get_search_result_export_job::builders::GetSearchResultExportJobFluentBuilder::set_export_job_identifier):<br>required: **true**<br><p>This is the unique string that identifies a specific export job.</p> <p>Required for this operation.</p><br>
    /// - On success, responds with [`GetSearchResultExportJobOutput`](crate::operation::get_search_result_export_job::GetSearchResultExportJobOutput) with field(s):
    ///   - [`export_job_identifier(String)`](crate::operation::get_search_result_export_job::GetSearchResultExportJobOutput::export_job_identifier): <p>This is the unique string that identifies the specified export job.</p>
    ///   - [`export_job_arn(Option<String>)`](crate::operation::get_search_result_export_job::GetSearchResultExportJobOutput::export_job_arn): <p>The unique Amazon Resource Name (ARN) that uniquely identifies the export job.</p>
    ///   - [`status(Option<ExportJobStatus>)`](crate::operation::get_search_result_export_job::GetSearchResultExportJobOutput::status): <p>This is the current status of the export job.</p>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::get_search_result_export_job::GetSearchResultExportJobOutput::creation_time): <p>The date and time that an export job was created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
    ///   - [`completion_time(Option<DateTime>)`](crate::operation::get_search_result_export_job::GetSearchResultExportJobOutput::completion_time): <p>The date and time that an export job completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
    ///   - [`status_message(Option<String>)`](crate::operation::get_search_result_export_job::GetSearchResultExportJobOutput::status_message): <p>A status message is a string that is returned for search job with a status of <code>FAILED</code>, along with steps to remedy and retry the operation.</p>
    ///   - [`export_specification(Option<ExportSpecification>)`](crate::operation::get_search_result_export_job::GetSearchResultExportJobOutput::export_specification): <p>The export specification consists of the destination S3 bucket to which the search results were exported, along with the destination prefix.</p>
    ///   - [`search_job_arn(Option<String>)`](crate::operation::get_search_result_export_job::GetSearchResultExportJobOutput::search_job_arn): <p>The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.</p>
    /// - On failure, responds with [`SdkError<GetSearchResultExportJobError>`](crate::operation::get_search_result_export_job::GetSearchResultExportJobError)
    pub fn get_search_result_export_job(&self) -> crate::operation::get_search_result_export_job::builders::GetSearchResultExportJobFluentBuilder {
        crate::operation::get_search_result_export_job::builders::GetSearchResultExportJobFluentBuilder::new(self.handle.clone())
    }
}