aws_sdk_backup/client/
list_copy_jobs.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListCopyJobs`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::set_next_token):<br>required: **false**<br><p>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.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to be returned.</p><br>
    ///   - [`by_resource_arn(impl Into<String>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::by_resource_arn) / [`set_by_resource_arn(Option<String>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::set_by_resource_arn):<br>required: **false**<br><p>Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).</p><br>
    ///   - [`by_state(CopyJobState)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::by_state) / [`set_by_state(Option<CopyJobState>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::set_by_state):<br>required: **false**<br><p>Returns only copy jobs that are in the specified state.</p><br>
    ///   - [`by_created_before(DateTime)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::by_created_before) / [`set_by_created_before(Option<DateTime>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::set_by_created_before):<br>required: **false**<br><p>Returns only copy jobs that were created before the specified date.</p><br>
    ///   - [`by_created_after(DateTime)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::by_created_after) / [`set_by_created_after(Option<DateTime>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::set_by_created_after):<br>required: **false**<br><p>Returns only copy jobs that were created after the specified date.</p><br>
    ///   - [`by_resource_type(impl Into<String>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::by_resource_type) / [`set_by_resource_type(Option<String>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::set_by_resource_type):<br>required: **false**<br><p>Returns only backup jobs for the specified resources:</p> <ul>  <li>   <p><code>Aurora</code> for Amazon Aurora</p></li>  <li>   <p><code>CloudFormation</code> for CloudFormation</p></li>  <li>   <p><code>DocumentDB</code> for Amazon DocumentDB (with MongoDB compatibility)</p></li>  <li>   <p><code>DynamoDB</code> for Amazon DynamoDB</p></li>  <li>   <p><code>EBS</code> for Amazon Elastic Block Store</p></li>  <li>   <p><code>EC2</code> for Amazon Elastic Compute Cloud</p></li>  <li>   <p><code>EFS</code> for Amazon Elastic File System</p></li>  <li>   <p><code>FSx</code> for Amazon FSx</p></li>  <li>   <p><code>Neptune</code> for Amazon Neptune</p></li>  <li>   <p><code>RDS</code> for Amazon Relational Database Service</p></li>  <li>   <p><code>Redshift</code> for Amazon Redshift</p></li>  <li>   <p><code>S3</code> for Amazon Simple Storage Service (Amazon S3)</p></li>  <li>   <p><code>SAP HANA on Amazon EC2</code> for SAP HANA databases on Amazon Elastic Compute Cloud instances</p></li>  <li>   <p><code>Storage Gateway</code> for Storage Gateway</p></li>  <li>   <p><code>Timestream</code> for Amazon Timestream</p></li>  <li>   <p><code>VirtualMachine</code> for VMware virtual machines</p></li> </ul><br>
    ///   - [`by_destination_vault_arn(impl Into<String>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::by_destination_vault_arn) / [`set_by_destination_vault_arn(Option<String>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::set_by_destination_vault_arn):<br>required: **false**<br><p>An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, <code>arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault</code>.</p><br>
    ///   - [`by_account_id(impl Into<String>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::by_account_id) / [`set_by_account_id(Option<String>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::set_by_account_id):<br>required: **false**<br><p>The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.</p><br>
    ///   - [`by_complete_before(DateTime)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::by_complete_before) / [`set_by_complete_before(Option<DateTime>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::set_by_complete_before):<br>required: **false**<br><p>Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).</p><br>
    ///   - [`by_complete_after(DateTime)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::by_complete_after) / [`set_by_complete_after(Option<DateTime>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::set_by_complete_after):<br>required: **false**<br><p>Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).</p><br>
    ///   - [`by_parent_job_id(impl Into<String>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::by_parent_job_id) / [`set_by_parent_job_id(Option<String>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::set_by_parent_job_id):<br>required: **false**<br><p>This is a filter to list child (nested) jobs based on parent job ID.</p><br>
    ///   - [`by_message_category(impl Into<String>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::by_message_category) / [`set_by_message_category(Option<String>)`](crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::set_by_message_category):<br>required: **false**<br><p>This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.</p> <p>Example strings may include <code>AccessDenied</code>, <code>SUCCESS</code>, <code>AGGREGATE_ALL</code>, and <code>INVALIDPARAMETERS</code>.</p> <p>View <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a> for a list of accepted 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>
    /// - On success, responds with [`ListCopyJobsOutput`](crate::operation::list_copy_jobs::ListCopyJobsOutput) with field(s):
    ///   - [`copy_jobs(Option<Vec::<CopyJob>>)`](crate::operation::list_copy_jobs::ListCopyJobsOutput::copy_jobs): <p>An array of structures containing metadata about your copy jobs returned in JSON format.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_copy_jobs::ListCopyJobsOutput::next_token): <p>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.</p>
    /// - On failure, responds with [`SdkError<ListCopyJobsError>`](crate::operation::list_copy_jobs::ListCopyJobsError)
    pub fn list_copy_jobs(&self) -> crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder {
        crate::operation::list_copy_jobs::builders::ListCopyJobsFluentBuilder::new(self.handle.clone())
    }
}