aws_sdk_backupsearch/client/
start_search_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 [`StartSearchJob`](crate::operation::start_search_job::builders::StartSearchJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`tags(impl Into<String>, Option<String>)`](crate::operation::start_search_job::builders::StartSearchJobFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, Option<String>>>)`](crate::operation::start_search_job::builders::StartSearchJobFluentBuilder::set_tags):<br>required: **false**<br><p>List of tags returned by the operation.</p><br>
    ///   - [`name(impl Into<String>)`](crate::operation::start_search_job::builders::StartSearchJobFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::start_search_job::builders::StartSearchJobFluentBuilder::set_name):<br>required: **false**<br><p>Include alphanumeric characters to create a name for this search job.</p><br>
    ///   - [`encryption_key_arn(impl Into<String>)`](crate::operation::start_search_job::builders::StartSearchJobFluentBuilder::encryption_key_arn) / [`set_encryption_key_arn(Option<String>)`](crate::operation::start_search_job::builders::StartSearchJobFluentBuilder::set_encryption_key_arn):<br>required: **false**<br><p>The encryption key for the specified search job.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::start_search_job::builders::StartSearchJobFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_search_job::builders::StartSearchJobFluentBuilder::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>
    ///   - [`search_scope(SearchScope)`](crate::operation::start_search_job::builders::StartSearchJobFluentBuilder::search_scope) / [`set_search_scope(Option<SearchScope>)`](crate::operation::start_search_job::builders::StartSearchJobFluentBuilder::set_search_scope):<br>required: **true**<br><p>This object can contain BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter the recovery points returned by the search job.</p><br>
    ///   - [`item_filters(ItemFilters)`](crate::operation::start_search_job::builders::StartSearchJobFluentBuilder::item_filters) / [`set_item_filters(Option<ItemFilters>)`](crate::operation::start_search_job::builders::StartSearchJobFluentBuilder::set_item_filters):<br>required: **false**<br><p>Item Filters represent all input item properties specified when the search was created.</p> <p>Contains either EBSItemFilters or S3ItemFilters</p><br>
    /// - On success, responds with [`StartSearchJobOutput`](crate::operation::start_search_job::StartSearchJobOutput) with field(s):
    ///   - [`search_job_arn(Option<String>)`](crate::operation::start_search_job::StartSearchJobOutput::search_job_arn): <p>The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.</p>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::start_search_job::StartSearchJobOutput::creation_time): <p>The date and time that a job was created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CompletionTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
    ///   - [`search_job_identifier(Option<String>)`](crate::operation::start_search_job::StartSearchJobOutput::search_job_identifier): <p>The unique string that specifies the search job.</p>
    /// - On failure, responds with [`SdkError<StartSearchJobError>`](crate::operation::start_search_job::StartSearchJobError)
    pub fn start_search_job(&self) -> crate::operation::start_search_job::builders::StartSearchJobFluentBuilder {
        crate::operation::start_search_job::builders::StartSearchJobFluentBuilder::new(self.handle.clone())
    }
}