#[non_exhaustive]pub struct BackupJob {Show 25 fields
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 expected_completion_date: Option<DateTime>,
pub start_by: Option<DateTime>,
pub resource_type: Option<String>,
pub bytes_transferred: Option<i64>,
pub backup_options: Option<HashMap<String, String>>,
pub backup_type: Option<String>,
pub parent_job_id: Option<String>,
pub is_parent: bool,
pub resource_name: Option<String>,
pub initiation_date: Option<DateTime>,
pub message_category: Option<String>,
}Expand description
Contains detailed information about a backup job.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.account_id: Option<String>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.
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:backup-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 resource. The format of the ARN depends on the resource type.
creation_date: Option<DateTime>The date and time 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 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 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 (recovery point).
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 0, which may differ from the anticipated value.
The expected behavior for values by resource type are described as follows:
-
Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have this value populate from the operation
GetBackupJobStatus. -
For Amazon DynamoDB with advanced features, this value refers to the size of the recovery point (backup).
-
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.
-
For Amazon EFS, this value refers to the delta bytes transferred during a backup.
-
Amazon FSx does not populate this value from the operation
GetBackupJobStatusfor FSx file systems. -
An Amazon RDS instance will show as
0. -
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.
iam_role_arn: Option<String>Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.
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 used to create it.
expected_completion_date: Option<DateTime>The date and time 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.
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. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
bytes_transferred: Option<i64>The size in bytes transferred to a backup vault at the time that the job status was queried.
backup_options: Option<HashMap<String, String>>Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.
backup_type: Option<String>Represents the type of backup for a backup job.
parent_job_id: Option<String>This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.
is_parent: boolThis is a boolean value indicating this is a parent (composite) backup job.
resource_name: Option<String>The non-unique name of the resource that belongs to the specified backup.
initiation_date: Option<DateTime>The date on which the backup job was initiated.
message_category: Option<String>This parameter is the job count for the specified message category.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. See Monitoring for a list of MessageCategory strings.
The the value ANY returns count of all message categories.
AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
Implementations§
Source§impl BackupJob
impl BackupJob
Sourcepub fn account_id(&self) -> Option<&str>
pub fn account_id(&self) -> Option<&str>
The account ID that owns the backup job.
Sourcepub fn backup_job_id(&self) -> Option<&str>
pub fn backup_job_id(&self) -> Option<&str>
Uniquely identifies a request to Backup to back up a resource.
Sourcepub fn backup_vault_name(&self) -> Option<&str>
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.
Sourcepub fn backup_vault_arn(&self) -> Option<&str>
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:backup-vault:aBackupVault.
Sourcepub fn recovery_point_arn(&self) -> Option<&str>
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.
Sourcepub fn resource_arn(&self) -> Option<&str>
pub fn resource_arn(&self) -> Option<&str>
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
Sourcepub fn creation_date(&self) -> Option<&DateTime>
pub fn creation_date(&self) -> Option<&DateTime>
The date and time 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.
Sourcepub fn completion_date(&self) -> Option<&DateTime>
pub fn completion_date(&self) -> Option<&DateTime>
The date and time 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.
Sourcepub fn state(&self) -> Option<&BackupJobState>
pub fn state(&self) -> Option<&BackupJobState>
The current state of a backup job.
Sourcepub fn status_message(&self) -> Option<&str>
pub fn status_message(&self) -> Option<&str>
A detailed message explaining the status of the job to back up a resource.
Sourcepub fn percent_done(&self) -> Option<&str>
pub fn percent_done(&self) -> Option<&str>
Contains an estimated percentage complete of a job at the time the job status was queried.
Sourcepub fn backup_size_in_bytes(&self) -> Option<i64>
pub fn backup_size_in_bytes(&self) -> Option<i64>
The size, in bytes, of a backup (recovery point).
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 0, which may differ from the anticipated value.
The expected behavior for values by resource type are described as follows:
-
Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have this value populate from the operation
GetBackupJobStatus. -
For Amazon DynamoDB with advanced features, this value refers to the size of the recovery point (backup).
-
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.
-
For Amazon EFS, this value refers to the delta bytes transferred during a backup.
-
Amazon FSx does not populate this value from the operation
GetBackupJobStatusfor FSx file systems. -
An Amazon RDS instance will show as
0. -
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.
Sourcepub fn iam_role_arn(&self) -> Option<&str>
pub fn iam_role_arn(&self) -> Option<&str>
Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.
Sourcepub fn created_by(&self) -> Option<&RecoveryPointCreator>
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 used to create it.
Sourcepub fn expected_completion_date(&self) -> Option<&DateTime>
pub fn expected_completion_date(&self) -> Option<&DateTime>
The date and time 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.
Sourcepub fn start_by(&self) -> Option<&DateTime>
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.
Sourcepub fn resource_type(&self) -> Option<&str>
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. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
Sourcepub fn bytes_transferred(&self) -> Option<i64>
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.
Sourcepub fn backup_options(&self) -> Option<&HashMap<String, String>>
pub fn backup_options(&self) -> Option<&HashMap<String, String>>
Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.
Sourcepub fn backup_type(&self) -> Option<&str>
pub fn backup_type(&self) -> Option<&str>
Represents the type of backup for a backup job.
Sourcepub fn parent_job_id(&self) -> Option<&str>
pub fn parent_job_id(&self) -> Option<&str>
This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.
Sourcepub fn is_parent(&self) -> bool
pub fn is_parent(&self) -> bool
This is a boolean value indicating this is a parent (composite) backup job.
Sourcepub fn resource_name(&self) -> Option<&str>
pub fn resource_name(&self) -> Option<&str>
The non-unique name of the resource that belongs to the specified backup.
Sourcepub fn initiation_date(&self) -> Option<&DateTime>
pub fn initiation_date(&self) -> Option<&DateTime>
The date on which the backup job was initiated.
Sourcepub fn message_category(&self) -> Option<&str>
pub fn message_category(&self) -> Option<&str>
This parameter is the job count for the specified message category.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. See Monitoring for a list of MessageCategory strings.
The the value ANY returns count of all message categories.
AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
Trait Implementations§
impl StructuralPartialEq for BackupJob
Auto Trait Implementations§
impl Freeze for BackupJob
impl RefUnwindSafe for BackupJob
impl Send for BackupJob
impl Sync for BackupJob
impl Unpin for BackupJob
impl UnwindSafe for BackupJob
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);