Struct aws_sdk_backup::operation::describe_backup_job::DescribeBackupJobOutput

#[non_exhaustive]
pub struct DescribeBackupJobOutput {

    pub account_id: Option<String>,
    pub backup_job_id: Option<String>,
    pub backup_vault_name: Option<String>,
    pub backup_vault_arn: Option<String>,
    pub recovery_point_arn: Option<String>,
    pub resource_arn: Option<String>,
    pub creation_date: Option<DateTime>,
    pub completion_date: Option<DateTime>,
    pub state: Option<BackupJobState>,
    pub status_message: Option<String>,
    pub percent_done: Option<String>,
    pub backup_size_in_bytes: Option<i64>,
    pub iam_role_arn: Option<String>,
    pub created_by: Option<RecoveryPointCreator>,
    pub resource_type: Option<String>,
    pub bytes_transferred: Option<i64>,
    pub expected_completion_date: Option<DateTime>,
    pub start_by: Option<DateTime>,
    pub backup_options: Option<HashMap<String, String>>,
    pub backup_type: Option<String>,
    pub parent_job_id: Option<String>,
    pub is_parent: bool,
    pub number_of_child_jobs: Option<i64>,
    pub child_jobs_in_state: Option<HashMap<BackupJobState, i64>>,
    pub resource_name: Option<String>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

account_id: Option<String>

Returns the account ID that owns the backup job.

backup_job_id: Option<String>

Uniquely identifies a request to Backup to back up a resource.

backup_vault_name: Option<String>

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. They consist of lowercase letters, numbers, and hyphens.

backup_vault_arn: Option<String>

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

recovery_point_arn: Option<String>

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

resource_arn: Option<String>

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

creation_date: Option<DateTime>

The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

completion_date: Option<DateTime>

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 CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

state: Option<BackupJobState>

The current state of a backup job.

status_message: Option<String>

A detailed message explaining the status of the job to back up a resource.

percent_done: Option<String>

Contains an estimated percentage that is complete of a job at the time the job status was queried.

backup_size_in_bytes: Option<i64>

The size, in bytes, of a backup.

iam_role_arn: Option<String>

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

created_by: Option<RecoveryPointCreator>

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

resource_type: Option<String>

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.

bytes_transferred: Option<i64>

The size in bytes transferred to a backup vault at the time that the job status was queried.

expected_completion_date: Option<DateTime>

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 ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

start_by: Option<DateTime>

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 StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

backup_options: Option<HashMap<String, String>>

Represents the options specified as part of backup plan or on-demand backup job.

backup_type: Option<String>

Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type was a regular backup.

parent_job_id: Option<String>

This returns the parent (composite) resource backup job ID.

is_parent: bool

This returns the boolean value that a backup job is a parent (composite) job.

number_of_child_jobs: Option<i64>

This returns the number of child (nested) backup jobs.

child_jobs_in_state: Option<HashMap<BackupJobState, i64>>

This returns the statistics of the included child (nested) backup jobs.

resource_name: Option<String>

This is the non-unique name of the resource that belongs to the specified backup.

Implementations

impl DescribeBackupJobOutput

pub fn account_id(&self) -> Option<&str>

Returns the account ID that owns the backup job.

pub fn backup_job_id(&self) -> Option<&str>

Uniquely identifies a request to Backup to back up a resource.

pub fn backup_vault_name(&self) -> Option<&str>

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. They consist of lowercase letters, numbers, and hyphens.

pub fn backup_vault_arn(&self) -> Option<&str>

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

pub fn recovery_point_arn(&self) -> Option<&str>

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

pub fn resource_arn(&self) -> Option<&str>

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

pub fn creation_date(&self) -> Option<&DateTime>

The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

pub fn completion_date(&self) -> Option<&DateTime>

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 CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

pub fn state(&self) -> Option<&BackupJobState>

The current state of a backup job.

pub fn status_message(&self) -> Option<&str>

A detailed message explaining the status of the job to back up a resource.

pub fn percent_done(&self) -> Option<&str>

Contains an estimated percentage that is complete of a job at the time the job status was queried.

pub fn backup_size_in_bytes(&self) -> Option<i64>

The size, in bytes, of a backup.

pub fn iam_role_arn(&self) -> Option<&str>

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

pub fn created_by(&self) -> Option<&RecoveryPointCreator>

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

pub fn resource_type(&self) -> Option<&str>

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.

pub fn bytes_transferred(&self) -> Option<i64>

The size in bytes transferred to a backup vault at the time that the job status was queried.

pub fn expected_completion_date(&self) -> Option<&DateTime>

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 ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

pub fn start_by(&self) -> Option<&DateTime>

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 StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

pub fn backup_options(&self) -> Option<&HashMap<String, String>>

Represents the options specified as part of backup plan or on-demand backup job.

pub fn backup_type(&self) -> Option<&str>

Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type was a regular backup.

pub fn parent_job_id(&self) -> Option<&str>

This returns the parent (composite) resource backup job ID.

pub fn is_parent(&self) -> bool

This returns the boolean value that a backup job is a parent (composite) job.

pub fn number_of_child_jobs(&self) -> Option<i64>

This returns the number of child (nested) backup jobs.

pub fn child_jobs_in_state(&self) -> Option<&HashMap<BackupJobState, i64>>

This returns the statistics of the included child (nested) backup jobs.

pub fn resource_name(&self) -> Option<&str>

This is the non-unique name of the resource that belongs to the specified backup.

impl DescribeBackupJobOutput

pub fn builder() -> DescribeBackupJobOutputBuilder

Creates a new builder-style object to manufacture DescribeBackupJobOutput.

Trait Implementations

impl Clone for DescribeBackupJobOutput

fn clone(&self) -> DescribeBackupJobOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeBackupJobOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DescribeBackupJobOutput

fn eq(&self, other: &DescribeBackupJobOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DescribeBackupJobOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeBackupJobOutput