Struct aws_sdk_backup::Client

source · [−]
pub struct Client { /* private fields */ }
Expand description

Client for AWS Backup

Client for invoking operations on AWS Backup. Each operation on AWS Backup is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_backup::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_backup::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_backup::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the CreateBackupPlan operation.

Constructs a fluent builder for the CreateBackupSelection operation.

Constructs a fluent builder for the CreateBackupVault operation.

Constructs a fluent builder for the CreateFramework operation.

Constructs a fluent builder for the CreateReportPlan operation.

Constructs a fluent builder for the DeleteBackupPlan operation.

Constructs a fluent builder for the DeleteBackupSelection operation.

Constructs a fluent builder for the DeleteBackupVault operation.

Constructs a fluent builder for the DeleteBackupVaultAccessPolicy operation.

Constructs a fluent builder for the DeleteBackupVaultLockConfiguration operation.

Constructs a fluent builder for the DeleteBackupVaultNotifications operation.

Constructs a fluent builder for the DeleteFramework operation.

Constructs a fluent builder for the DeleteRecoveryPoint operation.

Constructs a fluent builder for the DeleteReportPlan operation.

Constructs a fluent builder for the DescribeBackupJob operation.

  • The fluent builder is configurable:
  • On success, responds with DescribeBackupJobOutput with field(s):
    • account_id(Option<String>):

      Returns the account ID that owns the backup job.

    • backup_job_id(Option<String>):

      Uniquely identifies a request to Backup to back up a resource.

    • backup_vault_name(Option<String>):

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • backup_vault_arn(Option<String>):

      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    • recovery_point_arn(Option<String>):

      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • resource_arn(Option<String>):

      An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

    • creation_date(Option<DateTime>):

      The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • completion_date(Option<DateTime>):

      The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • state(Option<BackupJobState>):

      The current state of a resource recovery point.

    • status_message(Option<String>):

      A detailed message explaining the status of the job to back up a resource.

    • percent_done(Option<String>):

      Contains an estimated percentage that is complete of a job at the time the job status was queried.

    • backup_size_in_bytes(Option<i64>):

      The size, in bytes, of a backup.

    • iam_role_arn(Option<String>):

      Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

    • created_by(Option<RecoveryPointCreator>):

      Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

    • resource_type(Option<String>):

      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.

    • bytes_transferred(Option<i64>):

      The size in bytes transferred to a backup vault at the time that the job status was queried.

    • expected_completion_date(Option<DateTime>):

      The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • start_by(Option<DateTime>):

      Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • backup_options(Option<HashMap<String, String>>):

      Represents the options specified as part of backup plan or on-demand backup job.

    • backup_type(Option<String>):

      Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns “WindowsVSS”. If BackupType is empty, then the backup type was a regular backup.

  • On failure, responds with SdkError<DescribeBackupJobError>

Constructs a fluent builder for the DescribeBackupVault operation.

  • The fluent builder is configurable:
  • On success, responds with DescribeBackupVaultOutput with field(s):
    • backup_vault_name(Option<String>):

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • backup_vault_arn(Option<String>):

      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    • encryption_key_arn(Option<String>):

      The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    • creation_date(Option<DateTime>):

      The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • creator_request_id(Option<String>):

      A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

    • number_of_recovery_points(i64):

      The number of recovery points that are stored in a backup vault.

    • locked(Option<bool>):

      A Boolean that indicates whether Backup Vault Lock is currently protecting the backup vault. True means that Vault Lock causes delete or update operations on the recovery points stored in the vault to fail.

    • min_retention_days(Option<i64>):

      The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.

      If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job’s retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

    • max_retention_days(Option<i64>):

      The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).

      If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job’s retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

    • lock_date(Option<DateTime>):

      The date and time when Backup Vault Lock configuration cannot be changed or deleted.

      If you applied Vault Lock to your vault without specifying a lock date, you can change any of your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.

      This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

  • On failure, responds with SdkError<DescribeBackupVaultError>

Constructs a fluent builder for the DescribeCopyJob operation.

Constructs a fluent builder for the DescribeFramework operation.

  • The fluent builder is configurable:
  • On success, responds with DescribeFrameworkOutput with field(s):
    • framework_name(Option<String>):

      The unique name of a framework.

    • framework_arn(Option<String>):

      An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

    • framework_description(Option<String>):

      An optional description of the framework.

    • framework_controls(Option<Vec<FrameworkControl>>):

      A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

    • creation_time(Option<DateTime>):

      The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • deployment_status(Option<String>):

      The deployment status of a framework. The statuses are:

      CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

    • framework_status(Option<String>):

      A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:

      • ACTIVE when recording is turned on for all resources governed by the framework.

      • PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.

      • INACTIVE when recording is turned off for all resources governed by the framework.

      • UNAVAILABLE when Backup is unable to validate recording status at this time.

    • idempotency_token(Option<String>):

      A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

  • On failure, responds with SdkError<DescribeFrameworkError>

Constructs a fluent builder for the DescribeGlobalSettings operation.

Constructs a fluent builder for the DescribeProtectedResource operation.

Constructs a fluent builder for the DescribeRecoveryPoint operation.

  • The fluent builder is configurable:
  • On success, responds with DescribeRecoveryPointOutput with field(s):
    • recovery_point_arn(Option<String>):

      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • backup_vault_name(Option<String>):

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • backup_vault_arn(Option<String>):

      An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    • source_backup_vault_arn(Option<String>):

      An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:vault:BackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will be null.

    • resource_arn(Option<String>):

      An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

    • resource_type(Option<String>):

      The type of Amazon Web Services resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

    • created_by(Option<RecoveryPointCreator>):

      Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

    • iam_role_arn(Option<String>):

      Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

    • status(Option<RecoveryPointStatus>):

      A status code specifying the state of the recovery point.

      PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.

      EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.

    • status_message(Option<String>):

      A status message explaining the reason for the recovery point deletion failure.

    • creation_date(Option<DateTime>):

      The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • completion_date(Option<DateTime>):

      The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • backup_size_in_bytes(Option<i64>):

      The size, in bytes, of a backup.

    • calculated_lifecycle(Option<CalculatedLifecycle>):

      A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

    • lifecycle(Option<Lifecycle>):

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

      Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” 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.

      Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the “Full Backup management” section of the Feature availability by resource table. Backup ignores this expression for other resource types.

    • encryption_key_arn(Option<String>):

      The server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    • is_encrypted(bool):

      A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

    • storage_class(Option<StorageClass>):

      Specifies the storage class of the recovery point. Valid values are WARM or COLD.

    • last_restore_time(Option<DateTime>):

      The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

  • On failure, responds with SdkError<DescribeRecoveryPointError>

Constructs a fluent builder for the DescribeRegionSettings operation.

Constructs a fluent builder for the DescribeReportJob operation.

Constructs a fluent builder for the DescribeReportPlan operation.

Constructs a fluent builder for the DescribeRestoreJob operation.

Constructs a fluent builder for the DisassociateRecoveryPoint operation.

Constructs a fluent builder for the ExportBackupPlanTemplate operation.

Constructs a fluent builder for the GetBackupPlan operation.

Constructs a fluent builder for the GetBackupPlanFromJSON operation.

Constructs a fluent builder for the GetBackupPlanFromTemplate operation.

Constructs a fluent builder for the GetBackupSelection operation.

Constructs a fluent builder for the GetBackupVaultAccessPolicy operation.

Constructs a fluent builder for the GetBackupVaultNotifications operation.

Constructs a fluent builder for the GetRecoveryPointRestoreMetadata operation.

Constructs a fluent builder for the GetSupportedResourceTypes operation.

  • The fluent builder takes no input, just send it.
  • On success, responds with GetSupportedResourceTypesOutput with field(s):
    • resource_types(Option<Vec<String>>):

      Contains a string with the supported Amazon Web Services resource types:

      • Aurora for Amazon Aurora

      • DynamoDB for Amazon DynamoDB

      • EBS for Amazon Elastic Block Store

      • EC2 for Amazon Elastic Compute Cloud

      • EFS for Amazon Elastic File System

      • FSX for Amazon FSx

      • RDS for Amazon Relational Database Service

      • Storage Gateway for Storage Gateway

      • DocDB for Amazon DocumentDB (with MongoDB compatibility)

      • Neptune for Amazon Neptune

  • On failure, responds with SdkError<GetSupportedResourceTypesError>

Constructs a fluent builder for the ListBackupJobs operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListBackupPlans operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListBackupPlanTemplates operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListBackupPlanVersions operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListBackupSelections operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListBackupVaults operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListCopyJobs operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListFrameworks operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListProtectedResources operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListRecoveryPointsByBackupVault operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListRecoveryPointsByResource operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListReportJobs operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListReportPlans operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListRestoreJobs operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListTags operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the PutBackupVaultAccessPolicy operation.

Constructs a fluent builder for the PutBackupVaultLockConfiguration operation.

  • The fluent builder is configurable:
    • backup_vault_name(impl Into<String>) / set_backup_vault_name(Option<String>):

      The Backup Vault Lock configuration that specifies the name of the backup vault it protects.

    • min_retention_days(i64) / set_min_retention_days(Option<i64>):

      The Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization’s policies require you to retain certain data for at least seven years (2555 days).

      If this parameter is not specified, Vault Lock will not enforce a minimum retention period.

      If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job’s retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault. The shortest minimum retention period you can specify is 1 day. Recovery points already saved in the vault prior to Vault Lock are not affected.

    • max_retention_days(i64) / set_max_retention_days(Option<i64>):

      The Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization’s policies require you to destroy certain data after retaining it for four years (1460 days).

      If this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period.

      If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job’s retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. The longest maximum retention period you can specify is 36500 days (approximately 100 years). Recovery points already saved in the vault prior to Vault Lock are not affected.

    • changeable_for_days(i64) / set_changeable_for_days(Option<i64>):

      The Backup Vault Lock configuration that specifies the number of days before the lock date. For example, setting ChangeableForDays to 30 on Jan. 1, 2022 at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.

      Backup enforces a 72-hour cooling-off period before Vault Lock takes effect and becomes immutable. Therefore, you must set ChangeableForDays to 3 or greater.

      Before the lock date, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using PutBackupVaultLockConfiguration. On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted.

      If this parameter is not specified, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using PutBackupVaultLockConfiguration at any time.

  • On success, responds with PutBackupVaultLockConfigurationOutput
  • On failure, responds with SdkError<PutBackupVaultLockConfigurationError>

Constructs a fluent builder for the PutBackupVaultNotifications operation.

Constructs a fluent builder for the StartBackupJob operation.

Constructs a fluent builder for the StartCopyJob operation.

Constructs a fluent builder for the StartReportJob operation.

Constructs a fluent builder for the StartRestoreJob operation.

  • The fluent builder is configurable:
    • recovery_point_arn(impl Into<String>) / set_recovery_point_arn(Option<String>):

      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • metadata(HashMap<String, String>) / set_metadata(Option<HashMap<String, String>>):

      A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

      You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

      You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

      • file-system-id: The ID of the Amazon EFS file system that is backed up by Backup. Returned in GetRecoveryPointRestoreMetadata.

      • Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.

      • KmsKeyId: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.

      • PerformanceMode: Specifies the throughput mode of the file system.

      • CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.

      • newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.

      • ItemsToRestore: An array of one to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, “itemsToRestore”:“["/my.test"]”.

    • iam_role_arn(impl Into<String>) / set_iam_role_arn(Option<String>):

      The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

    • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):

      A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

    • resource_type(impl Into<String>) / set_resource_type(Option<String>):

      Starts a job to restore a recovery point for one of the following resources:

      • Aurora for Amazon Aurora

      • DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

      • DynamoDB for Amazon DynamoDB

      • EBS for Amazon Elastic Block Store

      • EC2 for Amazon Elastic Compute Cloud

      • EFS for Amazon Elastic File System

      • FSx for Amazon FSx

      • Neptune for Amazon Neptune

      • RDS for Amazon Relational Database Service

      • Storage Gateway for Storage Gateway

      • S3 for Amazon S3

      • VirtualMachine for virtual machines

  • On success, responds with StartRestoreJobOutput with field(s):
  • On failure, responds with SdkError<StartRestoreJobError>

Constructs a fluent builder for the StopBackupJob operation.

Constructs a fluent builder for the TagResource operation.

Constructs a fluent builder for the UntagResource operation.

Constructs a fluent builder for the UpdateBackupPlan operation.

Constructs a fluent builder for the UpdateFramework operation.

Constructs a fluent builder for the UpdateGlobalSettings operation.

Constructs a fluent builder for the UpdateRecoveryPointLifecycle operation.

  • The fluent builder is configurable:
    • backup_vault_name(impl Into<String>) / set_backup_vault_name(Option<String>):

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • recovery_point_arn(impl Into<String>) / set_recovery_point_arn(Option<String>):

      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • lifecycle(Lifecycle) / set_lifecycle(Option<Lifecycle>):

      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “retention” 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.

  • On success, responds with UpdateRecoveryPointLifecycleOutput with field(s):
    • backup_vault_arn(Option<String>):

      An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    • recovery_point_arn(Option<String>):

      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • lifecycle(Option<Lifecycle>):

      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “retention” 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.

      Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the “Full Backup management” section of the Feature availability by resource table. Backup ignores this expression for other resource types.

    • calculated_lifecycle(Option<CalculatedLifecycle>):

      A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

  • On failure, responds with SdkError<UpdateRecoveryPointLifecycleError>

Constructs a fluent builder for the UpdateRegionSettings operation.

Constructs a fluent builder for the UpdateReportPlan operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Converts to this type from the input type.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more