aws_sdk_backup/client/

get_backup_plan.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetBackupPlan`](crate::operation::get_backup_plan::builders::GetBackupPlanFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`backup_plan_id(impl Into<String>)`](crate::operation::get_backup_plan::builders::GetBackupPlanFluentBuilder::backup_plan_id) / [`set_backup_plan_id(Option<String>)`](crate::operation::get_backup_plan::builders::GetBackupPlanFluentBuilder::set_backup_plan_id):<br>required: **true**<br><p>Uniquely identifies a backup plan.</p><br>
    ///   - [`version_id(impl Into<String>)`](crate::operation::get_backup_plan::builders::GetBackupPlanFluentBuilder::version_id) / [`set_version_id(Option<String>)`](crate::operation::get_backup_plan::builders::GetBackupPlanFluentBuilder::set_version_id):<br>required: **false**<br><p>Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.</p><br>
    ///   - [`max_scheduled_runs_preview(i32)`](crate::operation::get_backup_plan::builders::GetBackupPlanFluentBuilder::max_scheduled_runs_preview) / [`set_max_scheduled_runs_preview(Option<i32>)`](crate::operation::get_backup_plan::builders::GetBackupPlanFluentBuilder::set_max_scheduled_runs_preview):<br>required: **false**<br><p>Number of future scheduled backup runs to preview. When set to 0 (default), no scheduled runs preview is included in the response. Valid range is 0-10.</p><br>
    /// - On success, responds with [`GetBackupPlanOutput`](crate::operation::get_backup_plan::GetBackupPlanOutput) with field(s):
    ///   - [`backup_plan(Option<BackupPlan>)`](crate::operation::get_backup_plan::GetBackupPlanOutput::backup_plan): <p>Specifies the body of a backup plan. Includes a <code>BackupPlanName</code> and one or more sets of <code>Rules</code>.</p>
    ///   - [`backup_plan_id(Option<String>)`](crate::operation::get_backup_plan::GetBackupPlanOutput::backup_plan_id): <p>Uniquely identifies a backup plan.</p>
    ///   - [`backup_plan_arn(Option<String>)`](crate::operation::get_backup_plan::GetBackupPlanOutput::backup_plan_arn): <p>An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, <code>arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50</code>.</p>
    ///   - [`version_id(Option<String>)`](crate::operation::get_backup_plan::GetBackupPlanOutput::version_id): <p>Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.</p>
    ///   - [`creator_request_id(Option<String>)`](crate::operation::get_backup_plan::GetBackupPlanOutput::creator_request_id): <p>A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.</p>
    ///   - [`creation_date(Option<DateTime>)`](crate::operation::get_backup_plan::GetBackupPlanOutput::creation_date): <p>The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
    ///   - [`deletion_date(Option<DateTime>)`](crate::operation::get_backup_plan::GetBackupPlanOutput::deletion_date): <p>The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of <code>DeletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
    ///   - [`last_execution_date(Option<DateTime>)`](crate::operation::get_backup_plan::GetBackupPlanOutput::last_execution_date): <p>The last time this backup plan was run. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of <code>LastExecutionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
    ///   - [`advanced_backup_settings(Option<Vec::<AdvancedBackupSetting>>)`](crate::operation::get_backup_plan::GetBackupPlanOutput::advanced_backup_settings): <p>Contains a list of <code>BackupOptions</code> for each resource type. The list is populated only if the advanced option is set for the backup plan.</p>
    ///   - [`scheduled_runs_preview(Option<Vec::<ScheduledPlanExecutionMember>>)`](crate::operation::get_backup_plan::GetBackupPlanOutput::scheduled_runs_preview): <p>List of upcoming scheduled backup runs. Only included when <code>MaxScheduledRunsPreview</code> parameter is greater than 0. Contains up to 10 future backup executions with their scheduled times, execution types, and associated rule IDs.</p>
    /// - On failure, responds with [`SdkError<GetBackupPlanError>`](crate::operation::get_backup_plan::GetBackupPlanError)
    pub fn get_backup_plan(&self) -> crate::operation::get_backup_plan::builders::GetBackupPlanFluentBuilder {
        crate::operation::get_backup_plan::builders::GetBackupPlanFluentBuilder::new(self.handle.clone())
    }
}