Struct aws_sdk_backup::operation::list_backup_job_summaries::builders::ListBackupJobSummariesInputBuilder

#[non_exhaustive]
pub struct ListBackupJobSummariesInputBuilder { /* private fields */ }

A builder for ListBackupJobSummariesInput.

Implementations

impl ListBackupJobSummariesInputBuilder

pub fn account_id(self, input: impl Into<String>) -> Self

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 set_account_id(self, input: Option<String>) -> Self

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 get_account_id(&self) -> &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.

pub fn state(self, input: BackupJobStatus) -> Self

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 set_state(self, input: Option<BackupJobStatus>) -> Self

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 get_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, input: impl Into<String>) -> Self

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 set_resource_type(self, input: Option<String>) -> Self

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 get_resource_type(&self) -> &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.

pub fn message_category(self, input: impl Into<String>) -> Self

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 set_message_category(self, input: Option<String>) -> Self

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 get_message_category(&self) -> &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.

pub fn aggregation_period(self, input: AggregationPeriod) -> Self

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 set_aggregation_period(self, input: Option<AggregationPeriod>) -> Self

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 get_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, input: i32) -> Self

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 set_max_results(self, input: Option<i32>) -> Self

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 get_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, input: impl Into<String>) -> Self

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.

pub fn set_next_token(self, input: Option<String>) -> Self

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.

pub fn get_next_token(&self) -> &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.

pub fn build(self) -> Result<ListBackupJobSummariesInput, BuildError>

Consumes the builder and constructs a ListBackupJobSummariesInput.

impl ListBackupJobSummariesInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<ListBackupJobSummariesOutput, SdkError<ListBackupJobSummariesError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for ListBackupJobSummariesInputBuilder

fn clone(&self) -> ListBackupJobSummariesInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListBackupJobSummariesInputBuilder

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

Formats the value using the given formatter.

impl Default for ListBackupJobSummariesInputBuilder

fn default() -> ListBackupJobSummariesInputBuilder

Returns the “default value” for a type.

impl PartialEq for ListBackupJobSummariesInputBuilder

fn eq(&self, other: &ListBackupJobSummariesInputBuilder) -> 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 StructuralPartialEq for ListBackupJobSummariesInputBuilder