Struct aws_sdk_backup::Client

pub struct Client { /* private fields */ }

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.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_backup::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_backup::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CancelLegalHold operation has a Client::cancel_legal_hold, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.cancel_legal_hold()
    .legal_hold_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn cancel_legal_hold(&self) -> CancelLegalHoldFluentBuilder

Constructs a fluent builder for the CancelLegalHold operation.

• The fluent builder is configurable:
  • legal_hold_id(impl Into<String>) / set_legal_hold_id(Option<String>):
    required: true
    

    Legal hold ID required to remove the specified legal hold on a recovery point.

    
    
  • cancel_description(impl Into<String>) / set_cancel_description(Option<String>):
    required: true
    

    String describing the reason for removing the legal hold.

    
    
  • retain_record_in_days(i64) / set_retain_record_in_days(Option<i64>):
    required: false
    

    The integer amount in days specifying amount of days after this API operation to remove legal hold.

    
    
• On success, responds with CancelLegalHoldOutput
• On failure, responds with SdkError<CancelLegalHoldError>

impl Client

pub fn create_backup_plan(&self) -> CreateBackupPlanFluentBuilder

Constructs a fluent builder for the CreateBackupPlan operation.

• The fluent builder is configurable:
  • backup_plan(BackupPlanInput) / set_backup_plan(Option<BackupPlanInput>):
    required: true
    

    Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

    
    
  • backup_plan_tags(impl Into<String>, impl Into<String>) / set_backup_plan_tags(Option<HashMap::<String, String>>):
    required: false
    

    To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

    
    
  • creator_request_id(impl Into<String>) / set_creator_request_id(Option<String>):
    required: false
    

    Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.

    If used, this parameter must contain 1 to 50 alphanumeric or ‘-_.’ characters.

    
    
• On success, responds with CreateBackupPlanOutput with field(s):
  • backup_plan_id(Option<String>):

    Uniquely identifies a backup plan.

  • backup_plan_arn(Option<String>):

    An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

  • creation_date(Option<DateTime>):

    The date and time that a backup plan 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.

  • version_id(Option<String>):

    Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

  • advanced_backup_settings(Option<Vec::<AdvancedBackupSetting>>):

    A list of BackupOptions settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

• On failure, responds with SdkError<CreateBackupPlanError>

impl Client

pub fn create_backup_selection(&self) -> CreateBackupSelectionFluentBuilder

Constructs a fluent builder for the CreateBackupSelection operation.

• The fluent builder is configurable:
  • backup_plan_id(impl Into<String>) / set_backup_plan_id(Option<String>):
    required: true
    

    Uniquely identifies the backup plan to be associated with the selection of resources.

    
    
  • backup_selection(BackupSelection) / set_backup_selection(Option<BackupSelection>):
    required: true
    

    Specifies the body of a request to assign a set of resources to a backup plan.

    
    
  • creator_request_id(impl Into<String>) / set_creator_request_id(Option<String>):
    required: false
    

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

    If used, this parameter must contain 1 to 50 alphanumeric or ‘-_.’ characters.

    
    
• On success, responds with CreateBackupSelectionOutput with field(s):
  • selection_id(Option<String>):

    Uniquely identifies the body of a request to assign a set of resources to a backup plan.

  • backup_plan_id(Option<String>):

    Uniquely identifies a backup plan.

  • creation_date(Option<DateTime>):

    The date and time a backup selection 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.

• On failure, responds with SdkError<CreateBackupSelectionError>

impl Client

pub fn create_backup_vault(&self) -> CreateBackupVaultFluentBuilder

Constructs a fluent builder for the CreateBackupVault operation.

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

    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 letters, numbers, and hyphens.

    
    
  • backup_vault_tags(impl Into<String>, impl Into<String>) / set_backup_vault_tags(Option<HashMap::<String, String>>):
    required: false
    

    Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.

    
    
  • encryption_key_arn(impl Into<String>) / set_encryption_key_arn(Option<String>):
    required: false
    

    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.

    
    
  • creator_request_id(impl Into<String>) / set_creator_request_id(Option<String>):
    required: false
    

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

    If used, this parameter must contain 1 to 50 alphanumeric or ‘-_.’ characters.

    
    
• On success, responds with CreateBackupVaultOutput 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.

  • creation_date(Option<DateTime>):

    The date and time 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.

• On failure, responds with SdkError<CreateBackupVaultError>

impl Client

pub fn create_framework(&self) -> CreateFrameworkFluentBuilder

Constructs a fluent builder for the CreateFramework operation.

• The fluent builder is configurable:
  • framework_name(impl Into<String>) / set_framework_name(Option<String>):
    required: true
    

    The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

    
    
  • framework_description(impl Into<String>) / set_framework_description(Option<String>):
    required: false
    

    An optional description of the framework with a maximum of 1,024 characters.

    
    
  • framework_controls(FrameworkControl) / set_framework_controls(Option<Vec::<FrameworkControl>>):
    required: true
    

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

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

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

    
    
  • framework_tags(impl Into<String>, impl Into<String>) / set_framework_tags(Option<HashMap::<String, String>>):
    required: false
    

    Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

    
    
• On success, responds with CreateFrameworkOutput with field(s):
  • framework_name(Option<String>):

    The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

  • framework_arn(Option<String>):

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

• On failure, responds with SdkError<CreateFrameworkError>

impl Client

pub fn create_legal_hold(&self) -> CreateLegalHoldFluentBuilder

Constructs a fluent builder for the CreateLegalHold operation.

• The fluent builder is configurable:
  • title(impl Into<String>) / set_title(Option<String>):
    required: true
    

    This is the string title of the legal hold.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    This is the string description of the legal hold.

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

    This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.

    
    
  • recovery_point_selection(RecoveryPointSelection) / set_recovery_point_selection(Option<RecoveryPointSelection>):
    required: false
    

    This specifies criteria to assign a set of resources, such as resource types or backup vaults.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

    
    
• On success, responds with CreateLegalHoldOutput with field(s):
  • title(Option<String>):

    This is the string title of the legal hold returned after creating the legal hold.

  • status(Option<LegalHoldStatus>):

    This displays the status of the legal hold returned after creating the legal hold. Statuses can be ACTIVE, PENDING, CANCELED, CANCELING, or FAILED.

  • description(Option<String>):

    This is the returned string description of the legal hold.

  • legal_hold_id(Option<String>):

    Legal hold ID returned for the specified legal hold on a recovery point.

  • legal_hold_arn(Option<String>):

    This is the ARN (Amazon Resource Number) of the created legal hold.

  • creation_date(Option<DateTime>):

    Time in number format when legal hold was created.

  • recovery_point_selection(Option<RecoveryPointSelection>):

    This specifies criteria to assign a set of resources, such as resource types or backup vaults.

• On failure, responds with SdkError<CreateLegalHoldError>

impl Client

pub fn create_logically_air_gapped_backup_vault( &self ) -> CreateLogicallyAirGappedBackupVaultFluentBuilder

Constructs a fluent builder for the CreateLogicallyAirGappedBackupVault operation.

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

    This is the name of the vault that is being created.

    
    
  • backup_vault_tags(impl Into<String>, impl Into<String>) / set_backup_vault_tags(Option<HashMap::<String, String>>):
    required: false
    

    These are the tags that will be included in the newly-created vault.

    
    
  • creator_request_id(impl Into<String>) / set_creator_request_id(Option<String>):
    required: false
    

    This is the ID of the creation request.

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

    This setting specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, no minimum retention period is enforced.

    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 a job 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.

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

    This is the setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Backup 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 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.

    
    
• On success, responds with CreateLogicallyAirGappedBackupVaultOutput with field(s):
  • backup_vault_name(Option<String>):

    The name of a logical container where backups are stored. Logically air-gapped 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>):

    This is the ARN (Amazon Resource Name) of the vault being created.

  • creation_date(Option<DateTime>):

    The date and time when the vault was created.

    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.

  • vault_state(Option<VaultState>):

    This is the current state of the vault.

• On failure, responds with SdkError<CreateLogicallyAirGappedBackupVaultError>

impl Client

pub fn create_report_plan(&self) -> CreateReportPlanFluentBuilder

Constructs a fluent builder for the CreateReportPlan operation.

• The fluent builder is configurable:
  • report_plan_name(impl Into<String>) / set_report_plan_name(Option<String>):
    required: true
    

    The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

    
    
  • report_plan_description(impl Into<String>) / set_report_plan_description(Option<String>):
    required: false
    

    An optional description of the report plan with a maximum of 1,024 characters.

    
    
  • report_delivery_channel(ReportDeliveryChannel) / set_report_delivery_channel(Option<ReportDeliveryChannel>):
    required: true
    

    A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

    
    
  • report_setting(ReportSetting) / set_report_setting(Option<ReportSetting>):
    required: true
    

    Identifies the report template for the report. Reports are built using a report template. The report templates are:

    RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

    If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

    
    
  • report_plan_tags(impl Into<String>, impl Into<String>) / set_report_plan_tags(Option<HashMap::<String, String>>):
    required: false
    

    Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

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

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

    
    
• On success, responds with CreateReportPlanOutput with field(s):
  • report_plan_name(Option<String>):

    The unique name of the report plan.

  • report_plan_arn(Option<String>):

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

  • creation_time(Option<DateTime>):

    The date and time a backup vault 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.

• On failure, responds with SdkError<CreateReportPlanError>

impl Client

pub fn delete_backup_plan(&self) -> DeleteBackupPlanFluentBuilder

Constructs a fluent builder for the DeleteBackupPlan operation.

• The fluent builder is configurable:
  • backup_plan_id(impl Into<String>) / set_backup_plan_id(Option<String>):
    required: true
    

    Uniquely identifies a backup plan.

    
    
• On success, responds with DeleteBackupPlanOutput with field(s):
  • backup_plan_id(Option<String>):

    Uniquely identifies a backup plan.

  • backup_plan_arn(Option<String>):

    An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

  • deletion_date(Option<DateTime>):

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

  • version_id(Option<String>):

    Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

• On failure, responds with SdkError<DeleteBackupPlanError>

impl Client

pub fn delete_backup_selection(&self) -> DeleteBackupSelectionFluentBuilder

Constructs a fluent builder for the DeleteBackupSelection operation.

• The fluent builder is configurable:
  • backup_plan_id(impl Into<String>) / set_backup_plan_id(Option<String>):
    required: true
    

    Uniquely identifies a backup plan.

    
    
  • selection_id(impl Into<String>) / set_selection_id(Option<String>):
    required: true
    

    Uniquely identifies the body of a request to assign a set of resources to a backup plan.

    
    
• On success, responds with DeleteBackupSelectionOutput
• On failure, responds with SdkError<DeleteBackupSelectionError>

impl Client

pub fn delete_backup_vault(&self) -> DeleteBackupVaultFluentBuilder

Constructs a fluent builder for the DeleteBackupVault operation.

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

    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.

    
    
• On success, responds with DeleteBackupVaultOutput
• On failure, responds with SdkError<DeleteBackupVaultError>

impl Client

pub fn delete_backup_vault_access_policy( &self ) -> DeleteBackupVaultAccessPolicyFluentBuilder

Constructs a fluent builder for the DeleteBackupVaultAccessPolicy operation.

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

    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.

    
    
• On success, responds with DeleteBackupVaultAccessPolicyOutput
• On failure, responds with SdkError<DeleteBackupVaultAccessPolicyError>

impl Client

pub fn delete_backup_vault_lock_configuration( &self ) -> DeleteBackupVaultLockConfigurationFluentBuilder

Constructs a fluent builder for the DeleteBackupVaultLockConfiguration operation.

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

    The name of the backup vault from which to delete Backup Vault Lock.

    
    
• On success, responds with DeleteBackupVaultLockConfigurationOutput
• On failure, responds with SdkError<DeleteBackupVaultLockConfigurationError>

impl Client

pub fn delete_backup_vault_notifications( &self ) -> DeleteBackupVaultNotificationsFluentBuilder

Constructs a fluent builder for the DeleteBackupVaultNotifications operation.

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

    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.

    
    
• On success, responds with DeleteBackupVaultNotificationsOutput
• On failure, responds with SdkError<DeleteBackupVaultNotificationsError>

impl Client

pub fn delete_framework(&self) -> DeleteFrameworkFluentBuilder

Constructs a fluent builder for the DeleteFramework operation.

• The fluent builder is configurable:
  • framework_name(impl Into<String>) / set_framework_name(Option<String>):
    required: true
    

    The unique name of a framework.

    
    
• On success, responds with DeleteFrameworkOutput
• On failure, responds with SdkError<DeleteFrameworkError>

impl Client

pub fn delete_recovery_point(&self) -> DeleteRecoveryPointFluentBuilder

Constructs a fluent builder for the DeleteRecoveryPoint operation.

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

    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>):
    required: true
    

    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.

    
    
• On success, responds with DeleteRecoveryPointOutput
• On failure, responds with SdkError<DeleteRecoveryPointError>

impl Client

pub fn delete_report_plan(&self) -> DeleteReportPlanFluentBuilder

Constructs a fluent builder for the DeleteReportPlan operation.

• The fluent builder is configurable:
  • report_plan_name(impl Into<String>) / set_report_plan_name(Option<String>):
    required: true
    

    The unique name of a report plan.

    
    
• On success, responds with DeleteReportPlanOutput
• On failure, responds with SdkError<DeleteReportPlanError>

impl Client

pub fn describe_backup_job(&self) -> DescribeBackupJobFluentBuilder

Constructs a fluent builder for the DescribeBackupJob operation.

• The fluent builder is configurable:
  • backup_job_id(impl Into<String>) / set_backup_job_id(Option<String>):
    required: true
    

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

    
    
• 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 backup job.

  • 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.

  • parent_job_id(Option<String>):

    This returns the parent (composite) resource backup job ID.

  • is_parent(bool):

    This returns the boolean value that a backup job is a parent (composite) job.

  • number_of_child_jobs(Option<i64>):

    This returns the number of child (nested) backup jobs.

  • child_jobs_in_state(Option<HashMap::<BackupJobState, i64>>):

    This returns the statistics of the included child (nested) backup jobs.

  • resource_name(Option<String>):

    This is the non-unique name of the resource that belongs to the specified backup.

  • message_category(Option<String>):

    This is the job count for the specified message category.

    Example strings may include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of MessageCategory strings.

• On failure, responds with SdkError<DescribeBackupJobError>

impl Client

pub fn describe_backup_vault(&self) -> DescribeBackupVaultFluentBuilder

Constructs a fluent builder for the DescribeBackupVault operation.

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

    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_account_id(impl Into<String>) / set_backup_vault_account_id(Option<String>):
    required: false
    

    This is the account ID of the specified backup vault.

    
    
• 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.

  • vault_type(Option<VaultType>):

    This is the type of vault described.

  • 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>

impl Client

pub fn describe_copy_job(&self) -> DescribeCopyJobFluentBuilder

Constructs a fluent builder for the DescribeCopyJob operation.

• The fluent builder is configurable:
  • copy_job_id(impl Into<String>) / set_copy_job_id(Option<String>):
    required: true
    

    Uniquely identifies a copy job.

    
    
• On success, responds with DescribeCopyJobOutput with field(s):
  • copy_job(Option<CopyJob>):

    Contains detailed information about a copy job.

• On failure, responds with SdkError<DescribeCopyJobError>

impl Client

pub fn describe_framework(&self) -> DescribeFrameworkFluentBuilder

Constructs a fluent builder for the DescribeFramework operation.

• The fluent builder is configurable:
  • framework_name(impl Into<String>) / set_framework_name(Option<String>):
    required: true
    

    The unique name of a framework.

    
    
• 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 ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

  • 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>

impl Client

pub fn describe_global_settings(&self) -> DescribeGlobalSettingsFluentBuilder

Constructs a fluent builder for the DescribeGlobalSettings operation.

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

    The status of the flag isCrossAccountBackupEnabled.

  • last_update_time(Option<DateTime>):

    The date and time that the flag isCrossAccountBackupEnabled was last updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of LastUpdateTime 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<DescribeGlobalSettingsError>

impl Client

pub fn describe_protected_resource( &self ) -> DescribeProtectedResourceFluentBuilder

Constructs a fluent builder for the DescribeProtectedResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeProtectedResourceOutput with field(s):
  • resource_arn(Option<String>):

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

  • resource_type(Option<String>):

    The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon EBS volume or an Amazon RDS database.

  • last_backup_time(Option<DateTime>):

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

  • resource_name(Option<String>):

    This is the non-unique name of the resource that belongs to the specified backup.

• On failure, responds with SdkError<DescribeProtectedResourceError>

impl Client

pub fn describe_recovery_point(&self) -> DescribeRecoveryPointFluentBuilder

Constructs a fluent builder for the DescribeRecoveryPoint operation.

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

    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>):
    required: true
    

    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.

    
    
  • backup_vault_account_id(impl Into<String>) / set_backup_vault_account_id(Option<String>):
    required: false
    

    This is the account ID of the specified backup vault.

    
    
• 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.

    STOPPED status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup.

    To resolve STOPPED status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.

    For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.

  • status_message(Option<String>):

    A status message explaining the status of the recovery point.

  • 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.

    Resource types that are able to be transitioned to cold storage are listed in the “Lifecycle to cold storage” 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.

  • parent_recovery_point_arn(Option<String>):

    This is an ARN that uniquely identifies a parent (composite) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

  • composite_member_identifier(Option<String>):

    This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

  • is_parent(bool):

    This returns the boolean value that a recovery point is a parent (composite) job.

  • resource_name(Option<String>):

    This is the non-unique name of the resource that belongs to the specified backup.

• On failure, responds with SdkError<DescribeRecoveryPointError>

impl Client

pub fn describe_region_settings(&self) -> DescribeRegionSettingsFluentBuilder

Constructs a fluent builder for the DescribeRegionSettings operation.

• The fluent builder takes no input, just send it.
• On success, responds with DescribeRegionSettingsOutput with field(s):
  • resource_type_opt_in_preference(Option<HashMap::<String, bool>>):

    Returns a list of all services along with the opt-in preferences in the Region.

  • resource_type_management_preference(Option<HashMap::<String, bool>>):

    Returns whether Backup fully manages the backups for a resource type.

    For the benefits of full Backup management, see Full Backup management.

    For a list of resource types and whether each supports full Backup management, see the Feature availability by resource table.

    If “DynamoDB”:false, you can enable full Backup management for DynamoDB backup by enabling Backup’s advanced DynamoDB backup features.

• On failure, responds with SdkError<DescribeRegionSettingsError>

impl Client

pub fn describe_report_job(&self) -> DescribeReportJobFluentBuilder

Constructs a fluent builder for the DescribeReportJob operation.

• The fluent builder is configurable:
  • report_job_id(impl Into<String>) / set_report_job_id(Option<String>):
    required: true
    

    The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.

    
    
• On success, responds with DescribeReportJobOutput with field(s):
  • report_job(Option<ReportJob>):

    A list of information about a report job, including its completion and creation times, report destination, unique report job ID, Amazon Resource Name (ARN), report template, status, and status message.

• On failure, responds with SdkError<DescribeReportJobError>

impl Client

pub fn describe_report_plan(&self) -> DescribeReportPlanFluentBuilder

Constructs a fluent builder for the DescribeReportPlan operation.

• The fluent builder is configurable:
  • report_plan_name(impl Into<String>) / set_report_plan_name(Option<String>):
    required: true
    

    The unique name of a report plan.

    
    
• On success, responds with DescribeReportPlanOutput with field(s):
  • report_plan(Option<ReportPlan>):

    Returns details about the report plan that is specified by its name. These details include the report plan’s Amazon Resource Name (ARN), description, settings, delivery channel, deployment status, creation time, and last attempted and successful run times.

• On failure, responds with SdkError<DescribeReportPlanError>

impl Client

pub fn describe_restore_job(&self) -> DescribeRestoreJobFluentBuilder

Constructs a fluent builder for the DescribeRestoreJob operation.

• The fluent builder is configurable:
  • restore_job_id(impl Into<String>) / set_restore_job_id(Option<String>):
    required: true
    

    Uniquely identifies the job that restores a recovery point.

    
    
• On success, responds with DescribeRestoreJobOutput with field(s):
  • account_id(Option<String>):

    Returns the account ID that owns the restore job.

  • restore_job_id(Option<String>):

    Uniquely identifies the job that restores a recovery point.

  • 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.

  • creation_date(Option<DateTime>):

    The date and time that a restore 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 restore 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.

  • status(Option<RestoreJobStatus>):

    Status code specifying the state of the job that is initiated by Backup to restore a recovery point.

  • status_message(Option<String>):

    A message showing the status of a job to restore a recovery point.

  • 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 the restored resource.

  • 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.

  • expected_completion_time_minutes(Option<i64>):

    The amount of time in minutes that a job restoring a recovery point is expected to take.

  • created_resource_arn(Option<String>):

    An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.

  • resource_type(Option<String>):

    Returns metadata associated with a restore job listed by resource type.

• On failure, responds with SdkError<DescribeRestoreJobError>

impl Client

pub fn disassociate_recovery_point( &self ) -> DisassociateRecoveryPointFluentBuilder

Constructs a fluent builder for the DisassociateRecoveryPoint operation.

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

    The unique name of an Backup vault.

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

    An Amazon Resource Name (ARN) that uniquely identifies an Backup recovery point.

    
    
• On success, responds with DisassociateRecoveryPointOutput
• On failure, responds with SdkError<DisassociateRecoveryPointError>

impl Client

pub fn disassociate_recovery_point_from_parent( &self ) -> DisassociateRecoveryPointFromParentFluentBuilder

Constructs a fluent builder for the DisassociateRecoveryPointFromParent operation.

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

    This is the name of a logical container where the child (nested) recovery point is 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>):
    required: true
    

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

    
    
• On success, responds with DisassociateRecoveryPointFromParentOutput
• On failure, responds with SdkError<DisassociateRecoveryPointFromParentError>

impl Client

pub fn export_backup_plan_template( &self ) -> ExportBackupPlanTemplateFluentBuilder

Constructs a fluent builder for the ExportBackupPlanTemplate operation.

• The fluent builder is configurable:
  • backup_plan_id(impl Into<String>) / set_backup_plan_id(Option<String>):
    required: true
    

    Uniquely identifies a backup plan.

    
    
• On success, responds with ExportBackupPlanTemplateOutput with field(s):
  • backup_plan_template_json(Option<String>):

    The body of a backup plan template in JSON format.

    This is a signed JSON document that cannot be modified before being passed to GetBackupPlanFromJSON.

• On failure, responds with SdkError<ExportBackupPlanTemplateError>

impl Client

pub fn get_backup_plan(&self) -> GetBackupPlanFluentBuilder

Constructs a fluent builder for the GetBackupPlan operation.

• The fluent builder is configurable:
  • backup_plan_id(impl Into<String>) / set_backup_plan_id(Option<String>):
    required: true
    

    Uniquely identifies a backup plan.

    
    
  • version_id(impl Into<String>) / set_version_id(Option<String>):
    required: false
    

    Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

    
    
• On success, responds with GetBackupPlanOutput with field(s):
  • backup_plan(Option<BackupPlan>):

    Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

  • backup_plan_id(Option<String>):

    Uniquely identifies a backup plan.

  • backup_plan_arn(Option<String>):

    An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

  • version_id(Option<String>):

    Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

  • 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.

  • creation_date(Option<DateTime>):

    The date and time that a backup plan 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.

  • deletion_date(Option<DateTime>):

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

  • last_execution_date(Option<DateTime>):

    The last time a job to back up resources was run with this backup plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

  • advanced_backup_settings(Option<Vec::<AdvancedBackupSetting>>):

    Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.

• On failure, responds with SdkError<GetBackupPlanError>

impl Client

pub fn get_backup_plan_from_json(&self) -> GetBackupPlanFromJSONFluentBuilder

Constructs a fluent builder for the GetBackupPlanFromJSON operation.

• The fluent builder is configurable:
  • backup_plan_template_json(impl Into<String>) / set_backup_plan_template_json(Option<String>):
    required: true
    

    A customer-supplied backup plan document in JSON format.

    
    
• On success, responds with GetBackupPlanFromJsonOutput with field(s):
  • backup_plan(Option<BackupPlan>):

    Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

• On failure, responds with SdkError<GetBackupPlanFromJSONError>

impl Client

pub fn get_backup_plan_from_template( &self ) -> GetBackupPlanFromTemplateFluentBuilder

Constructs a fluent builder for the GetBackupPlanFromTemplate operation.

• The fluent builder is configurable:
  • backup_plan_template_id(impl Into<String>) / set_backup_plan_template_id(Option<String>):
    required: true
    

    Uniquely identifies a stored backup plan template.

    
    
• On success, responds with GetBackupPlanFromTemplateOutput with field(s):
  • backup_plan_document(Option<BackupPlan>):

    Returns the body of a backup plan based on the target template, including the name, rules, and backup vault of the plan.

• On failure, responds with SdkError<GetBackupPlanFromTemplateError>

impl Client

pub fn get_backup_selection(&self) -> GetBackupSelectionFluentBuilder

Constructs a fluent builder for the GetBackupSelection operation.

• The fluent builder is configurable:
  • backup_plan_id(impl Into<String>) / set_backup_plan_id(Option<String>):
    required: true
    

    Uniquely identifies a backup plan.

    
    
  • selection_id(impl Into<String>) / set_selection_id(Option<String>):
    required: true
    

    Uniquely identifies the body of a request to assign a set of resources to a backup plan.

    
    
• On success, responds with GetBackupSelectionOutput with field(s):
  • backup_selection(Option<BackupSelection>):

    Specifies the body of a request to assign a set of resources to a backup plan.

  • selection_id(Option<String>):

    Uniquely identifies the body of a request to assign a set of resources to a backup plan.

  • backup_plan_id(Option<String>):

    Uniquely identifies a backup plan.

  • creation_date(Option<DateTime>):

    The date and time a backup selection 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.

• On failure, responds with SdkError<GetBackupSelectionError>

impl Client

pub fn get_backup_vault_access_policy( &self ) -> GetBackupVaultAccessPolicyFluentBuilder

Constructs a fluent builder for the GetBackupVaultAccessPolicy operation.

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

    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.

    
    
• On success, responds with GetBackupVaultAccessPolicyOutput 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.

  • policy(Option<String>):

    The backup vault access policy document in JSON format.

• On failure, responds with SdkError<GetBackupVaultAccessPolicyError>

impl Client

pub fn get_backup_vault_notifications( &self ) -> GetBackupVaultNotificationsFluentBuilder

Constructs a fluent builder for the GetBackupVaultNotifications operation.

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

    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.

    
    
• On success, responds with GetBackupVaultNotificationsOutput 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.

  • sns_topic_arn(Option<String>):

    An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.

  • backup_vault_events(Option<Vec::<BackupVaultEvent>>):

    An array of events that indicate the status of jobs to back up resources to the backup vault.

• On failure, responds with SdkError<GetBackupVaultNotificationsError>

impl Client

pub fn get_legal_hold(&self) -> GetLegalHoldFluentBuilder

Constructs a fluent builder for the GetLegalHold operation.

• The fluent builder is configurable:
  • legal_hold_id(impl Into<String>) / set_legal_hold_id(Option<String>):
    required: true
    

    This is the ID required to use GetLegalHold. This unique ID is associated with a specific legal hold.

    
    
• On success, responds with GetLegalHoldOutput with field(s):
  • title(Option<String>):

    This is the string title of the legal hold.

  • status(Option<LegalHoldStatus>):

    This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

  • description(Option<String>):

    This is the returned string description of the legal hold.

  • cancel_description(Option<String>):

    String describing the reason for removing the legal hold.

  • legal_hold_id(Option<String>):

    This is the returned ID associated with a specified legal hold.

  • legal_hold_arn(Option<String>):

    This is the returned framework ARN for the specified legal hold. An Amazon Resource Name (ARN) uniquely identifies a resource. The format of the ARN depends on the resource type.

  • creation_date(Option<DateTime>):

    Time in number format when legal hold was created.

  • cancellation_date(Option<DateTime>):

    Time in number when legal hold was cancelled.

  • retain_record_until(Option<DateTime>):

    This is the date and time until which the legal hold record will be retained.

  • recovery_point_selection(Option<RecoveryPointSelection>):

    This specifies criteria to assign a set of resources, such as resource types or backup vaults.

• On failure, responds with SdkError<GetLegalHoldError>

impl Client

pub fn get_recovery_point_restore_metadata( &self ) -> GetRecoveryPointRestoreMetadataFluentBuilder

Constructs a fluent builder for the GetRecoveryPointRestoreMetadata operation.

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

    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>):
    required: true
    

    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.

    
    
  • backup_vault_account_id(impl Into<String>) / set_backup_vault_account_id(Option<String>):
    required: false
    

    This is the account ID of the specified backup vault.

    
    
• On success, responds with GetRecoveryPointRestoreMetadataOutput 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 ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

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

    The set of metadata key-value pairs that describe the original configuration of the backed-up resource. These values vary depending on the service that is being restored.

• On failure, responds with SdkError<GetRecoveryPointRestoreMetadataError>

impl Client

pub fn get_supported_resource_types( &self ) -> GetSupportedResourceTypesFluentBuilder

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>

impl Client

pub fn list_backup_job_summaries(&self) -> ListBackupJobSummariesFluentBuilder

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

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: false
    

    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.

    
    
  • state(BackupJobStatus) / set_state(Option<BackupJobStatus>):
    required: false
    

    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.

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

    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.

    
    
  • message_category(impl Into<String>) / set_message_category(Option<String>):
    required: false
    

    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.

    
    
  • aggregation_period(AggregationPeriod) / set_aggregation_period(Option<AggregationPeriod>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListBackupJobSummariesOutput with field(s):
  • backup_job_summaries(Option<Vec::<BackupJobSummary>>):

    This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

  • aggregation_period(Option<String>):

    This is the period that sets the boundaries for returned results.

    • 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.

  • next_token(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.

• On failure, responds with SdkError<ListBackupJobSummariesError>

impl Client

pub fn list_backup_jobs(&self) -> ListBackupJobsFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to be returned.

    
    
  • by_resource_arn(impl Into<String>) / set_by_resource_arn(Option<String>):
    required: false
    

    Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).

    
    
  • by_state(BackupJobState) / set_by_state(Option<BackupJobState>):
    required: false
    

    Returns only backup jobs that are in the specified state.

    
    
  • by_backup_vault_name(impl Into<String>) / set_by_backup_vault_name(Option<String>):
    required: false
    

    Returns only backup jobs that will be stored in the specified backup vault. 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.

    
    
  • by_created_before(DateTime) / set_by_created_before(Option<DateTime>):
    required: false
    

    Returns only backup jobs that were created before the specified date.

    
    
  • by_created_after(DateTime) / set_by_created_after(Option<DateTime>):
    required: false
    

    Returns only backup jobs that were created after the specified date.

    
    
  • by_resource_type(impl Into<String>) / set_by_resource_type(Option<String>):
    required: false
    

    Returns only backup jobs for the specified 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

    
    
  • by_account_id(impl Into<String>) / set_by_account_id(Option<String>):
    required: false
    

    The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.

    If used from an Organizations management account, passing * returns all jobs across the organization.

    
    
  • by_complete_after(DateTime) / set_by_complete_after(Option<DateTime>):
    required: false
    

    Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

    
    
  • by_complete_before(DateTime) / set_by_complete_before(Option<DateTime>):
    required: false
    

    Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

    
    
  • by_parent_job_id(impl Into<String>) / set_by_parent_job_id(Option<String>):
    required: false
    

    This is a filter to list child (nested) jobs based on parent job ID.

    
    
  • by_message_category(impl Into<String>) / set_by_message_category(Option<String>):
    required: false
    

    This returns a list of backup jobs for the specified message category.

    Example strings may include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of MessageCategory strings.

    
    
• On success, responds with ListBackupJobsOutput with field(s):
  • backup_jobs(Option<Vec::<BackupJob>>):

    An array of structures containing metadata about your backup jobs returned in JSON format.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListBackupJobsError>

impl Client

pub fn list_backup_plan_templates(&self) -> ListBackupPlanTemplatesFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to be returned.

    
    
• On success, responds with ListBackupPlanTemplatesOutput with field(s):
  • next_token(Option<String>):

    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.

  • backup_plan_templates_list(Option<Vec::<BackupPlanTemplatesListMember>>):

    An array of template list items containing metadata about your saved templates.

• On failure, responds with SdkError<ListBackupPlanTemplatesError>

impl Client

pub fn list_backup_plan_versions(&self) -> ListBackupPlanVersionsFluentBuilder

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

• The fluent builder is configurable:
  • backup_plan_id(impl Into<String>) / set_backup_plan_id(Option<String>):
    required: true
    

    Uniquely identifies a backup plan.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to be returned.

    
    
• On success, responds with ListBackupPlanVersionsOutput with field(s):
  • next_token(Option<String>):

    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.

  • backup_plan_versions_list(Option<Vec::<BackupPlansListMember>>):

    An array of version list items containing metadata about your backup plans.

• On failure, responds with SdkError<ListBackupPlanVersionsError>

impl Client

pub fn list_backup_plans(&self) -> ListBackupPlansFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to be returned.

    
    
  • include_deleted(bool) / set_include_deleted(Option<bool>):
    required: false
    

    A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.

    
    
• On success, responds with ListBackupPlansOutput with field(s):
  • next_token(Option<String>):

    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.

  • backup_plans_list(Option<Vec::<BackupPlansListMember>>):

    An array of backup plan list items containing metadata about your saved backup plans.

• On failure, responds with SdkError<ListBackupPlansError>

impl Client

pub fn list_backup_selections(&self) -> ListBackupSelectionsFluentBuilder

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

• The fluent builder is configurable:
  • backup_plan_id(impl Into<String>) / set_backup_plan_id(Option<String>):
    required: true
    

    Uniquely identifies a backup plan.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to be returned.

    
    
• On success, responds with ListBackupSelectionsOutput with field(s):
  • next_token(Option<String>):

    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.

  • backup_selections_list(Option<Vec::<BackupSelectionsListMember>>):

    An array of backup selection list items containing metadata about each resource in the list.

• On failure, responds with SdkError<ListBackupSelectionsError>

impl Client

pub fn list_backup_vaults(&self) -> ListBackupVaultsFluentBuilder

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

• The fluent builder is configurable:
  • by_vault_type(VaultType) / set_by_vault_type(Option<VaultType>):
    required: false
    

    This parameter will sort the list of vaults by vault type.

    
    
  • by_shared(bool) / set_by_shared(Option<bool>):
    required: false
    

    This parameter will sort the list of vaults by shared vaults.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to be returned.

    
    
• On success, responds with ListBackupVaultsOutput with field(s):
  • backup_vault_list(Option<Vec::<BackupVaultListMember>>):

    An array of backup vault list members containing vault metadata, including Amazon Resource Name (ARN), display name, creation date, number of saved recovery points, and encryption information if the resources saved in the backup vault are encrypted.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListBackupVaultsError>

impl Client

pub fn list_copy_job_summaries(&self) -> ListCopyJobSummariesFluentBuilder

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

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: false
    

    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.

    
    
  • state(CopyJobStatus) / set_state(Option<CopyJobStatus>):
    required: false
    

    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.

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

    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.

    
    
  • message_category(impl Into<String>) / set_message_category(Option<String>):
    required: false
    

    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.

    
    
  • aggregation_period(AggregationPeriod) / set_aggregation_period(Option<AggregationPeriod>):
    required: false
    

    This is the period that sets the boundaries for returned results.

    • 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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListCopyJobSummariesOutput with field(s):
  • copy_job_summaries(Option<Vec::<CopyJobSummary>>):

    This return shows a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

  • aggregation_period(Option<String>):

    This is the period that sets the boundaries for returned results.

    • 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.

  • next_token(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.

• On failure, responds with SdkError<ListCopyJobSummariesError>

impl Client

pub fn list_copy_jobs(&self) -> ListCopyJobsFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to be returned.

    
    
  • by_resource_arn(impl Into<String>) / set_by_resource_arn(Option<String>):
    required: false
    

    Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).

    
    
  • by_state(CopyJobState) / set_by_state(Option<CopyJobState>):
    required: false
    

    Returns only copy jobs that are in the specified state.

    
    
  • by_created_before(DateTime) / set_by_created_before(Option<DateTime>):
    required: false
    

    Returns only copy jobs that were created before the specified date.

    
    
  • by_created_after(DateTime) / set_by_created_after(Option<DateTime>):
    required: false
    

    Returns only copy jobs that were created after the specified date.

    
    
  • by_resource_type(impl Into<String>) / set_by_resource_type(Option<String>):
    required: false
    

    Returns only backup jobs for the specified 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

    
    
  • by_destination_vault_arn(impl Into<String>) / set_by_destination_vault_arn(Option<String>):
    required: false
    

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

    
    
  • by_account_id(impl Into<String>) / set_by_account_id(Option<String>):
    required: false
    

    The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.

    
    
  • by_complete_before(DateTime) / set_by_complete_before(Option<DateTime>):
    required: false
    

    Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

    
    
  • by_complete_after(DateTime) / set_by_complete_after(Option<DateTime>):
    required: false
    

    Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

    
    
  • by_parent_job_id(impl Into<String>) / set_by_parent_job_id(Option<String>):
    required: false
    

    This is a filter to list child (nested) jobs based on parent job ID.

    
    
  • by_message_category(impl Into<String>) / set_by_message_category(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListCopyJobsOutput with field(s):
  • copy_jobs(Option<Vec::<CopyJob>>):

    An array of structures containing metadata about your copy jobs returned in JSON format.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListCopyJobsError>

impl Client

pub fn list_frameworks(&self) -> ListFrameworksFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

    
    
• On success, responds with ListFrameworksOutput with field(s):
  • frameworks(Option<Vec::<Framework>>):

    A list of frameworks with details for each framework, including the framework name, Amazon Resource Name (ARN), description, number of controls, creation time, and deployment status.

  • next_token(Option<String>):

    An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

• On failure, responds with SdkError<ListFrameworksError>

impl Client

pub fn list_legal_holds(&self) -> ListLegalHoldsFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of resource list items to be returned.

    
    
• On success, responds with ListLegalHoldsOutput with field(s):
  • next_token(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.

  • legal_holds(Option<Vec::<LegalHold>>):

    This is an array of returned legal holds, both active and previous.

• On failure, responds with SdkError<ListLegalHoldsError>

impl Client

pub fn list_protected_resources(&self) -> ListProtectedResourcesFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to be returned.

    
    
• On success, responds with ListProtectedResourcesOutput with field(s):
  • results(Option<Vec::<ProtectedResource>>):

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

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListProtectedResourcesError>

impl Client

pub fn list_protected_resources_by_backup_vault( &self ) -> ListProtectedResourcesByBackupVaultFluentBuilder

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

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

    This is the list of protected resources by backup vault within the vault(s) you specify by name.

    
    
  • backup_vault_account_id(impl Into<String>) / set_backup_vault_account_id(Option<String>):
    required: false
    

    This is the list of protected resources by backup vault within the vault(s) you specify by account ID.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to be returned.

    
    
• On success, responds with ListProtectedResourcesByBackupVaultOutput with field(s):
  • results(Option<Vec::<ProtectedResource>>):

    These are the results returned for the request ListProtectedResourcesByBackupVault.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListProtectedResourcesByBackupVaultError>

impl Client

pub fn list_recovery_points_by_backup_vault( &self ) -> ListRecoveryPointsByBackupVaultFluentBuilder

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

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

    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 name might not be available when a supported service creates the backup.

    
    
  • backup_vault_account_id(impl Into<String>) / set_backup_vault_account_id(Option<String>):
    required: false
    

    This parameter will sort the list of recovery points by account ID.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to be returned.

    
    
  • by_resource_arn(impl Into<String>) / set_by_resource_arn(Option<String>):
    required: false
    

    Returns only recovery points that match the specified resource Amazon Resource Name (ARN).

    
    
  • by_resource_type(impl Into<String>) / set_by_resource_type(Option<String>):
    required: false
    

    Returns only recovery points that match the specified resource type.

    
    
  • by_backup_plan_id(impl Into<String>) / set_by_backup_plan_id(Option<String>):
    required: false
    

    Returns only recovery points that match the specified backup plan ID.

    
    
  • by_created_before(DateTime) / set_by_created_before(Option<DateTime>):
    required: false
    

    Returns only recovery points that were created before the specified timestamp.

    
    
  • by_created_after(DateTime) / set_by_created_after(Option<DateTime>):
    required: false
    

    Returns only recovery points that were created after the specified timestamp.

    
    
  • by_parent_recovery_point_arn(impl Into<String>) / set_by_parent_recovery_point_arn(Option<String>):
    required: false
    

    This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).

    
    
• On success, responds with ListRecoveryPointsByBackupVaultOutput with field(s):
  • next_token(Option<String>):

    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.

  • recovery_points(Option<Vec::<RecoveryPointByBackupVault>>):

    An array of objects that contain detailed information about recovery points saved in a backup vault.

• On failure, responds with SdkError<ListRecoveryPointsByBackupVaultError>

impl Client

pub fn list_recovery_points_by_legal_hold( &self ) -> ListRecoveryPointsByLegalHoldFluentBuilder

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

• The fluent builder is configurable:
  • legal_hold_id(impl Into<String>) / set_legal_hold_id(Option<String>):
    required: true
    

    This is the ID of the legal hold.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    This is 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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    This is the maximum number of resource list items to be returned.

    
    
• On success, responds with ListRecoveryPointsByLegalHoldOutput with field(s):
  • recovery_points(Option<Vec::<RecoveryPointMember>>):

    This is a list of the recovery points returned by ListRecoveryPointsByLegalHold.

  • next_token(Option<String>):

    This return is the next item following a partial list of returned resources.

• On failure, responds with SdkError<ListRecoveryPointsByLegalHoldError>

impl Client

pub fn list_recovery_points_by_resource( &self ) -> ListRecoveryPointsByResourceFluentBuilder

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

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to be returned.

    Amazon RDS requires a value of at least 20.

    
    
• On success, responds with ListRecoveryPointsByResourceOutput with field(s):
  • next_token(Option<String>):

    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.

  • recovery_points(Option<Vec::<RecoveryPointByResource>>):

    An array of objects that contain detailed information about recovery points of the specified resource type.

    Only Amazon EFS and Amazon EC2 recovery points return BackupVaultName.

• On failure, responds with SdkError<ListRecoveryPointsByResourceError>

impl Client

pub fn list_report_jobs(&self) -> ListReportJobsFluentBuilder

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

• The fluent builder is configurable:
  • by_report_plan_name(impl Into<String>) / set_by_report_plan_name(Option<String>):
    required: false
    

    Returns only report jobs with the specified report plan name.

    
    
  • by_creation_before(DateTime) / set_by_creation_before(Option<DateTime>):
    required: false
    

    Returns only report jobs that were created before the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

    
    
  • by_creation_after(DateTime) / set_by_creation_after(Option<DateTime>):
    required: false
    

    Returns only report jobs that were created after the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

    
    
  • by_status(impl Into<String>) / set_by_status(Option<String>):
    required: false
    

    Returns only report jobs that are in the specified status. The statuses are:

    CREATED | RUNNING | COMPLETED | FAILED

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

    
    
• On success, responds with ListReportJobsOutput with field(s):
  • report_jobs(Option<Vec::<ReportJob>>):

    Details about your report jobs in JSON format.

  • next_token(Option<String>):

    An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

• On failure, responds with SdkError<ListReportJobsError>

impl Client

pub fn list_report_plans(&self) -> ListReportPlansFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

    
    
• On success, responds with ListReportPlansOutput with field(s):
  • report_plans(Option<Vec::<ReportPlan>>):

    A list of your report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.

  • next_token(Option<String>):

    An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

• On failure, responds with SdkError<ListReportPlansError>

impl Client

pub fn list_restore_job_summaries(&self) -> ListRestoreJobSummariesFluentBuilder

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

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: false
    

    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.

    
    
  • state(RestoreJobState) / set_state(Option<RestoreJobState>):
    required: false
    

    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.

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

    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.

    
    
  • aggregation_period(AggregationPeriod) / set_aggregation_period(Option<AggregationPeriod>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListRestoreJobSummariesOutput with field(s):
  • restore_job_summaries(Option<Vec::<RestoreJobSummary>>):

    This return contains a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

  • aggregation_period(Option<String>):

    This is the period that sets the boundaries for returned results.

    • 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.

  • next_token(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.

• On failure, responds with SdkError<ListRestoreJobSummariesError>

impl Client

pub fn list_restore_jobs(&self) -> ListRestoreJobsFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to be returned.

    
    
  • by_account_id(impl Into<String>) / set_by_account_id(Option<String>):
    required: false
    

    The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.

    
    
  • by_created_before(DateTime) / set_by_created_before(Option<DateTime>):
    required: false
    

    Returns only restore jobs that were created before the specified date.

    
    
  • by_created_after(DateTime) / set_by_created_after(Option<DateTime>):
    required: false
    

    Returns only restore jobs that were created after the specified date.

    
    
  • by_status(RestoreJobStatus) / set_by_status(Option<RestoreJobStatus>):
    required: false
    

    Returns only restore jobs associated with the specified job status.

    
    
  • by_complete_before(DateTime) / set_by_complete_before(Option<DateTime>):
    required: false
    

    Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

    
    
  • by_complete_after(DateTime) / set_by_complete_after(Option<DateTime>):
    required: false
    

    Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

    
    
• On success, responds with ListRestoreJobsOutput with field(s):
  • restore_jobs(Option<Vec::<RestoreJobsListMember>>):

    An array of objects that contain detailed information about jobs to restore saved resources.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListRestoreJobsError>

impl Client

pub fn list_tags(&self) -> ListTagsFluentBuilder

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

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of resource. Valid targets for ListTags are recovery points, backup plans, and backup vaults.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to be returned.

    
    
• On success, responds with ListTagsOutput with field(s):
  • next_token(Option<String>):

    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.

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

    To help organize your resources, you can assign your own metadata to the resources you create. Each tag is a key-value pair.

• On failure, responds with SdkError<ListTagsError>

impl Client

pub fn put_backup_vault_access_policy( &self ) -> PutBackupVaultAccessPolicyFluentBuilder

Constructs a fluent builder for the PutBackupVaultAccessPolicy operation.

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

    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.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: false
    

    The backup vault access policy document in JSON format.

    
    
• On success, responds with PutBackupVaultAccessPolicyOutput
• On failure, responds with SdkError<PutBackupVaultAccessPolicyError>

impl Client

pub fn put_backup_vault_lock_configuration( &self ) -> PutBackupVaultLockConfigurationFluentBuilder

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>):
    required: true
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn put_backup_vault_notifications( &self ) -> PutBackupVaultNotificationsFluentBuilder

Constructs a fluent builder for the PutBackupVaultNotifications operation.

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

    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.

    
    
  • sns_topic_arn(impl Into<String>) / set_sns_topic_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

    
    
  • backup_vault_events(BackupVaultEvent) / set_backup_vault_events(Option<Vec::<BackupVaultEvent>>):
    required: true
    

    An array of events that indicate the status of jobs to back up resources to the backup vault.

    For common use cases and code samples, see Using Amazon SNS to track Backup events.

    The following events are supported:

    • BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED

    • COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED

    • RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED

    • S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED

    The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.

    
    
• On success, responds with PutBackupVaultNotificationsOutput
• On failure, responds with SdkError<PutBackupVaultNotificationsError>

impl Client

pub fn start_backup_job(&self) -> StartBackupJobFluentBuilder

Constructs a fluent builder for the StartBackupJob operation.

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

    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.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

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

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

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

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

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

    
    
  • start_window_minutes(i64) / set_start_window_minutes(Option<i64>):
    required: false
    

    A value in minutes after a backup is scheduled before a job will be canceled if it doesn’t start successfully. This value is optional, and the default is 8 hours. If this value is included, it must be at least 60 minutes to avoid errors.

    This parameter has a maximum value of 100 years (52,560,000 minutes).

    During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

    
    
  • complete_window_minutes(i64) / set_complete_window_minutes(Option<i64>):
    required: false
    

    A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.

    Like StartWindowMinutes, this parameter has a maximum value of 100 years (52,560,000 minutes).

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

    The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire 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.

    Resource types that are able to be transitioned to cold storage are listed in the “Lifecycle to cold storage” section of the Feature availability by resource table. Backup ignores this expression for other resource types.

    This parameter has a maximum value of 100 years (36,500 days).

    
    
  • recovery_point_tags(impl Into<String>, impl Into<String>) / set_recovery_point_tags(Option<HashMap::<String, String>>):
    required: false
    

    To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

    
    
  • backup_options(impl Into<String>, impl Into<String>) / set_backup_options(Option<HashMap::<String, String>>):
    required: false
    

    Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

    Valid values: Set to “WindowsVSS”:“enabled” to enable the WindowsVSS backup option and create a Windows VSS backup. Set to “WindowsVSS”“disabled” to create a regular backup. The WindowsVSS option is not enabled by default.

    
    
• On success, responds with StartBackupJobOutput with field(s):
  • backup_job_id(Option<String>):

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

  • recovery_point_arn(Option<String>):

    Note: This field is only returned for Amazon EFS and Advanced DynamoDB resources.

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

  • 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.

  • is_parent(bool):

    This is a returned boolean value indicating this is a parent (composite) backup job.

• On failure, responds with SdkError<StartBackupJobError>

impl Client

pub fn start_copy_job(&self) -> StartCopyJobFluentBuilder

Constructs a fluent builder for the StartCopyJob operation.

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

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

    
    
  • source_backup_vault_name(impl Into<String>) / set_source_backup_vault_name(Option<String>):
    required: true
    

    The name of a logical source 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.

    
    
  • destination_backup_vault_arn(impl Into<String>) / set_destination_backup_vault_arn(Option<String>):
    required: true
    

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

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

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

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

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

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

    Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, 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.

    Resource types that are able to be transitioned to cold storage are listed in the “Lifecycle to cold storage” section of the Feature availability by resource table. Backup ignores this expression for other resource types.

    
    
• On success, responds with StartCopyJobOutput with field(s):
  • copy_job_id(Option<String>):

    Uniquely identifies a copy job.

  • creation_date(Option<DateTime>):

    The date and time that a copy 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.

  • is_parent(bool):

    This is a returned boolean value indicating this is a parent (composite) copy job.

• On failure, responds with SdkError<StartCopyJobError>

impl Client

pub fn start_report_job(&self) -> StartReportJobFluentBuilder

Constructs a fluent builder for the StartReportJob operation.

• The fluent builder is configurable:
  • report_plan_name(impl Into<String>) / set_report_plan_name(Option<String>):
    required: true
    

    The unique name of a report plan.

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

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

    
    
• On success, responds with StartReportJobOutput with field(s):
  • report_job_id(Option<String>):

    The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.

• On failure, responds with SdkError<StartReportJobError>

impl Client

pub fn start_restore_job(&self) -> StartRestoreJobFluentBuilder

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>):
    required: true
    

    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(impl Into<String>, impl Into<String>) / set_metadata(Option<HashMap::<String, String>>):
    required: true
    

    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>):
    required: false
    

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

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

    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>):
    required: false
    

    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)

    • CloudFormation for CloudFormation

    • 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

    • Redshift for Amazon Redshift

    • Storage Gateway for Storage Gateway

    • S3 for Amazon S3

    • Timestream for Amazon Timestream

    • VirtualMachine for virtual machines

    
    
  • copy_source_tags_to_restored_resource(bool) / set_copy_source_tags_to_restored_resource(Option<bool>):
    required: false
    

    This is an optional parameter. If this equals True, tags included in the backup will be copied to the restored resource.

    This can only be applied to backups created through Backup.

    
    
• On success, responds with StartRestoreJobOutput with field(s):
  • restore_job_id(Option<String>):

    Uniquely identifies the job that restores a recovery point.

• On failure, responds with SdkError<StartRestoreJobError>

impl Client

pub fn stop_backup_job(&self) -> StopBackupJobFluentBuilder

Constructs a fluent builder for the StopBackupJob operation.

• The fluent builder is configurable:
  • backup_job_id(impl Into<String>) / set_backup_job_id(Option<String>):
    required: true
    

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

    
    
• On success, responds with StopBackupJobOutput
• On failure, responds with SdkError<StopBackupJobError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

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

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create. For clarity, this is the structure to assign tags: [{“Key”:“string”,“Value”:“string”}].

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

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

    
    
  • tag_key_list(impl Into<String>) / set_tag_key_list(Option<Vec::<String>>):
    required: true
    

    A list of keys to identify which key-value tags to remove from a resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_backup_plan(&self) -> UpdateBackupPlanFluentBuilder

Constructs a fluent builder for the UpdateBackupPlan operation.

• The fluent builder is configurable:
  • backup_plan_id(impl Into<String>) / set_backup_plan_id(Option<String>):
    required: true
    

    Uniquely identifies a backup plan.

    
    
  • backup_plan(BackupPlanInput) / set_backup_plan(Option<BackupPlanInput>):
    required: true
    

    Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

    
    
• On success, responds with UpdateBackupPlanOutput with field(s):
  • backup_plan_id(Option<String>):

    Uniquely identifies a backup plan.

  • backup_plan_arn(Option<String>):

    An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

  • creation_date(Option<DateTime>):

    The date and time a backup plan 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.

  • version_id(Option<String>):

    Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.

  • advanced_backup_settings(Option<Vec::<AdvancedBackupSetting>>):

    Contains a list of BackupOptions for each resource type.

• On failure, responds with SdkError<UpdateBackupPlanError>

impl Client

pub fn update_framework(&self) -> UpdateFrameworkFluentBuilder

Constructs a fluent builder for the UpdateFramework operation.

• The fluent builder is configurable:
  • framework_name(impl Into<String>) / set_framework_name(Option<String>):
    required: true
    

    The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

    
    
  • framework_description(impl Into<String>) / set_framework_description(Option<String>):
    required: false
    

    An optional description of the framework with a maximum 1,024 characters.

    
    
  • framework_controls(FrameworkControl) / set_framework_controls(Option<Vec::<FrameworkControl>>):
    required: false
    

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

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

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

    
    
• On success, responds with UpdateFrameworkOutput with field(s):
  • framework_name(Option<String>):

    The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

  • framework_arn(Option<String>):

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

  • creation_time(Option<DateTime>):

    The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

• On failure, responds with SdkError<UpdateFrameworkError>

impl Client

pub fn update_global_settings(&self) -> UpdateGlobalSettingsFluentBuilder

Constructs a fluent builder for the UpdateGlobalSettings operation.

• The fluent builder is configurable:
  • global_settings(impl Into<String>, impl Into<String>) / set_global_settings(Option<HashMap::<String, String>>):
    required: false
    

    A value for isCrossAccountBackupEnabled and a Region. Example: update-global-settings –global-settings isCrossAccountBackupEnabled=false –region us-west-2.

    
    
• On success, responds with UpdateGlobalSettingsOutput
• On failure, responds with SdkError<UpdateGlobalSettingsError>

impl Client

pub fn update_recovery_point_lifecycle( &self ) -> UpdateRecoveryPointLifecycleFluentBuilder

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>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: false
    

    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.

    Resource types that are able to be transitioned to cold storage are listed in the “Lifecycle to cold storage” 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>

impl Client

pub fn update_region_settings(&self) -> UpdateRegionSettingsFluentBuilder

Constructs a fluent builder for the UpdateRegionSettings operation.

• The fluent builder is configurable:
  • resource_type_opt_in_preference(impl Into<String>, bool) / set_resource_type_opt_in_preference(Option<HashMap::<String, bool>>):
    required: false
    

    Updates the list of services along with the opt-in preferences for the Region.

    
    
  • resource_type_management_preference(impl Into<String>, bool) / set_resource_type_management_preference(Option<HashMap::<String, bool>>):
    required: false
    

    Enables or disables full Backup management of backups for a resource type. To enable full Backup management for DynamoDB along with Backup’s advanced DynamoDB backup features, follow the procedure to enable advanced DynamoDB backup programmatically.

    
    
• On success, responds with UpdateRegionSettingsOutput
• On failure, responds with SdkError<UpdateRegionSettingsError>

impl Client

pub fn update_report_plan(&self) -> UpdateReportPlanFluentBuilder

Constructs a fluent builder for the UpdateReportPlan operation.

• The fluent builder is configurable:
  • report_plan_name(impl Into<String>) / set_report_plan_name(Option<String>):
    required: true
    

    The unique name of the report plan. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

    
    
  • report_plan_description(impl Into<String>) / set_report_plan_description(Option<String>):
    required: false
    

    An optional description of the report plan with a maximum 1,024 characters.

    
    
  • report_delivery_channel(ReportDeliveryChannel) / set_report_delivery_channel(Option<ReportDeliveryChannel>):
    required: false
    

    A structure that contains information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

    
    
  • report_setting(ReportSetting) / set_report_setting(Option<ReportSetting>):
    required: false
    

    Identifies the report template for the report. Reports are built using a report template. The report templates are:

    RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

    If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

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

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

    
    
• On success, responds with UpdateReportPlanOutput with field(s):
  • report_plan_name(Option<String>):

    The unique name of the report plan.

  • report_plan_arn(Option<String>):

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

  • creation_time(Option<DateTime>):

    The date and time that a report plan 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.

• On failure, responds with SdkError<UpdateReportPlanError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.