#[non_exhaustive]pub struct ListBackupJobsInput {Show 13 fields
pub next_token: Option<String>,
pub max_results: Option<i32>,
pub by_resource_arn: Option<String>,
pub by_state: Option<BackupJobState>,
pub by_backup_vault_name: Option<String>,
pub by_created_before: Option<DateTime>,
pub by_created_after: Option<DateTime>,
pub by_resource_type: Option<String>,
pub by_account_id: Option<String>,
pub by_complete_after: Option<DateTime>,
pub by_complete_before: Option<DateTime>,
pub by_parent_job_id: Option<String>,
pub by_message_category: Option<String>,
}
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.next_token: Option<String>
The next item following a partial list of returned items. For example, if a request is made to return MaxResults
number of items, NextToken
allows you to return more items in your list starting at the location pointed to by the next token.
max_results: Option<i32>
The maximum number of items to be returned.
by_resource_arn: Option<String>
Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
by_state: Option<BackupJobState>
Returns only backup jobs that are in the specified state.
Completed with issues
is a status found only in the Backup console. For API, this status refers to jobs with a state of COMPLETED
and a MessageCategory
with a value other than SUCCESS
; that is, the status is completed but comes with a status message.
To obtain the job count for Completed with issues
, run two GET requests, and subtract the second, smaller number:
GET /backup-jobs/?state=COMPLETED
GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
by_backup_vault_name: Option<String>
Returns only backup jobs that will be stored in the specified backup vault. 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.
by_created_before: Option<DateTime>
Returns only backup jobs that were created before the specified date.
by_created_after: Option<DateTime>
Returns only backup jobs that were created after the specified date.
by_resource_type: Option<String>
Returns only backup jobs for the specified resources:
-
Aurora
for Amazon Aurora -
CloudFormation
for CloudFormation -
DocumentDB
for Amazon DocumentDB (with MongoDB compatibility) -
DynamoDB
for Amazon DynamoDB -
EBS
for Amazon Elastic Block Store -
EC2
for Amazon Elastic Compute Cloud -
EFS
for Amazon Elastic File System -
FSx
for Amazon FSx -
Neptune
for Amazon Neptune -
RDS
for Amazon Relational Database Service -
Redshift
for Amazon Redshift -
S3
for Amazon Simple Storage Service (Amazon S3) -
SAP HANA on Amazon EC2
for SAP HANA databases on Amazon Elastic Compute Cloud instances -
Storage Gateway
for Storage Gateway -
Timestream
for Amazon Timestream -
VirtualMachine
for VMware virtual machines
by_account_id: Option<String>
The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.
If used from an Organizations management account, passing *
returns all jobs across the organization.
by_complete_after: Option<DateTime>
Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
by_complete_before: Option<DateTime>
Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
by_parent_job_id: Option<String>
This is a filter to list child (nested) jobs based on parent job ID.
by_message_category: Option<String>
This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.
Example strings may include AccessDenied
, SUCCESS
, AGGREGATE_ALL
, and InvalidParameters
.
View Monitoring
The wildcard () returns count of all message categories.
AGGREGATE_ALL
aggregates job counts for all message categories and returns the sum.
Implementations§
Source§impl ListBackupJobsInput
impl ListBackupJobsInput
Sourcepub fn next_token(&self) -> Option<&str>
pub fn next_token(&self) -> Option<&str>
The next item following a partial list of returned items. For example, if a request is made to return MaxResults
number of items, NextToken
allows you to return more items in your list starting at the location pointed to by the next token.
Sourcepub fn max_results(&self) -> Option<i32>
pub fn max_results(&self) -> Option<i32>
The maximum number of items to be returned.
Sourcepub fn by_resource_arn(&self) -> Option<&str>
pub fn by_resource_arn(&self) -> Option<&str>
Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
Sourcepub fn by_state(&self) -> Option<&BackupJobState>
pub fn by_state(&self) -> Option<&BackupJobState>
Returns only backup jobs that are in the specified state.
Completed with issues
is a status found only in the Backup console. For API, this status refers to jobs with a state of COMPLETED
and a MessageCategory
with a value other than SUCCESS
; that is, the status is completed but comes with a status message.
To obtain the job count for Completed with issues
, run two GET requests, and subtract the second, smaller number:
GET /backup-jobs/?state=COMPLETED
GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
Sourcepub fn by_backup_vault_name(&self) -> Option<&str>
pub fn by_backup_vault_name(&self) -> Option<&str>
Returns only backup jobs that will be stored in the specified backup vault. 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 by_created_before(&self) -> Option<&DateTime>
pub fn by_created_before(&self) -> Option<&DateTime>
Returns only backup jobs that were created before the specified date.
Sourcepub fn by_created_after(&self) -> Option<&DateTime>
pub fn by_created_after(&self) -> Option<&DateTime>
Returns only backup jobs that were created after the specified date.
Sourcepub fn by_resource_type(&self) -> Option<&str>
pub fn by_resource_type(&self) -> Option<&str>
Returns only backup jobs for the specified resources:
-
Aurora
for Amazon Aurora -
CloudFormation
for CloudFormation -
DocumentDB
for Amazon DocumentDB (with MongoDB compatibility) -
DynamoDB
for Amazon DynamoDB -
EBS
for Amazon Elastic Block Store -
EC2
for Amazon Elastic Compute Cloud -
EFS
for Amazon Elastic File System -
FSx
for Amazon FSx -
Neptune
for Amazon Neptune -
RDS
for Amazon Relational Database Service -
Redshift
for Amazon Redshift -
S3
for Amazon Simple Storage Service (Amazon S3) -
SAP HANA on Amazon EC2
for SAP HANA databases on Amazon Elastic Compute Cloud instances -
Storage Gateway
for Storage Gateway -
Timestream
for Amazon Timestream -
VirtualMachine
for VMware virtual machines
Sourcepub fn by_account_id(&self) -> Option<&str>
pub fn by_account_id(&self) -> Option<&str>
The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.
If used from an Organizations management account, passing *
returns all jobs across the organization.
Sourcepub fn by_complete_after(&self) -> Option<&DateTime>
pub fn by_complete_after(&self) -> Option<&DateTime>
Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
Sourcepub fn by_complete_before(&self) -> Option<&DateTime>
pub fn by_complete_before(&self) -> Option<&DateTime>
Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
Sourcepub fn by_parent_job_id(&self) -> Option<&str>
pub fn by_parent_job_id(&self) -> Option<&str>
This is a filter to list child (nested) jobs based on parent job ID.
Sourcepub fn by_message_category(&self) -> Option<&str>
pub fn by_message_category(&self) -> Option<&str>
This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.
Example strings may include AccessDenied
, SUCCESS
, AGGREGATE_ALL
, and InvalidParameters
.
View Monitoring
The wildcard () returns count of all message categories.
AGGREGATE_ALL
aggregates job counts for all message categories and returns the sum.
Source§impl ListBackupJobsInput
impl ListBackupJobsInput
Sourcepub fn builder() -> ListBackupJobsInputBuilder
pub fn builder() -> ListBackupJobsInputBuilder
Creates a new builder-style object to manufacture ListBackupJobsInput
.
Trait Implementations§
Source§impl Clone for ListBackupJobsInput
impl Clone for ListBackupJobsInput
Source§fn clone(&self) -> ListBackupJobsInput
fn clone(&self) -> ListBackupJobsInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ListBackupJobsInput
impl Debug for ListBackupJobsInput
Source§impl PartialEq for ListBackupJobsInput
impl PartialEq for ListBackupJobsInput
impl StructuralPartialEq for ListBackupJobsInput
Auto Trait Implementations§
impl Freeze for ListBackupJobsInput
impl RefUnwindSafe for ListBackupJobsInput
impl Send for ListBackupJobsInput
impl Sync for ListBackupJobsInput
impl Unpin for ListBackupJobsInput
impl UnwindSafe for ListBackupJobsInput
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);