aws-elixir

View Source AWS.Backup (aws-elixir v1.0.4)

Backup

Backup is a unified backup service designed to protect Amazon Web Services services and their associated data.

Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.

Link to this section Summary

Functions

cancel_legal_hold(client, legal_hold_id, input, options \\ [])

Removes the specified legal hold on a recovery point.

create_backup_plan(client, input, options \\ [])

Creates a backup plan using a backup plan name and backup rules.

create_backup_selection(client, backup_plan_id, input, options \\ [])

Creates a JSON document that specifies a set of resources to assign to a backup plan.

create_backup_vault(client, backup_vault_name, input, options \\ [])

Creates a logical container where backups are stored.

create_framework(client, input, options \\ [])

Creates a framework with one or more controls.

create_legal_hold(client, input, options \\ [])

Creates a legal hold on a recovery point (backup).

create_logically_air_gapped_backup_vault(client, backup_vault_name, input, options \\ [])

Creates a logical container to where backups may be copied.

create_report_plan(client, input, options \\ [])

Creates a report plan.

create_restore_testing_plan(client, input, options \\ [])

Creates a restore testing plan.

create_restore_testing_selection(client, restore_testing_plan_name, input, options \\ [])

This request can be sent after CreateRestoreTestingPlan request returns successfully.

delete_backup_plan(client, backup_plan_id, input, options \\ [])

Deletes a backup plan.

delete_backup_selection(client, backup_plan_id, selection_id, input, options \\ [])

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

delete_backup_vault(client, backup_vault_name, input, options \\ [])

Deletes the backup vault identified by its name.

delete_backup_vault_access_policy(client, backup_vault_name, input, options \\ [])

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

delete_backup_vault_lock_configuration(client, backup_vault_name, input, options \\ [])

Deletes Backup Vault Lock from a backup vault specified by a backup vault name.

delete_backup_vault_notifications(client, backup_vault_name, input, options \\ [])

Deletes event notifications for the specified backup vault.

delete_framework(client, framework_name, input, options \\ [])

Deletes the framework specified by a framework name.

delete_recovery_point(client, backup_vault_name, recovery_point_arn, input, options \\ [])

Deletes the recovery point specified by a recovery point ID.

delete_report_plan(client, report_plan_name, input, options \\ [])

Deletes the report plan specified by a report plan name.

delete_restore_testing_plan(client, restore_testing_plan_name, input, options \\ [])

This request deletes the specified restore testing plan.

delete_restore_testing_selection(client, restore_testing_plan_name, restore_testing_selection_name, input, options \\ [])

Input the Restore Testing Plan name and Restore Testing Selection name.

describe_backup_job(client, backup_job_id, options \\ [])

Returns backup job details for the specified BackupJobId.

describe_backup_vault(client, backup_vault_name, backup_vault_account_id \\ nil, options \\ [])

Returns metadata about a backup vault specified by its name.

describe_copy_job(client, copy_job_id, options \\ [])

Returns metadata associated with creating a copy of a resource.

describe_framework(client, framework_name, options \\ [])

Returns the framework details for the specified FrameworkName.

describe_global_settings(client, options \\ [])

Describes whether the Amazon Web Services account is opted in to cross-account backup.

describe_protected_resource(client, resource_arn, options \\ [])

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.

describe_recovery_point(client, backup_vault_name, recovery_point_arn, backup_vault_account_id \\ nil, options \\ [])

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

describe_region_settings(client, options \\ [])

Returns the current service opt-in settings for the Region.

describe_report_job(client, report_job_id, options \\ [])

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

describe_report_plan(client, report_plan_name, options \\ [])

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

describe_restore_job(client, restore_job_id, options \\ [])

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

disassociate_recovery_point(client, backup_vault_name, recovery_point_arn, input, options \\ [])

Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS.

disassociate_recovery_point_from_parent(client, backup_vault_name, recovery_point_arn, input, options \\ [])

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

export_backup_plan_template(client, backup_plan_id, options \\ [])

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

get_backup_plan(client, backup_plan_id, version_id \\ nil, options \\ [])

Returns BackupPlan details for the specified BackupPlanId.

get_backup_plan_from_json(client, input, options \\ [])

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

get_backup_plan_from_template(client, backup_plan_template_id, options \\ [])

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

get_backup_selection(client, backup_plan_id, selection_id, options \\ [])

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

get_backup_vault_access_policy(client, backup_vault_name, options \\ [])

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

get_backup_vault_notifications(client, backup_vault_name, options \\ [])

Returns event notifications for the specified backup vault.

get_legal_hold(client, legal_hold_id, options \\ [])

This action returns details for a specified legal hold.

get_recovery_point_restore_metadata(client, backup_vault_name, recovery_point_arn, backup_vault_account_id \\ nil, options \\ [])

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

get_restore_job_metadata(client, restore_job_id, options \\ [])

This request returns the metadata for the specified restore job.

get_restore_testing_inferred_metadata(client, backup_vault_account_id \\ nil, backup_vault_name, recovery_point_arn, options \\ [])

This request returns the minimal required set of metadata needed to start a restore job with secure default settings.

get_restore_testing_plan(client, restore_testing_plan_name, options \\ [])

Returns RestoreTestingPlan details for the specified RestoreTestingPlanName.

get_restore_testing_selection(client, restore_testing_plan_name, restore_testing_selection_name, options \\ [])

Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.

get_supported_resource_types(client, options \\ [])

Returns the Amazon Web Services resource types supported by Backup.

list_backup_job_summaries(client, account_id \\ nil, aggregation_period \\ nil, max_results \\ nil, message_category \\ nil, next_token \\ nil, resource_type \\ nil, state \\ nil, options \\ [])

This is a request for a summary of backup jobs created or running within the most recent 30 days.

list_backup_jobs(client, by_account_id \\ nil, by_backup_vault_name \\ nil, by_complete_after \\ nil, by_complete_before \\ nil, by_created_after \\ nil, by_created_before \\ nil, by_message_category \\ nil, by_parent_job_id \\ nil, by_resource_arn \\ nil, by_resource_type \\ nil, by_state \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of existing backup jobs for an authenticated account for the last 30 days.

list_backup_plan_templates(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the backup plan templates.

list_backup_plan_versions(client, backup_plan_id, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_backup_plans(client, include_deleted \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the active backup plans for the account.

list_backup_selections(client, backup_plan_id, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_backup_vaults(client, by_shared \\ nil, by_vault_type \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_copy_job_summaries(client, account_id \\ nil, aggregation_period \\ nil, max_results \\ nil, message_category \\ nil, next_token \\ nil, resource_type \\ nil, state \\ nil, options \\ [])

This request obtains a list of copy jobs created or running within the the most recent 30 days.

list_copy_jobs(client, by_account_id \\ nil, by_complete_after \\ nil, by_complete_before \\ nil, by_created_after \\ nil, by_created_before \\ nil, by_destination_vault_arn \\ nil, by_message_category \\ nil, by_parent_job_id \\ nil, by_resource_arn \\ nil, by_resource_type \\ nil, by_state \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Returns metadata about your copy jobs.

list_frameworks(client, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_legal_holds(client, max_results \\ nil, next_token \\ nil, options \\ [])

This action returns metadata about active and previous legal holds.

list_protected_resources(client, max_results \\ nil, next_token \\ nil, options \\ [])

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.

list_protected_resources_by_backup_vault(client, backup_vault_name, backup_vault_account_id \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

This request lists the protected resources corresponding to each backup vault.

list_recovery_points_by_backup_vault(client, backup_vault_name, backup_vault_account_id \\ nil, by_backup_plan_id \\ nil, by_created_after \\ nil, by_created_before \\ nil, by_parent_recovery_point_arn \\ nil, by_resource_arn \\ nil, by_resource_type \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_recovery_points_by_legal_hold(client, legal_hold_id, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_recovery_points_by_resource(client, resource_arn, managed_by_aws_backup_only \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_report_jobs(client, by_creation_after \\ nil, by_creation_before \\ nil, by_report_plan_name \\ nil, by_status \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Returns details about your report jobs.

list_report_plans(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of your report plans.

list_restore_job_summaries(client, account_id \\ nil, aggregation_period \\ nil, max_results \\ nil, next_token \\ nil, resource_type \\ nil, state \\ nil, options \\ [])

This request obtains a summary of restore jobs created or running within the the most recent 30 days.

list_restore_jobs(client, by_account_id \\ nil, by_complete_after \\ nil, by_complete_before \\ nil, by_created_after \\ nil, by_created_before \\ nil, by_resource_type \\ nil, by_restore_testing_plan_arn \\ nil, by_status \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_restore_jobs_by_protected_resource(client, resource_arn, by_recovery_point_creation_date_after \\ nil, by_recovery_point_creation_date_before \\ nil, by_status \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

This returns restore jobs that contain the specified protected resource.

list_restore_testing_plans(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of restore testing plans.

list_restore_testing_selections(client, restore_testing_plan_name, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of restore testing selections.

list_tags(client, resource_arn, max_results \\ nil, next_token \\ nil, options \\ [])

Returns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault.

metadata()
put_backup_vault_access_policy(client, backup_vault_name, input, options \\ [])

Sets a resource-based policy that is used to manage access permissions on the target backup vault.

put_backup_vault_lock_configuration(client, backup_vault_name, input, options \\ [])

Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault.

put_backup_vault_notifications(client, backup_vault_name, input, options \\ [])

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

put_restore_validation_result(client, restore_job_id, input, options \\ [])

This request allows you to send your independent self-run restore test validation results.

start_backup_job(client, input, options \\ [])

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

start_copy_job(client, input, options \\ [])

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

start_report_job(client, report_plan_name, input, options \\ [])

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

start_restore_job(client, input, options \\ [])

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

stop_backup_job(client, backup_job_id, input, options \\ [])

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

tag_resource(client, resource_arn, input, options \\ [])

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

untag_resource(client, resource_arn, input, options \\ [])

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

update_backup_plan(client, backup_plan_id, input, options \\ [])

Updates the specified backup plan.

update_framework(client, framework_name, input, options \\ [])

Updates the specified framework.

update_global_settings(client, input, options \\ [])

Updates whether the Amazon Web Services account is opted in to cross-account backup.

update_recovery_point_lifecycle(client, backup_vault_name, recovery_point_arn, input, options \\ [])

Sets the transition lifecycle of a recovery point.

update_region_settings(client, input, options \\ [])

Updates the current service opt-in settings for the Region.

update_report_plan(client, report_plan_name, input, options \\ [])

Updates the specified report plan.

update_restore_testing_plan(client, restore_testing_plan_name, input, options \\ [])

This request will send changes to your specified restore testing plan.

update_restore_testing_selection(client, restore_testing_plan_name, restore_testing_selection_name, input, options \\ [])

Updates the specified restore testing selection.

Link to this section Functions

Link to this function

create_backup_plan(client, input, options \\ [])

View Source

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.

Link to this function

create_backup_selection(client, backup_plan_id, input, options \\ [])

View Source

Creates a JSON document that specifies a set of resources to assign to a backup plan.

For examples, see Assigning resources programmatically.

Link to this function

create_backup_vault(client, backup_vault_name, input, options \\ [])

View Source

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.

Link to this function

create_framework(client, input, options \\ [])

View Source

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.

Link to this function

create_logically_air_gapped_backup_vault(client, backup_vault_name, input, options \\ [])

View Source

Creates a logical container to where backups may be copied.

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

Link to this function

create_report_plan(client, input, options \\ [])

View Source

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.

Link to this function

create_restore_testing_plan(client, input, options \\ [])

View Source

Creates a restore testing plan.

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

Link to this function

create_restore_testing_selection(client, restore_testing_plan_name, input, options \\ [])

View Source

This request can be sent after CreateRestoreTestingPlan request returns successfully.

This is the second part of creating a resource testing plan, and it must be completed sequentially.

This consists of RestoreTestingSelectionName, ProtectedResourceType, and one of the following:

*

ProtectedResourceArns

*

ProtectedResourceConditions

Each protected resource type can have one single value.

A restore testing selection can include a wildcard value ("*") for ProtectedResourceArns along with ProtectedResourceConditions. Alternatively, you can include up to 30 specific protected resource ARNs in ProtectedResourceArns.

Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.

Link to this function

delete_backup_plan(client, backup_plan_id, input, options \\ [])

View Source

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.

Link to this function

delete_backup_selection(client, backup_plan_id, selection_id, input, options \\ [])

View Source

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

Link to this function

delete_backup_vault(client, backup_vault_name, input, options \\ [])

View Source

Deletes the backup vault identified by its name.

A vault can be deleted only if it is empty.

Link to this function

delete_backup_vault_access_policy(client, backup_vault_name, input, options \\ [])

View Source

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

Link to this function

delete_backup_vault_lock_configuration(client, backup_vault_name, input, options \\ [])

View Source

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.

Link to this function

delete_backup_vault_notifications(client, backup_vault_name, input, options \\ [])

View Source

Deletes event notifications for the specified backup vault.

Link to this function

delete_framework(client, framework_name, input, options \\ [])

View Source

Deletes the framework specified by a framework name.

Link to this function

delete_recovery_point(client, backup_vault_name, recovery_point_arn, input, options \\ [])

View Source

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.

Link to this function

delete_report_plan(client, report_plan_name, input, options \\ [])

View Source

Deletes the report plan specified by a report plan name.

Link to this function

delete_restore_testing_plan(client, restore_testing_plan_name, input, options \\ [])

View Source

This request deletes the specified restore testing plan.

Deletion can only successfully occur if all associated restore testing selections are deleted first.

Link to this function

delete_restore_testing_selection(client, restore_testing_plan_name, restore_testing_selection_name, input, options \\ [])

View Source

Input the Restore Testing Plan name and Restore Testing Selection name.

All testing selections associated with a restore testing plan must be deleted before the restore testing plan can be deleted.

Link to this function

describe_backup_job(client, backup_job_id, options \\ [])

View Source

Returns backup job details for the specified BackupJobId.

Link to this function

describe_backup_vault(client, backup_vault_name, backup_vault_account_id \\ nil, options \\ [])

View Source

Returns metadata about a backup vault specified by its name.

Link to this function

describe_copy_job(client, copy_job_id, options \\ [])

View Source

Returns metadata associated with creating a copy of a resource.

Link to this function

describe_framework(client, framework_name, options \\ [])

View Source

Returns the framework details for the specified FrameworkName.

Link to this function

describe_global_settings(client, options \\ [])

View Source

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

Link to this function

describe_protected_resource(client, resource_arn, options \\ [])

View Source

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.

Link to this function

describe_recovery_point(client, backup_vault_name, recovery_point_arn, backup_vault_account_id \\ nil, options \\ [])

View Source

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

Link to this function

describe_region_settings(client, options \\ [])

View Source

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.

Link to this function

describe_report_job(client, report_job_id, options \\ [])

View Source

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

Link to this function

describe_report_plan(client, report_plan_name, options \\ [])

View Source

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

Link to this function

describe_restore_job(client, restore_job_id, options \\ [])

View Source

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

Link to this function

disassociate_recovery_point(client, backup_vault_name, recovery_point_arn, input, options \\ [])

View Source

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.

Link to this function

disassociate_recovery_point_from_parent(client, backup_vault_name, recovery_point_arn, input, options \\ [])

View Source

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

Link to this function

export_backup_plan_template(client, backup_plan_id, options \\ [])

View Source

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

Link to this function

get_backup_plan(client, backup_plan_id, version_id \\ nil, options \\ [])

View Source

Returns BackupPlan details for the specified BackupPlanId.

The details are the body of a backup plan in JSON format, in addition to plan metadata.

Link to this function

get_backup_plan_from_json(client, input, options \\ [])

View Source

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

Link to this function

get_backup_plan_from_template(client, backup_plan_template_id, options \\ [])

View Source

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

Link to this function

get_backup_selection(client, backup_plan_id, selection_id, options \\ [])

View Source

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

Link to this function

get_backup_vault_access_policy(client, backup_vault_name, options \\ [])

View Source

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

Link to this function

get_backup_vault_notifications(client, backup_vault_name, options \\ [])

View Source

Returns event notifications for the specified backup vault.

Link to this function

get_recovery_point_restore_metadata(client, backup_vault_name, recovery_point_arn, backup_vault_account_id \\ nil, options \\ [])

View Source

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

Link to this function

get_restore_job_metadata(client, restore_job_id, options \\ [])

View Source

This request returns the metadata for the specified restore job.

Link to this function

get_restore_testing_inferred_metadata(client, backup_vault_account_id \\ nil, backup_vault_name, recovery_point_arn, options \\ [])

View Source

This request returns the minimal required set of metadata needed to start a restore job with secure default settings.

BackupVaultName and RecoveryPointArn are required parameters. BackupVaultAccountId is an optional parameter.

Link to this function

get_restore_testing_plan(client, restore_testing_plan_name, options \\ [])

View Source

Returns RestoreTestingPlan details for the specified RestoreTestingPlanName.

The details are the body of a restore testing plan in JSON format, in addition to plan metadata.

Link to this function

get_restore_testing_selection(client, restore_testing_plan_name, restore_testing_selection_name, options \\ [])

View Source

Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.

Link to this function

get_supported_resource_types(client, options \\ [])

View Source

Returns the Amazon Web Services resource types supported by Backup.

Link to this function

list_backup_job_summaries(client, account_id \\ nil, aggregation_period \\ nil, max_results \\ nil, message_category \\ nil, next_token \\ nil, resource_type \\ nil, state \\ nil, options \\ [])

View Source

This is a request for a summary of backup jobs created or running within the most recent 30 days.

You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.

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

Link to this function

list_backup_jobs(client, by_account_id \\ nil, by_backup_vault_name \\ nil, by_complete_after \\ nil, by_complete_before \\ nil, by_created_after \\ nil, by_created_before \\ nil, by_message_category \\ nil, by_parent_job_id \\ nil, by_resource_arn \\ nil, by_resource_type \\ nil, by_state \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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.

Link to this function

list_backup_plan_templates(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the backup plan templates.

Link to this function

list_backup_plan_versions(client, backup_plan_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_backup_plans(client, include_deleted \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the active backup plans for the account.

Link to this function

list_backup_selections(client, backup_plan_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_backup_vaults(client, by_shared \\ nil, by_vault_type \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_copy_job_summaries(client, account_id \\ nil, aggregation_period \\ nil, max_results \\ nil, message_category \\ nil, next_token \\ nil, resource_type \\ nil, state \\ nil, options \\ [])

View Source

This request obtains a list of copy jobs created or running within the the most recent 30 days.

You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.

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

Link to this function

list_copy_jobs(client, by_account_id \\ nil, by_complete_after \\ nil, by_complete_before \\ nil, by_created_after \\ nil, by_created_before \\ nil, by_destination_vault_arn \\ nil, by_message_category \\ nil, by_parent_job_id \\ nil, by_resource_arn \\ nil, by_resource_type \\ nil, by_state \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns metadata about your copy jobs.

Link to this function

list_frameworks(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_protected_resources(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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.

Link to this function

list_protected_resources_by_backup_vault(client, backup_vault_name, backup_vault_account_id \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

This request lists the protected resources corresponding to each backup vault.

Link to this function

list_recovery_points_by_backup_vault(client, backup_vault_name, backup_vault_account_id \\ nil, by_backup_plan_id \\ nil, by_created_after \\ nil, by_created_before \\ nil, by_parent_recovery_point_arn \\ nil, by_resource_arn \\ nil, by_resource_type \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_recovery_points_by_resource(client, resource_arn, managed_by_aws_backup_only \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

The information about 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.

Link to this function

list_report_jobs(client, by_creation_after \\ nil, by_creation_before \\ nil, by_report_plan_name \\ nil, by_status \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns details about your report jobs.

Link to this function

list_report_plans(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of your report plans.

For detailed information about a single report plan, use DescribeReportPlan.

Link to this function

list_restore_job_summaries(client, account_id \\ nil, aggregation_period \\ nil, max_results \\ nil, next_token \\ nil, resource_type \\ nil, state \\ nil, options \\ [])

View Source

This request obtains a summary of restore jobs created or running within the the most recent 30 days.

You can include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results.

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

Link to this function

list_restore_jobs(client, by_account_id \\ nil, by_complete_after \\ nil, by_complete_before \\ nil, by_created_after \\ nil, by_created_before \\ nil, by_resource_type \\ nil, by_restore_testing_plan_arn \\ nil, by_status \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_restore_jobs_by_protected_resource(client, resource_arn, by_recovery_point_creation_date_after \\ nil, by_recovery_point_creation_date_before \\ nil, by_status \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

This returns restore jobs that contain the specified protected resource.

You must include ResourceArn. You can optionally include NextToken, ByStatus, MaxResults, ByRecoveryPointCreationDateAfter , and ByRecoveryPointCreationDateBefore.

Link to this function

list_restore_testing_plans(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of restore testing plans.

Link to this function

list_restore_testing_selections(client, restore_testing_plan_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of restore testing selections.

Can be filtered by MaxResults and RestoreTestingPlanName.

Link to this function

list_tags(client, resource_arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault.

Link to this function

metadata()

View Source
Link to this function

put_backup_vault_access_policy(client, backup_vault_name, input, options \\ [])

View Source

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.

Link to this function

put_backup_vault_lock_configuration(client, backup_vault_name, input, options \\ [])

View Source

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 been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment.

For more information, see Backup Vault Lock.

Link to this function

put_backup_vault_notifications(client, backup_vault_name, input, options \\ [])

View Source

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

Link to this function

put_restore_validation_result(client, restore_job_id, input, options \\ [])

View Source

This request allows you to send your independent self-run restore test validation results.

RestoreJobId and ValidationStatus are required. Optionally, you can input a ValidationStatusMessage.

Link to this function

start_backup_job(client, input, options \\ [])

View Source

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

Link to this function

start_copy_job(client, input, options \\ [])

View Source

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

Does not support continuous backups.

Link to this function

start_report_job(client, report_plan_name, input, options \\ [])

View Source

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

Link to this function

start_restore_job(client, input, options \\ [])

View Source

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

Link to this function

stop_backup_job(client, backup_job_id, input, options \\ [])

View Source

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, Amazon FSx for NetApp ONTAP, Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

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

This API is supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon RDS.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

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

This API is not supported for recovery points for resource types including Aurora, Amazon DocumentDB.

Amazon EBS, Amazon FSx, Neptune, and Amazon RDS.

Link to this function

update_backup_plan(client, backup_plan_id, input, options \\ [])

View Source

Updates the specified backup plan.

The new version is uniquely identified by its ID.

Link to this function

update_framework(client, framework_name, input, options \\ [])

View Source

Updates the specified framework.

Link to this function

update_global_settings(client, input, options \\ [])

View Source

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.

Link to this function

update_recovery_point_lifecycle(client, backup_vault_name, recovery_point_arn, input, options \\ [])

View Source

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.

Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

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.

If your lifecycle currently uses the parameters DeleteAfterDays and MoveToColdStorageAfterDays, include these parameters and their values when you call this operation. Not including them may result in your plan updating with null values.

This operation does not support continuous backups.

Link to this function

update_region_settings(client, input, options \\ [])

View Source

Updates the current service opt-in settings for the Region.

Use the DescribeRegionSettings API to determine the resource types that are supported.

Link to this function

update_report_plan(client, report_plan_name, input, options \\ [])

View Source

Updates the specified report plan.

Link to this function

update_restore_testing_plan(client, restore_testing_plan_name, input, options \\ [])

View Source

This request will send changes to your specified restore testing plan.

RestoreTestingPlanName cannot be updated after it is created.

RecoveryPointSelection can contain:

*

Algorithm

*

ExcludeVaults

*

IncludeVaults

*

RecoveryPointTypes

*

SelectionWindowDays

Link to this function

update_restore_testing_selection(client, restore_testing_plan_name, restore_testing_selection_name, input, options \\ [])

View Source

Updates the specified restore testing selection.

Most elements except the RestoreTestingSelectionName can be updated with this request.

You can use either protected resource ARNs or conditions, but not both.