Backup

This page documents function available when using the Backup module, created with @service Backup.

Index

Documentation

Main.Backup.cancel_legal_holdMethod
cancel_legal_hold(cancel_description, legal_hold_id)
cancel_legal_hold(cancel_description, legal_hold_id, params::Dict{String,<:Any})

This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.

Arguments

  • cancel_description: String describing the reason for removing the legal hold.
  • legal_hold_id: Legal hold ID required to remove the specified legal hold on a recovery point.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "retainRecordInDays": The integer amount in days specifying amount of days after this API operation to remove legal hold.
source
Main.Backup.create_backup_planMethod
create_backup_plan(backup_plan)
create_backup_plan(backup_plan, params::Dict{String,<:Any})

Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks that create recovery points for resources. If you call CreateBackupPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "BackupPlanTags": 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.
  • "CreatorRequestId": 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.
source
Main.Backup.create_backup_selectionMethod
create_backup_selection(backup_selection, backup_plan_id)
create_backup_selection(backup_selection, backup_plan_id, params::Dict{String,<:Any})

Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically.

Arguments

  • backup_selection: Specifies the body of a request to assign a set of resources to a backup plan.
  • backup_plan_id: Uniquely identifies the backup plan to be associated with the selection of resources.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "CreatorRequestId": 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.
source
Main.Backup.create_backup_vaultMethod
create_backup_vault(backup_vault_name)
create_backup_vault(backup_vault_name, params::Dict{String,<:Any})

Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID. Do not include sensitive data, such as passport numbers, in the name of a backup vault.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "BackupVaultTags": Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.
  • "CreatorRequestId": 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.
  • "EncryptionKeyArn": 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.
source
Main.Backup.create_frameworkMethod
create_framework(framework_controls, framework_name)
create_framework(framework_controls, framework_name, params::Dict{String,<:Any})

Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.

Arguments

  • framework_controls: A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
  • framework_name: 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 (_).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "FrameworkDescription": An optional description of the framework with a maximum of 1,024 characters.
  • "FrameworkTags": Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
  • "IdempotencyToken": 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.
source
Main.Backup.create_legal_holdMethod
create_legal_hold(description, title)
create_legal_hold(description, title, params::Dict{String,<:Any})

This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.

Arguments

  • description: This is the string description of the legal hold.
  • title: This is the string title of the legal hold.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "IdempotencyToken": 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.
  • "RecoveryPointSelection": This specifies criteria to assign a set of resources, such as resource types or backup vaults.
  • "Tags": 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: + - = . _ : /.
source
Main.Backup.create_report_planMethod
create_report_plan(report_delivery_channel, report_plan_name, report_setting)
create_report_plan(report_delivery_channel, report_plan_name, report_setting, params::Dict{String,<:Any})

Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it. If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Arguments

  • report_delivery_channel: 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_plan_name: 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_setting: Identifies the report template for the report. Reports are built using a report template. The report templates are: RESOURCECOMPLIANCEREPORT | CONTROLCOMPLIANCEREPORT | BACKUPJOBREPORT | COPYJOBREPORT | RESTOREJOBREPORT If the report template is RESOURCECOMPLIANCEREPORT or CONTROLCOMPLIANCEREPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "IdempotencyToken": 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.
  • "ReportPlanDescription": An optional description of the report plan with a maximum of 1,024 characters.
  • "ReportPlanTags": Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
source
Main.Backup.delete_backup_planMethod
delete_backup_plan(backup_plan_id)
delete_backup_plan(backup_plan_id, params::Dict{String,<:Any})

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

Arguments

  • backup_plan_id: Uniquely identifies a backup plan.
source
Main.Backup.delete_backup_selectionMethod
delete_backup_selection(backup_plan_id, selection_id)
delete_backup_selection(backup_plan_id, selection_id, params::Dict{String,<:Any})

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

Arguments

  • backup_plan_id: Uniquely identifies a backup plan.
  • selection_id: Uniquely identifies the body of a request to assign a set of resources to a backup plan.
source
Main.Backup.delete_backup_vaultMethod
delete_backup_vault(backup_vault_name)
delete_backup_vault(backup_vault_name, params::Dict{String,<:Any})

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

Arguments

  • backup_vault_name: 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.
source
Main.Backup.delete_backup_vault_access_policyMethod
delete_backup_vault_access_policy(backup_vault_name)
delete_backup_vault_access_policy(backup_vault_name, params::Dict{String,<:Any})

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

Arguments

  • backup_vault_name: 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.
source
Main.Backup.delete_backup_vault_lock_configurationMethod
delete_backup_vault_lock_configuration(backup_vault_name)
delete_backup_vault_lock_configuration(backup_vault_name, params::Dict{String,<:Any})

Deletes Backup Vault Lock from a backup vault specified by a backup vault name. If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you will receive an InvalidRequestException if you attempt to do so. For more information, see Vault Lock in the Backup Developer Guide.

Arguments

  • backup_vault_name: The name of the backup vault from which to delete Backup Vault Lock.
source
Main.Backup.delete_backup_vault_notificationsMethod
delete_backup_vault_notifications(backup_vault_name)
delete_backup_vault_notifications(backup_vault_name, params::Dict{String,<:Any})

Deletes event notifications for the specified backup vault.

Arguments

  • backup_vault_name: 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.
source
Main.Backup.delete_frameworkMethod
delete_framework(framework_name)
delete_framework(framework_name, params::Dict{String,<:Any})

Deletes the framework specified by a framework name.

Arguments

  • framework_name: The unique name of a framework.
source
Main.Backup.delete_recovery_pointMethod
delete_recovery_point(backup_vault_name, recovery_point_arn)
delete_recovery_point(backup_vault_name, recovery_point_arn, params::Dict{String,<:Any})

Deletes the recovery point specified by a recovery point ID. If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup. When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an EXPIRED state. EXPIRED recovery points can be deleted with this API once the IAM role has the iam:CreateServiceLinkedRole action. To learn more about adding this role, see Troubleshooting manual deletions. If the user or role is deleted or the permission within the role is removed, the deletion will not be successful and will enter an EXPIRED state.

Arguments

  • backup_vault_name: 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: 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.
source
Main.Backup.delete_report_planMethod
delete_report_plan(report_plan_name)
delete_report_plan(report_plan_name, params::Dict{String,<:Any})

Deletes the report plan specified by a report plan name.

Arguments

  • report_plan_name: The unique name of a report plan.
source
Main.Backup.describe_backup_jobMethod
describe_backup_job(backup_job_id)
describe_backup_job(backup_job_id, params::Dict{String,<:Any})

Returns backup job details for the specified BackupJobId.

Arguments

  • backup_job_id: Uniquely identifies a request to Backup to back up a resource.
source
Main.Backup.describe_backup_vaultMethod
describe_backup_vault(backup_vault_name)
describe_backup_vault(backup_vault_name, params::Dict{String,<:Any})

Returns metadata about a backup vault specified by its name.

Arguments

  • backup_vault_name: 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.
source
Main.Backup.describe_copy_jobMethod
describe_copy_job(copy_job_id)
describe_copy_job(copy_job_id, params::Dict{String,<:Any})

Returns metadata associated with creating a copy of a resource.

Arguments

  • copy_job_id: Uniquely identifies a copy job.
source
Main.Backup.describe_frameworkMethod
describe_framework(framework_name)
describe_framework(framework_name, params::Dict{String,<:Any})

Returns the framework details for the specified FrameworkName.

Arguments

  • framework_name: The unique name of a framework.
source
Main.Backup.describe_global_settingsMethod
describe_global_settings()
describe_global_settings(params::Dict{String,<:Any})

Describes whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not a member of an Organizations organization. Example: describe-global-settings –region us-west-2

source
Main.Backup.describe_protected_resourceMethod
describe_protected_resource(resource_arn)
describe_protected_resource(resource_arn, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
source
Main.Backup.describe_recovery_pointMethod
describe_recovery_point(backup_vault_name, recovery_point_arn)
describe_recovery_point(backup_vault_name, recovery_point_arn, params::Dict{String,<:Any})

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

Arguments

  • backup_vault_name: 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: 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.
source
Main.Backup.describe_region_settingsMethod
describe_region_settings()
describe_region_settings(params::Dict{String,<:Any})

Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region.

source
Main.Backup.describe_report_jobMethod
describe_report_job(report_job_id)
describe_report_job(report_job_id, params::Dict{String,<:Any})

Returns the details associated with creating a report as specified by its ReportJobId.

Arguments

  • report_job_id: 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.
source
Main.Backup.describe_report_planMethod
describe_report_plan(report_plan_name)
describe_report_plan(report_plan_name, params::Dict{String,<:Any})

Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.

Arguments

  • report_plan_name: The unique name of a report plan.
source
Main.Backup.describe_restore_jobMethod
describe_restore_job(restore_job_id)
describe_restore_job(restore_job_id, params::Dict{String,<:Any})

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

Arguments

  • restore_job_id: Uniquely identifies the job that restores a recovery point.
source
Main.Backup.disassociate_recovery_pointMethod
disassociate_recovery_point(backup_vault_name, recovery_point_arn)
disassociate_recovery_point(backup_vault_name, recovery_point_arn, params::Dict{String,<:Any})

Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan. Does not support snapshot backup recovery points.

Arguments

  • backup_vault_name: The unique name of an Backup vault.
  • recovery_point_arn: An Amazon Resource Name (ARN) that uniquely identifies an Backup recovery point.
source
Main.Backup.disassociate_recovery_point_from_parentMethod
disassociate_recovery_point_from_parent(backup_vault_name, recovery_point_arn)
disassociate_recovery_point_from_parent(backup_vault_name, recovery_point_arn, params::Dict{String,<:Any})

This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.

Arguments

  • backup_vault_name: 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: 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.
source
Main.Backup.export_backup_plan_templateMethod
export_backup_plan_template(backup_plan_id)
export_backup_plan_template(backup_plan_id, params::Dict{String,<:Any})

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

Arguments

  • backup_plan_id: Uniquely identifies a backup plan.
source
Main.Backup.get_backup_planMethod
get_backup_plan(backup_plan_id)
get_backup_plan(backup_plan_id, params::Dict{String,<:Any})

Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.

Arguments

  • backup_plan_id: Uniquely identifies a backup plan.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "versionId": Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
source
Main.Backup.get_backup_plan_from_jsonMethod
get_backup_plan_from_json(backup_plan_template_json)
get_backup_plan_from_json(backup_plan_template_json, params::Dict{String,<:Any})

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

Arguments

  • backup_plan_template_json: A customer-supplied backup plan document in JSON format.
source
Main.Backup.get_backup_plan_from_templateMethod
get_backup_plan_from_template(template_id)
get_backup_plan_from_template(template_id, params::Dict{String,<:Any})

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

Arguments

  • template_id: Uniquely identifies a stored backup plan template.
source
Main.Backup.get_backup_selectionMethod
get_backup_selection(backup_plan_id, selection_id)
get_backup_selection(backup_plan_id, selection_id, params::Dict{String,<:Any})

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

Arguments

  • backup_plan_id: Uniquely identifies a backup plan.
  • selection_id: Uniquely identifies the body of a request to assign a set of resources to a backup plan.
source
Main.Backup.get_backup_vault_access_policyMethod
get_backup_vault_access_policy(backup_vault_name)
get_backup_vault_access_policy(backup_vault_name, params::Dict{String,<:Any})

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

Arguments

  • backup_vault_name: 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.
source
Main.Backup.get_backup_vault_notificationsMethod
get_backup_vault_notifications(backup_vault_name)
get_backup_vault_notifications(backup_vault_name, params::Dict{String,<:Any})

Returns event notifications for the specified backup vault.

Arguments

  • backup_vault_name: 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.
source
Main.Backup.get_legal_holdMethod
get_legal_hold(legal_hold_id)
get_legal_hold(legal_hold_id, params::Dict{String,<:Any})

This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.

Arguments

  • legal_hold_id: This is the ID required to use GetLegalHold. This unique ID is associated with a specific legal hold.
source
Main.Backup.get_recovery_point_restore_metadataMethod
get_recovery_point_restore_metadata(backup_vault_name, recovery_point_arn)
get_recovery_point_restore_metadata(backup_vault_name, recovery_point_arn, params::Dict{String,<:Any})

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

Arguments

  • backup_vault_name: 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: 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.
source
Main.Backup.list_backup_jobsMethod
list_backup_jobs()
list_backup_jobs(params::Dict{String,<:Any})

Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "accountId": 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.
  • "backupVaultName": 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.
  • "completeAfter": Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
  • "completeBefore": Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
  • "createdAfter": Returns only backup jobs that were created after the specified date.
  • "createdBefore": Returns only backup jobs that were created before the specified date.
  • "maxResults": The maximum number of items to be returned.
  • "nextToken": 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.
  • "parentJobId": This is a filter to list child (nested) jobs based on parent job ID.
  • "resourceArn": Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
  • "resourceType": 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
  • "state": Returns only backup jobs that are in the specified state.
source
Main.Backup.list_backup_plan_templatesMethod
list_backup_plan_templates()
list_backup_plan_templates(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to be returned.
  • "nextToken": 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.
source
Main.Backup.list_backup_plan_versionsMethod
list_backup_plan_versions(backup_plan_id)
list_backup_plan_versions(backup_plan_id, params::Dict{String,<:Any})

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

Arguments

  • backup_plan_id: Uniquely identifies a backup plan.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to be returned.
  • "nextToken": 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.
source
Main.Backup.list_backup_plansMethod
list_backup_plans()
list_backup_plans(params::Dict{String,<:Any})

Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "includeDeleted": A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.
  • "maxResults": The maximum number of items to be returned.
  • "nextToken": 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.
source
Main.Backup.list_backup_selectionsMethod
list_backup_selections(backup_plan_id)
list_backup_selections(backup_plan_id, params::Dict{String,<:Any})

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

Arguments

  • backup_plan_id: Uniquely identifies a backup plan.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to be returned.
  • "nextToken": 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.
source
Main.Backup.list_backup_vaultsMethod
list_backup_vaults()
list_backup_vaults(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to be returned.
  • "nextToken": 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.
source
Main.Backup.list_copy_jobsMethod
list_copy_jobs()
list_copy_jobs(params::Dict{String,<:Any})

Returns metadata about your copy jobs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "accountId": The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.
  • "completeAfter": Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
  • "completeBefore": Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
  • "createdAfter": Returns only copy jobs that were created after the specified date.
  • "createdBefore": Returns only copy jobs that were created before the specified date.
  • "destinationVaultArn": 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.
  • "maxResults": The maximum number of items to be returned.
  • "nextToken": 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.
  • "parentJobId": This is a filter to list child (nested) jobs based on parent job ID.
  • "resourceArn": Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
  • "resourceType": 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
  • "state": Returns only copy jobs that are in the specified state.
source
Main.Backup.list_frameworksMethod
list_frameworks()
list_frameworks(params::Dict{String,<:Any})

Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
  • "NextToken": 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.
source
Main.Backup.list_legal_holdsMethod
list_legal_holds()
list_legal_holds(params::Dict{String,<:Any})

This action returns metadata about active and previous legal holds.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of resource list items to be returned.
  • "nextToken": 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.
source
Main.Backup.list_protected_resourcesMethod
list_protected_resources()
list_protected_resources(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to be returned.
  • "nextToken": 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.
source
Main.Backup.list_recovery_points_by_backup_vaultMethod
list_recovery_points_by_backup_vault(backup_vault_name)
list_recovery_points_by_backup_vault(backup_vault_name, params::Dict{String,<:Any})

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

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "backupPlanId": Returns only recovery points that match the specified backup plan ID.
  • "createdAfter": Returns only recovery points that were created after the specified timestamp.
  • "createdBefore": Returns only recovery points that were created before the specified timestamp.
  • "maxResults": The maximum number of items to be returned.
  • "nextToken": 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.
  • "parentRecoveryPointArn": This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).
  • "resourceArn": Returns only recovery points that match the specified resource Amazon Resource Name (ARN).
  • "resourceType": Returns only recovery points that match the specified resource type.
source
Main.Backup.list_recovery_points_by_legal_holdMethod
list_recovery_points_by_legal_hold(legal_hold_id)
list_recovery_points_by_legal_hold(legal_hold_id, params::Dict{String,<:Any})

This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.

Arguments

  • legal_hold_id: This is the ID of the legal hold.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": This is the maximum number of resource list items to be returned.
  • "nextToken": 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.
source
Main.Backup.list_recovery_points_by_resourceMethod
list_recovery_points_by_resource(resource_arn)
list_recovery_points_by_resource(resource_arn, params::Dict{String,<:Any})

Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN). For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to be returned. Amazon RDS requires a value of at least 20.
  • "nextToken": 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.
source
Main.Backup.list_report_jobsMethod
list_report_jobs()
list_report_jobs(params::Dict{String,<:Any})

Returns details about your report jobs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "CreationAfter": 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.
  • "CreationBefore": 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.
  • "MaxResults": The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
  • "NextToken": 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.
  • "ReportPlanName": Returns only report jobs with the specified report plan name.
  • "Status": Returns only report jobs that are in the specified status. The statuses are: CREATED | RUNNING | COMPLETED | FAILED
source
Main.Backup.list_report_plansMethod
list_report_plans()
list_report_plans(params::Dict{String,<:Any})

Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
  • "NextToken": 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.
source
Main.Backup.list_restore_jobsMethod
list_restore_jobs()
list_restore_jobs(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "accountId": The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.
  • "completeAfter": Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
  • "completeBefore": Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
  • "createdAfter": Returns only restore jobs that were created after the specified date.
  • "createdBefore": Returns only restore jobs that were created before the specified date.
  • "maxResults": The maximum number of items to be returned.
  • "nextToken": 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.
  • "status": Returns only restore jobs associated with the specified job status.
source
Main.Backup.list_tagsMethod
list_tags(resource_arn)
list_tags(resource_arn, params::Dict{String,<:Any})

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault. ListTags only works for resource types that support full Backup management of their backups. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to be returned.
  • "nextToken": 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.
source
Main.Backup.put_backup_vault_access_policyMethod
put_backup_vault_access_policy(backup_vault_name)
put_backup_vault_access_policy(backup_vault_name, params::Dict{String,<:Any})

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

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Policy": The backup vault access policy document in JSON format.
source
Main.Backup.put_backup_vault_lock_configurationMethod
put_backup_vault_lock_configuration(backup_vault_name)
put_backup_vault_lock_configuration(backup_vault_name, params::Dict{String,<:Any})

Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault. Backup Vault Lock has yet to receive a third-party assessment for SEC 17a-4(f) and CFTC.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ChangeableForDays": 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.
  • "MaxRetentionDays": 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.
  • "MinRetentionDays": 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.
source
Main.Backup.put_backup_vault_notificationsMethod
put_backup_vault_notifications(backup_vault_events, snstopic_arn, backup_vault_name)
put_backup_vault_notifications(backup_vault_events, snstopic_arn, backup_vault_name, params::Dict{String,<:Any})

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

Arguments

  • backup_vault_events: 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: BACKUPJOBSTARTED | BACKUPJOBCOMPLETED COPYJOBSTARTED | COPYJOBSUCCESSFUL | COPYJOBFAILED RESTOREJOBSTARTED | RESTOREJOBCOMPLETED | RECOVERYPOINTMODIFIED S3BACKUPOBJECTFAILED | S3RESTOREOBJECTFAILED 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.
  • snstopic_arn: 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_name: 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.
source
Main.Backup.start_backup_jobMethod
start_backup_job(backup_vault_name, iam_role_arn, resource_arn)
start_backup_job(backup_vault_name, iam_role_arn, resource_arn, params::Dict{String,<:Any})

Starts an on-demand backup job for the specified resource.

Arguments

  • backup_vault_name: 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.
  • iam_role_arn: Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
  • resource_arn: An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "BackupOptions": 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.
  • "CompleteWindowMinutes": 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.
  • "IdempotencyToken": 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.
  • "Lifecycle": 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.
  • "RecoveryPointTags": To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
  • "StartWindowMinutes": 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.
source
Main.Backup.start_copy_jobMethod
start_copy_job(destination_backup_vault_arn, iam_role_arn, recovery_point_arn, source_backup_vault_name)
start_copy_job(destination_backup_vault_arn, iam_role_arn, recovery_point_arn, source_backup_vault_name, params::Dict{String,<:Any})

Starts a job to create a one-time copy of the specified resource. Does not support continuous backups.

Arguments

  • destination_backup_vault_arn: 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: Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
  • recovery_point_arn: 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: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "IdempotencyToken": 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":
source
Main.Backup.start_report_jobMethod
start_report_job(report_plan_name)
start_report_job(report_plan_name, params::Dict{String,<:Any})

Starts an on-demand report job for the specified report plan.

Arguments

  • report_plan_name: The unique name of a report plan.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "IdempotencyToken": 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.
source
Main.Backup.start_restore_jobMethod
start_restore_job(metadata, recovery_point_arn)
start_restore_job(metadata, recovery_point_arn, params::Dict{String,<:Any})

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

Arguments

  • metadata: 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"]".
  • recovery_point_arn: An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "IamRoleArn": 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.
  • "IdempotencyToken": 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.
  • "ResourceType": Starts a job to restore a recovery point for one of the following resources: Aurora for Amazon Aurora DocumentDB for Amazon DocumentDB (with MongoDB compatibility) DynamoDB for Amazon DynamoDB EBS for Amazon Elastic Block Store EC2 for Amazon Elastic Compute Cloud EFS for Amazon Elastic File System FSx for Amazon FSx Neptune for Amazon Neptune RDS for Amazon Relational Database Service Storage Gateway for Storage Gateway S3 for Amazon S3 VirtualMachine for virtual machines
source
Main.Backup.stop_backup_jobMethod
stop_backup_job(backup_job_id)
stop_backup_job(backup_job_id, params::Dict{String,<:Any})

Attempts to cancel a job to create a one-time backup of a resource. This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, FSx for ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.

Arguments

  • backup_job_id: Uniquely identifies a request to Backup to back up a resource.
source
Main.Backup.tag_resourceMethod
tag_resource(tags, resource_arn)
tag_resource(tags, resource_arn, params::Dict{String,<:Any})

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

Arguments

  • tags: 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"}].
  • resource_arn: An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
source
Main.Backup.untag_resourceMethod
untag_resource(tag_key_list, resource_arn)
untag_resource(tag_key_list, resource_arn, params::Dict{String,<:Any})

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

Arguments

  • tag_key_list: A list of keys to identify which key-value tags to remove from a resource.
  • resource_arn: An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
source
Main.Backup.update_backup_planMethod
update_backup_plan(backup_plan, backup_plan_id)
update_backup_plan(backup_plan, backup_plan_id, params::Dict{String,<:Any})

Updates an existing backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.

Arguments

  • backup_plan: Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
  • backup_plan_id: Uniquely identifies a backup plan.
source
Main.Backup.update_frameworkMethod
update_framework(framework_name)
update_framework(framework_name, params::Dict{String,<:Any})

Updates an existing framework identified by its FrameworkName with the input document in JSON format.

Arguments

  • framework_name: 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 (_).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "FrameworkControls": A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
  • "FrameworkDescription": An optional description of the framework with a maximum 1,024 characters.
  • "IdempotencyToken": 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.
source
Main.Backup.update_global_settingsMethod
update_global_settings()
update_global_settings(params::Dict{String,<:Any})

Updates whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not an Organizations management account. Use the DescribeGlobalSettings API to determine the current settings.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "GlobalSettings": A value for isCrossAccountBackupEnabled and a Region. Example: update-global-settings –global-settings isCrossAccountBackupEnabled=false –region us-west-2.
source
Main.Backup.update_recovery_point_lifecycleMethod
update_recovery_point_lifecycle(backup_vault_name, recovery_point_arn)
update_recovery_point_lifecycle(backup_vault_name, recovery_point_arn, params::Dict{String,<:Any})

Sets the transition lifecycle of a recovery point. 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. This operation does not support continuous backups.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
source
Main.Backup.update_region_settingsMethod
update_region_settings()
update_region_settings(params::Dict{String,<:Any})

Updates the current service opt-in settings for the Region. If service-opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region. Use the DescribeRegionSettings API to determine the resource types that are supported.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ResourceTypeManagementPreference": 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.
  • "ResourceTypeOptInPreference": Updates the list of services along with the opt-in preferences for the Region.
source
Main.Backup.update_report_planMethod
update_report_plan(report_plan_name)
update_report_plan(report_plan_name, params::Dict{String,<:Any})

Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.

Arguments

  • report_plan_name: 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 (_).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "IdempotencyToken": 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.
  • "ReportDeliveryChannel": 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.
  • "ReportPlanDescription": An optional description of the report plan with a maximum 1,024 characters.
  • "ReportSetting": Identifies the report template for the report. Reports are built using a report template. The report templates are: RESOURCECOMPLIANCEREPORT | CONTROLCOMPLIANCEREPORT | BACKUPJOBREPORT | COPYJOBREPORT | RESTOREJOBREPORT If the report template is RESOURCECOMPLIANCEREPORT or CONTROLCOMPLIANCEREPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
source