Struct aws_sdk_backup::operation::list_copy_jobs::ListCopyJobsInput
source · #[non_exhaustive]pub struct ListCopyJobsInput {Show 13 fields
pub next_token: Option<String>,
pub max_results: Option<i32>,
pub by_resource_arn: Option<String>,
pub by_state: Option<CopyJobState>,
pub by_created_before: Option<DateTime>,
pub by_created_after: Option<DateTime>,
pub by_resource_type: Option<String>,
pub by_destination_vault_arn: Option<String>,
pub by_account_id: Option<String>,
pub by_complete_before: Option<DateTime>,
pub by_complete_after: 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 copy jobs that match the specified resource Amazon Resource Name (ARN).
by_state: Option<CopyJobState>
Returns only copy jobs that are in the specified state.
by_created_before: Option<DateTime>
Returns only copy jobs that were created before the specified date.
by_created_after: Option<DateTime>
Returns only copy 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 -
Redshift
for Amazon Redshift -
RDS
for Amazon Relational Database Service -
SAP HANA on Amazon EC2
for SAP HANA databases -
Storage Gateway
for Storage Gateway -
S3
for Amazon S3 -
Timestream
for Amazon Timestream -
VirtualMachine
for virtual machines
by_destination_vault_arn: Option<String>
An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
by_account_id: Option<String>
The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.
by_complete_before: Option<DateTime>
Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
by_complete_after: Option<DateTime>
Returns only copy jobs completed after 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 for a list of accepted 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 ListCopyJobsInput
impl ListCopyJobsInput
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 copy jobs that match the specified resource Amazon Resource Name (ARN).
sourcepub fn by_state(&self) -> Option<&CopyJobState>
pub fn by_state(&self) -> Option<&CopyJobState>
Returns only copy jobs that are in the specified state.
sourcepub fn by_created_before(&self) -> Option<&DateTime>
pub fn by_created_before(&self) -> Option<&DateTime>
Returns only copy 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 copy 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 -
Redshift
for Amazon Redshift -
RDS
for Amazon Relational Database Service -
SAP HANA on Amazon EC2
for SAP HANA databases -
Storage Gateway
for Storage Gateway -
S3
for Amazon S3 -
Timestream
for Amazon Timestream -
VirtualMachine
for virtual machines
sourcepub fn by_destination_vault_arn(&self) -> Option<&str>
pub fn by_destination_vault_arn(&self) -> Option<&str>
An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
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 copy jobs associated with the specified account ID.
sourcepub fn by_complete_before(&self) -> Option<&DateTime>
pub fn by_complete_before(&self) -> Option<&DateTime>
Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
sourcepub fn by_complete_after(&self) -> Option<&DateTime>
pub fn by_complete_after(&self) -> Option<&DateTime>
Returns only copy jobs completed after 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 for a list of accepted strings.
The the value ANY returns count of all message categories.
AGGREGATE_ALL
aggregates job counts for all message categories and returns the sum.
source§impl ListCopyJobsInput
impl ListCopyJobsInput
sourcepub fn builder() -> ListCopyJobsInputBuilder
pub fn builder() -> ListCopyJobsInputBuilder
Creates a new builder-style object to manufacture ListCopyJobsInput
.
Trait Implementations§
source§impl Clone for ListCopyJobsInput
impl Clone for ListCopyJobsInput
source§fn clone(&self) -> ListCopyJobsInput
fn clone(&self) -> ListCopyJobsInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ListCopyJobsInput
impl Debug for ListCopyJobsInput
source§impl PartialEq for ListCopyJobsInput
impl PartialEq for ListCopyJobsInput
source§fn eq(&self, other: &ListCopyJobsInput) -> bool
fn eq(&self, other: &ListCopyJobsInput) -> bool
self
and other
values to be equal, and is used
by ==
.