aws_sdk_backup/client/
create_legal_hold.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateLegalHold`](crate::operation::create_legal_hold::builders::CreateLegalHoldFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`title(impl Into<String>)`](crate::operation::create_legal_hold::builders::CreateLegalHoldFluentBuilder::title) / [`set_title(Option<String>)`](crate::operation::create_legal_hold::builders::CreateLegalHoldFluentBuilder::set_title):<br>required: **true**<br><p>The title of the legal hold.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::create_legal_hold::builders::CreateLegalHoldFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_legal_hold::builders::CreateLegalHoldFluentBuilder::set_description):<br>required: **true**<br><p>The description of the legal hold.</p><br>
    ///   - [`idempotency_token(impl Into<String>)`](crate::operation::create_legal_hold::builders::CreateLegalHoldFluentBuilder::idempotency_token) / [`set_idempotency_token(Option<String>)`](crate::operation::create_legal_hold::builders::CreateLegalHoldFluentBuilder::set_idempotency_token):<br>required: **false**<br><p>This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.</p><br>
    ///   - [`recovery_point_selection(RecoveryPointSelection)`](crate::operation::create_legal_hold::builders::CreateLegalHoldFluentBuilder::recovery_point_selection) / [`set_recovery_point_selection(Option<RecoveryPointSelection>)`](crate::operation::create_legal_hold::builders::CreateLegalHoldFluentBuilder::set_recovery_point_selection):<br>required: **false**<br><p>The criteria to assign a set of resources, such as resource types or backup vaults.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_legal_hold::builders::CreateLegalHoldFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_legal_hold::builders::CreateLegalHoldFluentBuilder::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>
    /// - On success, responds with [`CreateLegalHoldOutput`](crate::operation::create_legal_hold::CreateLegalHoldOutput) with field(s):
    ///   - [`title(Option<String>)`](crate::operation::create_legal_hold::CreateLegalHoldOutput::title): <p>The title of the legal hold.</p>
    ///   - [`status(Option<LegalHoldStatus>)`](crate::operation::create_legal_hold::CreateLegalHoldOutput::status): <p>The status of the legal hold.</p>
    ///   - [`description(Option<String>)`](crate::operation::create_legal_hold::CreateLegalHoldOutput::description): <p>The description of the legal hold.</p>
    ///   - [`legal_hold_id(Option<String>)`](crate::operation::create_legal_hold::CreateLegalHoldOutput::legal_hold_id): <p>The ID of the legal hold.</p>
    ///   - [`legal_hold_arn(Option<String>)`](crate::operation::create_legal_hold::CreateLegalHoldOutput::legal_hold_arn): <p>The Amazon Resource Name (ARN) of the legal hold.</p>
    ///   - [`creation_date(Option<DateTime>)`](crate::operation::create_legal_hold::CreateLegalHoldOutput::creation_date): <p>The time when the legal hold was created.</p>
    ///   - [`recovery_point_selection(Option<RecoveryPointSelection>)`](crate::operation::create_legal_hold::CreateLegalHoldOutput::recovery_point_selection): <p>The criteria to assign to a set of resources, such as resource types or backup vaults.</p>
    /// - On failure, responds with [`SdkError<CreateLegalHoldError>`](crate::operation::create_legal_hold::CreateLegalHoldError)
    pub fn create_legal_hold(&self) -> crate::operation::create_legal_hold::builders::CreateLegalHoldFluentBuilder {
        crate::operation::create_legal_hold::builders::CreateLegalHoldFluentBuilder::new(self.handle.clone())
    }
}