aws_sdk_backup/client/

describe_backup_job.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeBackupJob`](crate::operation::describe_backup_job::builders::DescribeBackupJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`backup_job_id(impl Into<String>)`](crate::operation::describe_backup_job::builders::DescribeBackupJobFluentBuilder::backup_job_id) / [`set_backup_job_id(Option<String>)`](crate::operation::describe_backup_job::builders::DescribeBackupJobFluentBuilder::set_backup_job_id):<br>required: **true**<br><p>Uniquely identifies a request to Backup to back up a resource.</p><br>
    /// - On success, responds with [`DescribeBackupJobOutput`](crate::operation::describe_backup_job::DescribeBackupJobOutput) with field(s):
    ///   - [`account_id(Option<String>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::account_id): <p>Returns the account ID that owns the backup job.</p>
    ///   - [`backup_job_id(Option<String>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::backup_job_id): <p>Uniquely identifies a request to Backup to back up a resource.</p>
    ///   - [`backup_vault_name(Option<String>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::backup_vault_name): <p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.</p>
    ///   - [`backup_vault_arn(Option<String>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::backup_vault_arn): <p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault</code>.</p>
    ///   - [`recovery_point_arn(Option<String>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::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>
    ///   - [`resource_arn(Option<String>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::resource_arn): <p>An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.</p>
    ///   - [`creation_date(Option<DateTime>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::creation_date): <p>The date and time that a backup 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>
    ///   - [`completion_date(Option<DateTime>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::completion_date): <p>The date and time that a job to create a backup job 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>
    ///   - [`state(Option<BackupJobState>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::state): <p>The current state of a backup job.</p>
    ///   - [`status_message(Option<String>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::status_message): <p>A detailed message explaining the status of the job to back up a resource.</p>
    ///   - [`percent_done(Option<String>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::percent_done): <p>Contains an estimated percentage that is complete of a job at the time the job status was queried.</p>
    ///   - [`backup_size_in_bytes(Option<i64>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::backup_size_in_bytes): <p>The size, in bytes, of a backup (recovery point).</p> <p>This value can render differently depending on the resource type as Backup pulls in data information from other Amazon Web Services services. For example, the value returned may show a value of <code>0</code>, which may differ from the anticipated value.</p> <p>The expected behavior for values by resource type are described as follows:</p> <ul>  <li>   <p>Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have this value populate from the operation <code>GetBackupJobStatus</code>.</p></li>  <li>   <p>For Amazon DynamoDB with advanced features, this value refers to the size of the recovery point (backup).</p></li>  <li>   <p>Amazon EC2 and Amazon EBS show volume size (provisioned storage) returned as part of this value. Amazon EBS does not return backup size information; snapshot size will have the same value as the original resource that was backed up.</p></li>  <li>   <p>For Amazon EFS, this value refers to the delta bytes transferred during a backup.</p></li>  <li>   <p>Amazon FSx does not populate this value from the operation <code>GetBackupJobStatus</code> for FSx file systems.</p></li>  <li>   <p>An Amazon RDS instance will show as <code>0</code>.</p></li>  <li>   <p>For virtual machines running VMware, this value is passed to Backup through an asynchronous workflow, which can mean this displayed value can under-represent the actual backup size.</p></li> </ul>
    ///   - [`iam_role_arn(Option<String>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::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>
    ///   - [`created_by(Option<RecoveryPointCreator>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::created_by): <p>Contains identifying information about the creation of a backup job, including the <code>BackupPlanArn</code>, <code>BackupPlanId</code>, <code>BackupPlanVersion</code>, and <code>BackupRuleId</code> of the backup plan that is used to create it.</p>
    ///   - [`resource_type(Option<String>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::resource_type): <p>The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.</p>
    ///   - [`bytes_transferred(Option<i64>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::bytes_transferred): <p>The size in bytes transferred to a backup vault at the time that the job status was queried.</p>
    ///   - [`expected_completion_date(Option<DateTime>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::expected_completion_date): <p>The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>ExpectedCompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
    ///   - [`start_by(Option<DateTime>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::start_by): <p>Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the <code>StartBy</code> time would be 8:00 PM on the date specified. The value of <code>StartBy</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
    ///   - [`backup_options(Option<HashMap::<String, String>>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::backup_options): <p>Represents the options specified as part of backup plan or on-demand backup job.</p>
    ///   - [`backup_type(Option<String>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::backup_type): <p>Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, <code>BackupType</code> returns <code>"WindowsVSS"</code>. If <code>BackupType</code> is empty, then the backup type was a regular backup.</p>
    ///   - [`parent_job_id(Option<String>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::parent_job_id): <p>This returns the parent (composite) resource backup job ID.</p>
    ///   - [`is_parent(bool)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::is_parent): <p>This returns the boolean value that a backup job is a parent (composite) job.</p>
    ///   - [`number_of_child_jobs(Option<i64>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::number_of_child_jobs): <p>This returns the number of child (nested) backup jobs.</p>
    ///   - [`child_jobs_in_state(Option<HashMap::<BackupJobState, i64>>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::child_jobs_in_state): <p>This returns the statistics of the included child (nested) backup jobs.</p>
    ///   - [`resource_name(Option<String>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::resource_name): <p>The non-unique name of the resource that belongs to the specified backup.</p>
    ///   - [`initiation_date(Option<DateTime>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::initiation_date): <p>The date a backup job was initiated.</p>
    ///   - [`message_category(Option<String>)`](crate::operation::describe_backup_job::DescribeBackupJobOutput::message_category): <p>The job count for the specified message category.</p> <p>Example strings may include <code>AccessDenied</code>, <code>SUCCESS</code>, <code>AGGREGATE_ALL</code>, and <code>INVALIDPARAMETERS</code>. View <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a> for a list of accepted MessageCategory strings.</p>
    /// - On failure, responds with [`SdkError<DescribeBackupJobError>`](crate::operation::describe_backup_job::DescribeBackupJobError)
    pub fn describe_backup_job(&self) -> crate::operation::describe_backup_job::builders::DescribeBackupJobFluentBuilder {
        crate::operation::describe_backup_job::builders::DescribeBackupJobFluentBuilder::new(self.handle.clone())
    }
}