Struct aws_sdk_backup::operation::list_backup_job_summaries::ListBackupJobSummariesInput

#[non_exhaustive]
pub struct ListBackupJobSummariesInput {
    pub account_id: Option<String>,
    pub state: Option<BackupJobStatus>,
    pub resource_type: Option<String>,
    pub message_category: Option<String>,
    pub aggregation_period: Option<AggregationPeriod>,
    pub max_results: Option<i32>,
    pub next_token: Option<String>,
}

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 job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

state: Option<BackupJobStatus>

This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

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 /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED

GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED

resource_type: Option<String>

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

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.

message_category: Option<String>

This parameter returns the job count for the specified message category.

Example accepted strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of accepted 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.

aggregation_period: Option<AggregationPeriod>

This is the period that sets the boundaries for returned results.

Acceptable values include

• ONE_DAY for daily job count for the prior 14 days.

• SEVEN_DAYS for the aggregated job count for the prior 7 days.

• FOURTEEN_DAYS for aggregated job count for prior 14 days.

max_results: Option<i32>

This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

next_token: Option<String>

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Implementations

impl ListBackupJobSummariesInput

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

Returns the job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

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

This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

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 /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED

GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED

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

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

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 message_category(&self) -> Option<&str>

This parameter returns the job count for the specified message category.

Example accepted strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of accepted 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.

pub fn aggregation_period(&self) -> Option<&AggregationPeriod>

This is the period that sets the boundaries for returned results.

Acceptable values include

• ONE_DAY for daily job count for the prior 14 days.

• SEVEN_DAYS for the aggregated job count for the prior 7 days.

• FOURTEEN_DAYS for aggregated job count for prior 14 days.

pub fn max_results(&self) -> Option<i32>

This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

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

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

impl ListBackupJobSummariesInput

pub fn builder() -> ListBackupJobSummariesInputBuilder

Creates a new builder-style object to manufacture ListBackupJobSummariesInput.

Trait Implementations

impl Clone for ListBackupJobSummariesInput

fn clone(&self) -> ListBackupJobSummariesInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListBackupJobSummariesInput

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

Formats the value using the given formatter.

impl PartialEq for ListBackupJobSummariesInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ListBackupJobSummariesInput