aws_sdk_backup/client/
get_legal_hold.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetLegalHold`](crate::operation::get_legal_hold::builders::GetLegalHoldFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`legal_hold_id(impl Into<String>)`](crate::operation::get_legal_hold::builders::GetLegalHoldFluentBuilder::legal_hold_id) / [`set_legal_hold_id(Option<String>)`](crate::operation::get_legal_hold::builders::GetLegalHoldFluentBuilder::set_legal_hold_id):<br>required: **true**<br><p>The ID of the legal hold.</p><br>
7    /// - On success, responds with [`GetLegalHoldOutput`](crate::operation::get_legal_hold::GetLegalHoldOutput) with field(s):
8    ///   - [`title(Option<String>)`](crate::operation::get_legal_hold::GetLegalHoldOutput::title): <p>The title of the legal hold.</p>
9    ///   - [`status(Option<LegalHoldStatus>)`](crate::operation::get_legal_hold::GetLegalHoldOutput::status): <p>The status of the legal hold.</p>
10    ///   - [`description(Option<String>)`](crate::operation::get_legal_hold::GetLegalHoldOutput::description): <p>The description of the legal hold.</p>
11    ///   - [`cancel_description(Option<String>)`](crate::operation::get_legal_hold::GetLegalHoldOutput::cancel_description): <p>The reason for removing the legal hold.</p>
12    ///   - [`legal_hold_id(Option<String>)`](crate::operation::get_legal_hold::GetLegalHoldOutput::legal_hold_id): <p>The ID of the legal hold.</p>
13    ///   - [`legal_hold_arn(Option<String>)`](crate::operation::get_legal_hold::GetLegalHoldOutput::legal_hold_arn): <p>The framework ARN for the specified legal hold. The format of the ARN depends on the resource type.</p>
14    ///   - [`creation_date(Option<DateTime>)`](crate::operation::get_legal_hold::GetLegalHoldOutput::creation_date): <p>The time when the legal hold was created.</p>
15    ///   - [`cancellation_date(Option<DateTime>)`](crate::operation::get_legal_hold::GetLegalHoldOutput::cancellation_date): <p>The time when the legal hold was cancelled.</p>
16    ///   - [`retain_record_until(Option<DateTime>)`](crate::operation::get_legal_hold::GetLegalHoldOutput::retain_record_until): <p>The date and time until which the legal hold record is retained.</p>
17    ///   - [`recovery_point_selection(Option<RecoveryPointSelection>)`](crate::operation::get_legal_hold::GetLegalHoldOutput::recovery_point_selection): <p>The criteria to assign a set of resources, such as resource types or backup vaults.</p>
18    /// - On failure, responds with [`SdkError<GetLegalHoldError>`](crate::operation::get_legal_hold::GetLegalHoldError)
19    pub fn get_legal_hold(&self) -> crate::operation::get_legal_hold::builders::GetLegalHoldFluentBuilder {
20        crate::operation::get_legal_hold::builders::GetLegalHoldFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_backup/client/get_legal_hold.rs

aws_sdk_backup/client/
get_legal_hold.rs
