aws_sdk_backup/client/
describe_restore_job.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 [`DescribeRestoreJob`](crate::operation::describe_restore_job::builders::DescribeRestoreJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`restore_job_id(impl Into<String>)`](crate::operation::describe_restore_job::builders::DescribeRestoreJobFluentBuilder::restore_job_id) / [`set_restore_job_id(Option<String>)`](crate::operation::describe_restore_job::builders::DescribeRestoreJobFluentBuilder::set_restore_job_id):<br>required: **true**<br><p>Uniquely identifies the job that restores a recovery point.</p><br>
7    /// - On success, responds with [`DescribeRestoreJobOutput`](crate::operation::describe_restore_job::DescribeRestoreJobOutput) with field(s):
8    ///   - [`account_id(Option<String>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::account_id): <p>Returns the account ID that owns the restore job.</p>
9    ///   - [`restore_job_id(Option<String>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::restore_job_id): <p>Uniquely identifies the job that restores a recovery point.</p>
10    ///   - [`recovery_point_arn(Option<String>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::recovery_point_arn): <p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
11    ///   - [`source_resource_arn(Option<String>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::source_resource_arn): <p>The Amazon Resource Name (ARN) of the original resource that was backed up. This provides context about what resource is being restored.</p>
12    ///   - [`backup_vault_arn(Option<String>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::backup_vault_arn): <p>The Amazon Resource Name (ARN) of the backup vault containing the recovery point being restored. This helps identify vault access policies and permissions.</p>
13    ///   - [`creation_date(Option<DateTime>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::creation_date): <p>The date and time that a restore job 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>
14    ///   - [`completion_date(Option<DateTime>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::completion_date): <p>The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
15    ///   - [`status(Option<RestoreJobStatus>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::status): <p>Status code specifying the state of the job that is initiated by Backup to restore a recovery point.</p>
16    ///   - [`status_message(Option<String>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::status_message): <p>A message showing the status of a job to restore a recovery point.</p>
17    ///   - [`percent_done(Option<String>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::percent_done): <p>Contains an estimated percentage that is complete of a job at the time the job status was queried.</p>
18    ///   - [`backup_size_in_bytes(Option<i64>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::backup_size_in_bytes): <p>The size, in bytes, of the restored resource.</p>
19    ///   - [`iam_role_arn(Option<String>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::iam_role_arn): <p>Specifies the IAM role ARN used to create the target recovery point; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
20    ///   - [`expected_completion_time_minutes(Option<i64>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::expected_completion_time_minutes): <p>The amount of time in minutes that a job restoring a recovery point is expected to take.</p>
21    ///   - [`created_resource_arn(Option<String>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::created_resource_arn): <p>The Amazon Resource Name (ARN) of the resource that was created by the restore job.</p> <p>The format of the ARN depends on the resource type of the backed-up resource.</p>
22    ///   - [`resource_type(Option<String>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::resource_type): <p>Returns metadata associated with a restore job listed by resource type.</p>
23    ///   - [`recovery_point_creation_date(Option<DateTime>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::recovery_point_creation_date): <p>The creation date of the recovery point made by the specifed restore job.</p>
24    ///   - [`created_by(Option<RestoreJobCreator>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::created_by): <p>Contains identifying information about the creation of a restore job.</p>
25    ///   - [`validation_status(Option<RestoreValidationStatus>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::validation_status): <p>The status of validation run on the indicated restore job.</p>
26    ///   - [`validation_status_message(Option<String>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::validation_status_message): <p>The status message.</p>
27    ///   - [`deletion_status(Option<RestoreDeletionStatus>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::deletion_status): <p>The status of the data generated by the restore test.</p>
28    ///   - [`deletion_status_message(Option<String>)`](crate::operation::describe_restore_job::DescribeRestoreJobOutput::deletion_status_message): <p>This describes the restore job deletion status.</p>
29    /// - On failure, responds with [`SdkError<DescribeRestoreJobError>`](crate::operation::describe_restore_job::DescribeRestoreJobError)
30    pub fn describe_restore_job(&self) -> crate::operation::describe_restore_job::builders::DescribeRestoreJobFluentBuilder {
31        crate::operation::describe_restore_job::builders::DescribeRestoreJobFluentBuilder::new(self.handle.clone())
32    }
33}
aws_sdk_backup/client/describe_restore_job.rs

aws_sdk_backup/client/
describe_restore_job.rs
