1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListCopyJobSummaries`](crate::operation::list_copy_job_summaries::builders::ListCopyJobSummariesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_copy_job_summaries::builders::ListCopyJobSummariesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`account_id(impl Into<String>)`](crate::operation::list_copy_job_summaries::builders::ListCopyJobSummariesFluentBuilder::account_id) / [`set_account_id(Option<String>)`](crate::operation::list_copy_job_summaries::builders::ListCopyJobSummariesFluentBuilder::set_account_id):<br>required: **false**<br><p>Returns the job count for the specified account.</p> <p>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.</p> <p>Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.</p> <p><code>AGGREGATE_ALL</code> aggregates job counts from all accounts within the authenticated organization, then returns the sum.</p><br>
    ///   - [`state(CopyJobStatus)`](crate::operation::list_copy_job_summaries::builders::ListCopyJobSummariesFluentBuilder::state) / [`set_state(Option<CopyJobStatus>)`](crate::operation::list_copy_job_summaries::builders::ListCopyJobSummariesFluentBuilder::set_state):<br>required: **false**<br><p>This parameter returns the job count for jobs with the specified state.</p> <p>The the value ANY returns count of all states.</p> <p><code>AGGREGATE_ALL</code> aggregates job counts for all states and returns the sum.</p><br>
    ///   - [`resource_type(impl Into<String>)`](crate::operation::list_copy_job_summaries::builders::ListCopyJobSummariesFluentBuilder::resource_type) / [`set_resource_type(Option<String>)`](crate::operation::list_copy_job_summaries::builders::ListCopyJobSummariesFluentBuilder::set_resource_type):<br>required: **false**<br><p>Returns the job count for the specified resource type. Use request <code>GetSupportedResourceTypes</code> to obtain strings for supported resource types.</p> <p>The the value ANY returns count of all resource types.</p> <p><code>AGGREGATE_ALL</code> aggregates job counts for all resource types and returns the sum.</p> <p>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.</p><br>
    ///   - [`message_category(impl Into<String>)`](crate::operation::list_copy_job_summaries::builders::ListCopyJobSummariesFluentBuilder::message_category) / [`set_message_category(Option<String>)`](crate::operation::list_copy_job_summaries::builders::ListCopyJobSummariesFluentBuilder::set_message_category):<br>required: **false**<br><p>This parameter returns the job count for the specified message category.</p> <p>Example accepted strings include <code>AccessDenied</code>, <code>Success</code>, and <code>InvalidParameters</code>. See <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a> for a list of accepted MessageCategory strings.</p> <p>The the value ANY returns count of all message categories.</p> <p><code>AGGREGATE_ALL</code> aggregates job counts for all message categories and returns the sum.</p><br>
    ///   - [`aggregation_period(AggregationPeriod)`](crate::operation::list_copy_job_summaries::builders::ListCopyJobSummariesFluentBuilder::aggregation_period) / [`set_aggregation_period(Option<AggregationPeriod>)`](crate::operation::list_copy_job_summaries::builders::ListCopyJobSummariesFluentBuilder::set_aggregation_period):<br>required: **false**<br><p>This is the period that sets the boundaries for returned results.</p> <ul>  <li>   <p><code>ONE_DAY</code> for daily job count for the prior 14 days.</p></li>  <li>   <p><code>SEVEN_DAYS</code> for the aggregated job count for the prior 7 days.</p></li>  <li>   <p><code>FOURTEEN_DAYS</code> for aggregated job count for prior 14 days.</p></li> </ul><br>
    ///   - [`max_results(i32)`](crate::operation::list_copy_job_summaries::builders::ListCopyJobSummariesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_copy_job_summaries::builders::ListCopyJobSummariesFluentBuilder::set_max_results):<br>required: **false**<br><p>This parameter sets the maximum number of items to be returned.</p> <p>The value is an integer. Range of accepted values is from 1 to 500.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_copy_job_summaries::builders::ListCopyJobSummariesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_copy_job_summaries::builders::ListCopyJobSummariesFluentBuilder::set_next_token):<br>required: **false**<br><p>The next item following a partial list of returned resources. For example, if a request is made to return <code>MaxResults</code> number of resources, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p><br>
    /// - On success, responds with [`ListCopyJobSummariesOutput`](crate::operation::list_copy_job_summaries::ListCopyJobSummariesOutput) with field(s):
    ///   - [`copy_job_summaries(Option<Vec::<CopyJobSummary>>)`](crate::operation::list_copy_job_summaries::ListCopyJobSummariesOutput::copy_job_summaries): <p>This return shows a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.</p>
    ///   - [`aggregation_period(Option<String>)`](crate::operation::list_copy_job_summaries::ListCopyJobSummariesOutput::aggregation_period): <p>This is the period that sets the boundaries for returned results.</p> <ul>  <li>   <p><code>ONE_DAY</code> for daily job count for the prior 14 days.</p></li>  <li>   <p><code>SEVEN_DAYS</code> for the aggregated job count for the prior 7 days.</p></li>  <li>   <p><code>FOURTEEN_DAYS</code> for aggregated job count for prior 14 days.</p></li> </ul>
    ///   - [`next_token(Option<String>)`](crate::operation::list_copy_job_summaries::ListCopyJobSummariesOutput::next_token): <p>The next item following a partial list of returned resources. For example, if a request is made to return <code>MaxResults</code> number of resources, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>
    /// - On failure, responds with [`SdkError<ListCopyJobSummariesError>`](crate::operation::list_copy_job_summaries::ListCopyJobSummariesError)
    pub fn list_copy_job_summaries(&self) -> crate::operation::list_copy_job_summaries::builders::ListCopyJobSummariesFluentBuilder {
        crate::operation::list_copy_job_summaries::builders::ListCopyJobSummariesFluentBuilder::new(self.handle.clone())
    }
}