Struct rusoto_backup::BackupClient

pub struct BackupClient { /* fields omitted */ }

A client for the AWS Backup API.

Implementations

impl BackupClient

pub fn new(region: Region) -> BackupClient

Creates a client backed by the default tokio event loop.

The client will use the default credentials provider and tls client.

pub fn new_with<P, D>(
    request_dispatcher: D,
    credentials_provider: P,
    region: Region
) -> BackupClient where
    P: ProvideAwsCredentials + Send + Sync + 'static,
    D: DispatchSignedRequest + Send + Sync + 'static, 

pub fn new_with_client(client: Client, region: Region) -> BackupClient

Trait Implementations

impl Backup for BackupClient

pub fn create_backup_plan<'life0, 'async_trait>(
    &'life0 self,
    input: CreateBackupPlanInput
) -> Pin<Box<dyn Future<Output = Result<CreateBackupPlanOutput, RusotoError<CreateBackupPlanError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery points of resources.

If you call CreateBackupPlan with a plan that already exists, an AlreadyExistsException is returned.

pub fn create_backup_selection<'life0, 'async_trait>(
    &'life0 self,
    input: CreateBackupSelectionInput
) -> Pin<Box<dyn Future<Output = Result<CreateBackupSelectionOutput, RusotoError<CreateBackupSelectionError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Creates a JSON document that specifies a set of resources to assign to a backup plan. Resources can be included by specifying patterns for a ListOfTags and selected Resources.

For example, consider the following patterns:

• Resources: "arn:aws:ec2:region:account-id:volume/volume-id"

• ConditionKey:"department"

  ConditionValue:"finance"

  ConditionType:"STRINGEQUALS"

• ConditionKey:"importance"

  ConditionValue:"critical"

  ConditionType:"STRINGEQUALS"

Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as "department=finance", "importance=critical", in addition to an EBS volume with the specified volume Id.

Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically 'put together using the OR operator. In other words, all patterns that match are selected for backup.

pub fn create_backup_vault<'life0, 'async_trait>(
    &'life0 self,
    input: CreateBackupVaultInput
) -> Pin<Box<dyn Future<Output = Result<CreateBackupVaultOutput, RusotoError<CreateBackupVaultError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID.

Sensitive data, such as passport numbers, should not be included the name of a backup vault.

pub fn delete_backup_plan<'life0, 'async_trait>(
    &'life0 self,
    input: DeleteBackupPlanInput
) -> Pin<Box<dyn Future<Output = Result<DeleteBackupPlanOutput, RusotoError<DeleteBackupPlanError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.

pub fn delete_backup_selection<'life0, 'async_trait>(
    &'life0 self,
    input: DeleteBackupSelectionInput
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteBackupSelectionError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes the resource selection associated with a backup plan that is specified by the SelectionId.

pub fn delete_backup_vault<'life0, 'async_trait>(
    &'life0 self,
    input: DeleteBackupVaultInput
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteBackupVaultError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.

pub fn delete_backup_vault_access_policy<'life0, 'async_trait>(
    &'life0 self,
    input: DeleteBackupVaultAccessPolicyInput
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteBackupVaultAccessPolicyError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes the policy document that manages permissions on a backup vault.

pub fn delete_backup_vault_notifications<'life0, 'async_trait>(
    &'life0 self,
    input: DeleteBackupVaultNotificationsInput
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteBackupVaultNotificationsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes event notifications for the specified backup vault.

pub fn delete_recovery_point<'life0, 'async_trait>(
    &'life0 self,
    input: DeleteRecoveryPointInput
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteRecoveryPointError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes the recovery point specified by a recovery point ID.

pub fn describe_backup_job<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeBackupJobInput
) -> Pin<Box<dyn Future<Output = Result<DescribeBackupJobOutput, RusotoError<DescribeBackupJobError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns metadata associated with creating a backup of a resource.

pub fn describe_backup_vault<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeBackupVaultInput
) -> Pin<Box<dyn Future<Output = Result<DescribeBackupVaultOutput, RusotoError<DescribeBackupVaultError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns metadata about a backup vault specified by its name.

pub fn describe_copy_job<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeCopyJobInput
) -> Pin<Box<dyn Future<Output = Result<DescribeCopyJobOutput, RusotoError<DescribeCopyJobError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns metadata associated with creating a copy of a resource.

pub fn describe_protected_resource<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeProtectedResourceInput
) -> Pin<Box<dyn Future<Output = Result<DescribeProtectedResourceOutput, RusotoError<DescribeProtectedResourceError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource.

pub fn describe_recovery_point<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeRecoveryPointInput
) -> Pin<Box<dyn Future<Output = Result<DescribeRecoveryPointOutput, RusotoError<DescribeRecoveryPointError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.

pub fn describe_region_settings<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<DescribeRegionSettingsOutput, RusotoError<DescribeRegionSettingsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the current service opt-in settings for the Region. If the service has a value set to true, AWS Backup attempts to protect that service's resources in this Region, when included in an on-demand backup or scheduled backup plan. If the value is set to false for a service, AWS Backup does not attempt to protect that service's resources in this Region.

pub fn describe_restore_job<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeRestoreJobInput
) -> Pin<Box<dyn Future<Output = Result<DescribeRestoreJobOutput, RusotoError<DescribeRestoreJobError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns metadata associated with a restore job that is specified by a job ID.

pub fn export_backup_plan_template<'life0, 'async_trait>(
    &'life0 self,
    input: ExportBackupPlanTemplateInput
) -> Pin<Box<dyn Future<Output = Result<ExportBackupPlanTemplateOutput, RusotoError<ExportBackupPlanTemplateError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the backup plan that is specified by the plan ID as a backup template.

pub fn get_backup_plan<'life0, 'async_trait>(
    &'life0 self,
    input: GetBackupPlanInput
) -> Pin<Box<dyn Future<Output = Result<GetBackupPlanOutput, RusotoError<GetBackupPlanError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the body of a backup plan in JSON format, in addition to plan metadata.

pub fn get_backup_plan_from_json<'life0, 'async_trait>(
    &'life0 self,
    input: GetBackupPlanFromJSONInput
) -> Pin<Box<dyn Future<Output = Result<GetBackupPlanFromJSONOutput, RusotoError<GetBackupPlanFromJSONError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns a valid JSON document specifying a backup plan or an error.

pub fn get_backup_plan_from_template<'life0, 'async_trait>(
    &'life0 self,
    input: GetBackupPlanFromTemplateInput
) -> Pin<Box<dyn Future<Output = Result<GetBackupPlanFromTemplateOutput, RusotoError<GetBackupPlanFromTemplateError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the template specified by its templateId as a backup plan.

pub fn get_backup_selection<'life0, 'async_trait>(
    &'life0 self,
    input: GetBackupSelectionInput
) -> Pin<Box<dyn Future<Output = Result<GetBackupSelectionOutput, RusotoError<GetBackupSelectionError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.

pub fn get_backup_vault_access_policy<'life0, 'async_trait>(
    &'life0 self,
    input: GetBackupVaultAccessPolicyInput
) -> Pin<Box<dyn Future<Output = Result<GetBackupVaultAccessPolicyOutput, RusotoError<GetBackupVaultAccessPolicyError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the access policy document that is associated with the named backup vault.

pub fn get_backup_vault_notifications<'life0, 'async_trait>(
    &'life0 self,
    input: GetBackupVaultNotificationsInput
) -> Pin<Box<dyn Future<Output = Result<GetBackupVaultNotificationsOutput, RusotoError<GetBackupVaultNotificationsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns event notifications for the specified backup vault.

pub fn get_recovery_point_restore_metadata<'life0, 'async_trait>(
    &'life0 self,
    input: GetRecoveryPointRestoreMetadataInput
) -> Pin<Box<dyn Future<Output = Result<GetRecoveryPointRestoreMetadataOutput, RusotoError<GetRecoveryPointRestoreMetadataError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns a set of metadata key-value pairs that were used to create the backup.

pub fn get_supported_resource_types<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<GetSupportedResourceTypesOutput, RusotoError<GetSupportedResourceTypesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the AWS resource types supported by AWS Backup.

pub fn list_backup_jobs<'life0, 'async_trait>(
    &'life0 self,
    input: ListBackupJobsInput
) -> Pin<Box<dyn Future<Output = Result<ListBackupJobsOutput, RusotoError<ListBackupJobsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns metadata about your backup jobs.

pub fn list_backup_plan_templates<'life0, 'async_trait>(
    &'life0 self,
    input: ListBackupPlanTemplatesInput
) -> Pin<Box<dyn Future<Output = Result<ListBackupPlanTemplatesOutput, RusotoError<ListBackupPlanTemplatesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.

pub fn list_backup_plan_versions<'life0, 'async_trait>(
    &'life0 self,
    input: ListBackupPlanVersionsInput
) -> Pin<Box<dyn Future<Output = Result<ListBackupPlanVersionsOutput, RusotoError<ListBackupPlanVersionsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.

pub fn list_backup_plans<'life0, 'async_trait>(
    &'life0 self,
    input: ListBackupPlansInput
) -> Pin<Box<dyn Future<Output = Result<ListBackupPlansOutput, RusotoError<ListBackupPlansError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.

pub fn list_backup_selections<'life0, 'async_trait>(
    &'life0 self,
    input: ListBackupSelectionsInput
) -> Pin<Box<dyn Future<Output = Result<ListBackupSelectionsOutput, RusotoError<ListBackupSelectionsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns an array containing metadata of the resources associated with the target backup plan.

pub fn list_backup_vaults<'life0, 'async_trait>(
    &'life0 self,
    input: ListBackupVaultsInput
) -> Pin<Box<dyn Future<Output = Result<ListBackupVaultsOutput, RusotoError<ListBackupVaultsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns a list of recovery point storage containers along with information about them.

pub fn list_copy_jobs<'life0, 'async_trait>(
    &'life0 self,
    input: ListCopyJobsInput
) -> Pin<Box<dyn Future<Output = Result<ListCopyJobsOutput, RusotoError<ListCopyJobsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns metadata about your copy jobs.

pub fn list_protected_resources<'life0, 'async_trait>(
    &'life0 self,
    input: ListProtectedResourcesInput
) -> Pin<Box<dyn Future<Output = Result<ListProtectedResourcesOutput, RusotoError<ListProtectedResourcesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.

pub fn list_recovery_points_by_backup_vault<'life0, 'async_trait>(
    &'life0 self,
    input: ListRecoveryPointsByBackupVaultInput
) -> Pin<Box<dyn Future<Output = Result<ListRecoveryPointsByBackupVaultOutput, RusotoError<ListRecoveryPointsByBackupVaultError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns detailed information about the recovery points stored in a backup vault.

pub fn list_recovery_points_by_resource<'life0, 'async_trait>(
    &'life0 self,
    input: ListRecoveryPointsByResourceInput
) -> Pin<Box<dyn Future<Output = Result<ListRecoveryPointsByResourceOutput, RusotoError<ListRecoveryPointsByResourceError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).

pub fn list_restore_jobs<'life0, 'async_trait>(
    &'life0 self,
    input: ListRestoreJobsInput
) -> Pin<Box<dyn Future<Output = Result<ListRestoreJobsOutput, RusotoError<ListRestoreJobsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.

pub fn list_tags<'life0, 'async_trait>(
    &'life0 self,
    input: ListTagsInput
) -> Pin<Box<dyn Future<Output = Result<ListTagsOutput, RusotoError<ListTagsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.

ListTags are currently only supported with Amazon EFS backups.

pub fn put_backup_vault_access_policy<'life0, 'async_trait>(
    &'life0 self,
    input: PutBackupVaultAccessPolicyInput
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<PutBackupVaultAccessPolicyError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.

pub fn put_backup_vault_notifications<'life0, 'async_trait>(
    &'life0 self,
    input: PutBackupVaultNotificationsInput
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<PutBackupVaultNotificationsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Turns on notifications on a backup vault for the specified topic and events.

pub fn start_backup_job<'life0, 'async_trait>(
    &'life0 self,
    input: StartBackupJobInput
) -> Pin<Box<dyn Future<Output = Result<StartBackupJobOutput, RusotoError<StartBackupJobError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Starts a job to create a one-time backup of the specified resource.

pub fn start_copy_job<'life0, 'async_trait>(
    &'life0 self,
    input: StartCopyJobInput
) -> Pin<Box<dyn Future<Output = Result<StartCopyJobOutput, RusotoError<StartCopyJobError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Starts a job to create a one-time copy of the specified resource.

pub fn start_restore_job<'life0, 'async_trait>(
    &'life0 self,
    input: StartRestoreJobInput
) -> Pin<Box<dyn Future<Output = Result<StartRestoreJobOutput, RusotoError<StartRestoreJobError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Recovers the saved resource identified by an Amazon Resource Name (ARN).

If the resource ARN is included in the request, then the last complete backup of that resource is recovered. If the ARN of a recovery point is supplied, then that recovery point is restored.

pub fn stop_backup_job<'life0, 'async_trait>(
    &'life0 self,
    input: StopBackupJobInput
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<StopBackupJobError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Attempts to cancel a job to create a one-time backup of a resource.

pub fn tag_resource<'life0, 'async_trait>(
    &'life0 self,
    input: TagResourceInput
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<TagResourceError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).

pub fn untag_resource<'life0, 'async_trait>(
    &'life0 self,
    input: UntagResourceInput
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UntagResourceError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)

pub fn update_backup_plan<'life0, 'async_trait>(
    &'life0 self,
    input: UpdateBackupPlanInput
) -> Pin<Box<dyn Future<Output = Result<UpdateBackupPlanOutput, RusotoError<UpdateBackupPlanError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Replaces the body of a saved backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.

pub fn update_recovery_point_lifecycle<'life0, 'async_trait>(
    &'life0 self,
    input: UpdateRecoveryPointLifecycleInput
) -> Pin<Box<dyn Future<Output = Result<UpdateRecoveryPointLifecycleOutput, RusotoError<UpdateRecoveryPointLifecycleError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Sets the transition lifecycle of a recovery point.

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

pub fn update_region_settings<'life0, 'async_trait>(
    &'life0 self,
    input: UpdateRegionSettingsInput
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UpdateRegionSettingsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Updates the current service opt-in settings for the Region. If the service has a value set to true, AWS Backup attempts to protect that service's resources in this Region, when included in an on-demand backup or scheduled backup plan. If the value is set to false for a service, AWS Backup does not attempt to protect that service's resources in this Region.

impl Clone for BackupClient

pub fn clone(&self) -> BackupClient

Returns a copy of the value.

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

Performs copy-assignment from source.