Class: Aws::Backup::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Backup::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb
Overview
An API client for Backup. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Backup::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_backup_plan(params = {}) ⇒ Types::CreateBackupPlanOutput
Creates a backup plan using a backup plan name and backup rules.
-
#create_backup_selection(params = {}) ⇒ Types::CreateBackupSelectionOutput
Creates a JSON document that specifies a set of resources to assign to a backup plan.
-
#create_backup_vault(params = {}) ⇒ Types::CreateBackupVaultOutput
Creates a logical container where backups are stored.
-
#delete_backup_plan(params = {}) ⇒ Types::DeleteBackupPlanOutput
Deletes a backup plan.
-
#delete_backup_selection(params = {}) ⇒ Struct
Deletes the resource selection associated with a backup plan that is specified by the
SelectionId
. -
#delete_backup_vault(params = {}) ⇒ Struct
Deletes the backup vault identified by its name.
-
#delete_backup_vault_access_policy(params = {}) ⇒ Struct
Deletes the policy document that manages permissions on a backup vault.
-
#delete_backup_vault_notifications(params = {}) ⇒ Struct
Deletes event notifications for the specified backup vault.
-
#delete_recovery_point(params = {}) ⇒ Struct
Deletes the recovery point specified by a recovery point ID.
-
#describe_backup_job(params = {}) ⇒ Types::DescribeBackupJobOutput
Returns backup job details for the specified
BackupJobId
. -
#describe_backup_vault(params = {}) ⇒ Types::DescribeBackupVaultOutput
Returns metadata about a backup vault specified by its name.
-
#describe_copy_job(params = {}) ⇒ Types::DescribeCopyJobOutput
Returns metadata associated with creating a copy of a resource.
-
#describe_global_settings(params = {}) ⇒ Types::DescribeGlobalSettingsOutput
Describes the global settings of the AWS account, including whether it is opted in to cross-account backup.
-
#describe_protected_resource(params = {}) ⇒ Types::DescribeProtectedResourceOutput
Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource.
-
#describe_recovery_point(params = {}) ⇒ Types::DescribeRecoveryPointOutput
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
-
#describe_region_settings(params = {}) ⇒ Types::DescribeRegionSettingsOutput
Returns the current service opt-in settings for the Region.
-
#describe_restore_job(params = {}) ⇒ Types::DescribeRestoreJobOutput
Returns metadata associated with a restore job that is specified by a job ID.
-
#disassociate_recovery_point(params = {}) ⇒ Struct
Deletes the specified continuous backup recovery point from AWS Backup and releases control of that continuous backup to the source service, such as Amazon RDS.
-
#export_backup_plan_template(params = {}) ⇒ Types::ExportBackupPlanTemplateOutput
Returns the backup plan that is specified by the plan ID as a backup template.
-
#get_backup_plan(params = {}) ⇒ Types::GetBackupPlanOutput
Returns
BackupPlan
details for the specifiedBackupPlanId
. -
#get_backup_plan_from_json(params = {}) ⇒ Types::GetBackupPlanFromJSONOutput
Returns a valid JSON document specifying a backup plan or an error.
-
#get_backup_plan_from_template(params = {}) ⇒ Types::GetBackupPlanFromTemplateOutput
Returns the template specified by its
templateId
as a backup plan. -
#get_backup_selection(params = {}) ⇒ Types::GetBackupSelectionOutput
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(params = {}) ⇒ Types::GetBackupVaultAccessPolicyOutput
Returns the access policy document that is associated with the named backup vault.
-
#get_backup_vault_notifications(params = {}) ⇒ Types::GetBackupVaultNotificationsOutput
Returns event notifications for the specified backup vault.
-
#get_recovery_point_restore_metadata(params = {}) ⇒ Types::GetRecoveryPointRestoreMetadataOutput
Returns a set of metadata key-value pairs that were used to create the backup.
-
#get_supported_resource_types(params = {}) ⇒ Types::GetSupportedResourceTypesOutput
Returns the AWS resource types supported by AWS Backup.
-
#list_backup_jobs(params = {}) ⇒ Types::ListBackupJobsOutput
Returns a list of existing backup jobs for an authenticated account for the last 30 days.
-
#list_backup_plan_templates(params = {}) ⇒ Types::ListBackupPlanTemplatesOutput
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
-
#list_backup_plan_versions(params = {}) ⇒ Types::ListBackupPlanVersionsOutput
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(params = {}) ⇒ Types::ListBackupPlansOutput
Returns a list of existing backup plans for an authenticated account.
-
#list_backup_selections(params = {}) ⇒ Types::ListBackupSelectionsOutput
Returns an array containing metadata of the resources associated with the target backup plan.
-
#list_backup_vaults(params = {}) ⇒ Types::ListBackupVaultsOutput
Returns a list of recovery point storage containers along with information about them.
-
#list_copy_jobs(params = {}) ⇒ Types::ListCopyJobsOutput
Returns metadata about your copy jobs.
-
#list_protected_resources(params = {}) ⇒ Types::ListProtectedResourcesOutput
Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
-
#list_recovery_points_by_backup_vault(params = {}) ⇒ Types::ListRecoveryPointsByBackupVaultOutput
Returns detailed information about the recovery points stored in a backup vault.
-
#list_recovery_points_by_resource(params = {}) ⇒ Types::ListRecoveryPointsByResourceOutput
Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).
-
#list_restore_jobs(params = {}) ⇒ Types::ListRestoreJobsOutput
Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.
-
#list_tags(params = {}) ⇒ Types::ListTagsOutput
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
-
#put_backup_vault_access_policy(params = {}) ⇒ Struct
Sets a resource-based policy that is used to manage access permissions on the target backup vault.
-
#put_backup_vault_notifications(params = {}) ⇒ Struct
Turns on notifications on a backup vault for the specified topic and events.
-
#start_backup_job(params = {}) ⇒ Types::StartBackupJobOutput
Starts an on-demand backup job for the specified resource.
-
#start_copy_job(params = {}) ⇒ Types::StartCopyJobOutput
Starts a job to create a one-time copy of the specified resource.
-
#start_restore_job(params = {}) ⇒ Types::StartRestoreJobOutput
Recovers the saved resource identified by an Amazon Resource Name (ARN).
-
#stop_backup_job(params = {}) ⇒ Struct
Attempts to cancel a job to create a one-time backup of a resource.
-
#tag_resource(params = {}) ⇒ Struct
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(params = {}) ⇒ Struct
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(params = {}) ⇒ Types::UpdateBackupPlanOutput
Updates an existing backup plan identified by its
backupPlanId
with the input document in JSON format. -
#update_global_settings(params = {}) ⇒ Struct
Updates the current global settings for the AWS account.
-
#update_recovery_point_lifecycle(params = {}) ⇒ Types::UpdateRecoveryPointLifecycleOutput
Sets the transition lifecycle of a recovery point.
-
#update_region_settings(params = {}) ⇒ Struct
Updates the current service opt-in settings for the Region.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
324 325 326 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#create_backup_plan(params = {}) ⇒ Types::CreateBackupPlanOutput
Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that AWS Backup uses to schedule tasks that create recovery points for resources.
If you call CreateBackupPlan
with a plan that already exists, an
AlreadyExistsException
is returned.
421 422 423 424 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 421 def create_backup_plan(params = {}, = {}) req = build_request(:create_backup_plan, params) req.send_request() end |
#create_backup_selection(params = {}) ⇒ Types::CreateBackupSelectionOutput
Creates a JSON document that specifies a set of resources to assign to
a backup plan. Resources can be included by specifying patterns for a
ListOfTags
and selected Resources
.
For example, consider the following patterns:
Resources: "arn:aws:ec2:region:account-id:volume/volume-id"
ConditionKey:"department"
ConditionValue:"finance"
ConditionType:"StringEquals"
ConditionKey:"importance"
ConditionValue:"critical"
ConditionType:"StringEquals"
Using these patterns would back up all Amazon Elastic Block Store
(Amazon EBS) volumes that are tagged as "department=finance"
,
"importance=critical"
, in addition to an EBS volume with the
specified volume ID.
Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically put together using the OR operator. In other words, all patterns that match are selected for backup.
504 505 506 507 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 504 def create_backup_selection(params = {}, = {}) req = build_request(:create_backup_selection, params) req.send_request() end |
#create_backup_vault(params = {}) ⇒ Types::CreateBackupVaultOutput
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.
564 565 566 567 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 564 def create_backup_vault(params = {}, = {}) req = build_request(:create_backup_vault, params) req.send_request() end |
#delete_backup_plan(params = {}) ⇒ Types::DeleteBackupPlanOutput
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.
601 602 603 604 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 601 def delete_backup_plan(params = {}, = {}) req = build_request(:delete_backup_plan, params) req.send_request() end |
#delete_backup_selection(params = {}) ⇒ Struct
Deletes the resource selection associated with a backup plan that is
specified by the SelectionId
.
629 630 631 632 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 629 def delete_backup_selection(params = {}, = {}) req = build_request(:delete_backup_selection, params) req.send_request() end |
#delete_backup_vault(params = {}) ⇒ Struct
Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
655 656 657 658 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 655 def delete_backup_vault(params = {}, = {}) req = build_request(:delete_backup_vault, params) req.send_request() end |
#delete_backup_vault_access_policy(params = {}) ⇒ Struct
Deletes the policy document that manages permissions on a backup vault.
681 682 683 684 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 681 def delete_backup_vault_access_policy(params = {}, = {}) req = build_request(:delete_backup_vault_access_policy, params) req.send_request() end |
#delete_backup_vault_notifications(params = {}) ⇒ Struct
Deletes event notifications for the specified backup vault.
706 707 708 709 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 706 def delete_backup_vault_notifications(params = {}, = {}) req = build_request(:delete_backup_vault_notifications, params) req.send_request() end |
#delete_recovery_point(params = {}) ⇒ Struct
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.
741 742 743 744 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 741 def delete_recovery_point(params = {}, = {}) req = build_request(:delete_recovery_point, params) req.send_request() end |
#describe_backup_job(params = {}) ⇒ Types::DescribeBackupJobOutput
Returns backup job details for the specified BackupJobId
.
811 812 813 814 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 811 def describe_backup_job(params = {}, = {}) req = build_request(:describe_backup_job, params) req.send_request() end |
#describe_backup_vault(params = {}) ⇒ Types::DescribeBackupVaultOutput
Returns metadata about a backup vault specified by its name.
852 853 854 855 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 852 def describe_backup_vault(params = {}, = {}) req = build_request(:describe_backup_vault, params) req.send_request() end |
#describe_copy_job(params = {}) ⇒ Types::DescribeCopyJobOutput
Returns metadata associated with creating a copy of a resource.
897 898 899 900 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 897 def describe_copy_job(params = {}, = {}) req = build_request(:describe_copy_job, params) req.send_request() end |
#describe_global_settings(params = {}) ⇒ Types::DescribeGlobalSettingsOutput
Describes the global settings of the AWS account, including whether it is opted in to cross-account backup.
920 921 922 923 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 920 def describe_global_settings(params = {}, = {}) req = build_request(:describe_global_settings, params) req.send_request() end |
#describe_protected_resource(params = {}) ⇒ Types::DescribeProtectedResourceOutput
Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource.
955 956 957 958 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 955 def describe_protected_resource(params = {}, = {}) req = build_request(:describe_protected_resource, params) req.send_request() end |
#describe_recovery_point(params = {}) ⇒ Types::DescribeRecoveryPointOutput
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
1032 1033 1034 1035 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1032 def describe_recovery_point(params = {}, = {}) req = build_request(:describe_recovery_point, params) req.send_request() end |
#describe_region_settings(params = {}) ⇒ Types::DescribeRegionSettingsOutput
Returns the current service opt-in settings for the Region. If service-opt-in is enabled for a service, AWS 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, AWS Backup does not try to protect that service's resources in this Region, AWS Backup does not try to protect that service's resources in this Region.
1058 1059 1060 1061 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1058 def describe_region_settings(params = {}, = {}) req = build_request(:describe_region_settings, params) req.send_request() end |
#describe_restore_job(params = {}) ⇒ Types::DescribeRestoreJobOutput
Returns metadata associated with a restore job that is specified by a job ID.
1111 1112 1113 1114 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1111 def describe_restore_job(params = {}, = {}) req = build_request(:describe_restore_job, params) req.send_request() end |
#disassociate_recovery_point(params = {}) ⇒ Struct
Deletes the specified continuous backup recovery point from AWS 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.
1144 1145 1146 1147 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1144 def disassociate_recovery_point(params = {}, = {}) req = build_request(:disassociate_recovery_point, params) req.send_request() end |
#export_backup_plan_template(params = {}) ⇒ Types::ExportBackupPlanTemplateOutput
Returns the backup plan that is specified by the plan ID as a backup template.
1173 1174 1175 1176 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1173 def export_backup_plan_template(params = {}, = {}) req = build_request(:export_backup_plan_template, params) req.send_request() end |
#get_backup_plan(params = {}) ⇒ Types::GetBackupPlanOutput
Returns BackupPlan
details for the specified BackupPlanId
. The
details are the body of a backup plan in JSON format, in addition to
plan metadata.
1247 1248 1249 1250 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1247 def get_backup_plan(params = {}, = {}) req = build_request(:get_backup_plan, params) req.send_request() end |
#get_backup_plan_from_json(params = {}) ⇒ Types::GetBackupPlanFromJSONOutput
Returns a valid JSON document specifying a backup plan or an error.
1295 1296 1297 1298 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1295 def get_backup_plan_from_json(params = {}, = {}) req = build_request(:get_backup_plan_from_json, params) req.send_request() end |
#get_backup_plan_from_template(params = {}) ⇒ Types::GetBackupPlanFromTemplateOutput
Returns the template specified by its templateId
as a backup plan.
1343 1344 1345 1346 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1343 def get_backup_plan_from_template(params = {}, = {}) req = build_request(:get_backup_plan_from_template, params) req.send_request() end |
#get_backup_selection(params = {}) ⇒ Types::GetBackupSelectionOutput
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
1392 1393 1394 1395 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1392 def get_backup_selection(params = {}, = {}) req = build_request(:get_backup_selection, params) req.send_request() end |
#get_backup_vault_access_policy(params = {}) ⇒ Types::GetBackupVaultAccessPolicyOutput
Returns the access policy document that is associated with the named backup vault.
1428 1429 1430 1431 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1428 def get_backup_vault_access_policy(params = {}, = {}) req = build_request(:get_backup_vault_access_policy, params) req.send_request() end |
#get_backup_vault_notifications(params = {}) ⇒ Types::GetBackupVaultNotificationsOutput
Returns event notifications for the specified backup vault.
1466 1467 1468 1469 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1466 def get_backup_vault_notifications(params = {}, = {}) req = build_request(:get_backup_vault_notifications, params) req.send_request() end |
#get_recovery_point_restore_metadata(params = {}) ⇒ Types::GetRecoveryPointRestoreMetadataOutput
Returns a set of metadata key-value pairs that were used to create the backup.
1509 1510 1511 1512 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1509 def (params = {}, = {}) req = build_request(:get_recovery_point_restore_metadata, params) req.send_request() end |
#get_supported_resource_types(params = {}) ⇒ Types::GetSupportedResourceTypesOutput
Returns the AWS resource types supported by AWS Backup.
1529 1530 1531 1532 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1529 def get_supported_resource_types(params = {}, = {}) req = build_request(:get_supported_resource_types, params) req.send_request() end |
#list_backup_jobs(params = {}) ⇒ Types::ListBackupJobsOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1648 1649 1650 1651 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1648 def list_backup_jobs(params = {}, = {}) req = build_request(:list_backup_jobs, params) req.send_request() end |
#list_backup_plan_templates(params = {}) ⇒ Types::ListBackupPlanTemplatesOutput
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1690 1691 1692 1693 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1690 def list_backup_plan_templates(params = {}, = {}) req = build_request(:list_backup_plan_templates, params) req.send_request() end |
#list_backup_plan_versions(params = {}) ⇒ Types::ListBackupPlanVersionsOutput
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1747 1748 1749 1750 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1747 def list_backup_plan_versions(params = {}, = {}) req = build_request(:list_backup_plan_versions, params) req.send_request() end |
#list_backup_plans(params = {}) ⇒ Types::ListBackupPlansOutput
Returns a list of existing backup plans for an authenticated account. The list is populated only if the advanced option is set for the backup plan. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1807 1808 1809 1810 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1807 def list_backup_plans(params = {}, = {}) req = build_request(:list_backup_plans, params) req.send_request() end |
#list_backup_selections(params = {}) ⇒ Types::ListBackupSelectionsOutput
Returns an array containing metadata of the resources associated with the target backup plan.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1857 1858 1859 1860 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1857 def list_backup_selections(params = {}, = {}) req = build_request(:list_backup_selections, params) req.send_request() end |
#list_backup_vaults(params = {}) ⇒ Types::ListBackupVaultsOutput
Returns a list of recovery point storage containers along with information about them.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1903 1904 1905 1906 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1903 def list_backup_vaults(params = {}, = {}) req = build_request(:list_backup_vaults, params) req.send_request() end |
#list_copy_jobs(params = {}) ⇒ Types::ListCopyJobsOutput
Returns metadata about your copy jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2006 2007 2008 2009 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2006 def list_copy_jobs(params = {}, = {}) req = build_request(:list_copy_jobs, params) req.send_request() end |
#list_protected_resources(params = {}) ⇒ Types::ListProtectedResourcesOutput
Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2050 2051 2052 2053 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2050 def list_protected_resources(params = {}, = {}) req = build_request(:list_protected_resources, params) req.send_request() end |
#list_recovery_points_by_backup_vault(params = {}) ⇒ Types::ListRecoveryPointsByBackupVaultOutput
Returns detailed information about the recovery points stored in a backup vault.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2142 2143 2144 2145 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2142 def list_recovery_points_by_backup_vault(params = {}, = {}) req = build_request(:list_recovery_points_by_backup_vault, params) req.send_request() end |
#list_recovery_points_by_resource(params = {}) ⇒ Types::ListRecoveryPointsByResourceOutput
Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2193 2194 2195 2196 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2193 def list_recovery_points_by_resource(params = {}, = {}) req = build_request(:list_recovery_points_by_resource, params) req.send_request() end |
#list_restore_jobs(params = {}) ⇒ Types::ListRestoreJobsOutput
Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2263 2264 2265 2266 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2263 def list_restore_jobs(params = {}, = {}) req = build_request(:list_restore_jobs, params) req.send_request() end |
#list_tags(params = {}) ⇒ Types::ListTagsOutput
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
ListTags
are currently only supported with Amazon EFS backups.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2314 2315 2316 2317 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2314 def (params = {}, = {}) req = build_request(:list_tags, params) req.send_request() end |
#put_backup_vault_access_policy(params = {}) ⇒ Struct
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.
2345 2346 2347 2348 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2345 def put_backup_vault_access_policy(params = {}, = {}) req = build_request(:put_backup_vault_access_policy, params) req.send_request() end |
#put_backup_vault_notifications(params = {}) ⇒ Struct
Turns on notifications on a backup vault for the specified topic and events.
2382 2383 2384 2385 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2382 def put_backup_vault_notifications(params = {}, = {}) req = build_request(:put_backup_vault_notifications, params) req.send_request() end |
#start_backup_job(params = {}) ⇒ Types::StartBackupJobOutput
Starts an on-demand backup job for the specified resource.
2484 2485 2486 2487 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2484 def start_backup_job(params = {}, = {}) req = build_request(:start_backup_job, params) req.send_request() end |
#start_copy_job(params = {}) ⇒ Types::StartCopyJobOutput
Starts a job to create a one-time copy of the specified resource.
Does not support continuous backups.
2558 2559 2560 2561 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2558 def start_copy_job(params = {}, = {}) req = build_request(:start_copy_job, params) req.send_request() end |
#start_restore_job(params = {}) ⇒ Types::StartRestoreJobOutput
Recovers the saved resource identified by an Amazon Resource Name (ARN).
2663 2664 2665 2666 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2663 def start_restore_job(params = {}, = {}) req = build_request(:start_restore_job, params) req.send_request() end |
#stop_backup_job(params = {}) ⇒ Struct
Attempts to cancel a job to create a one-time backup of a resource.
2685 2686 2687 2688 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2685 def stop_backup_job(params = {}, = {}) req = build_request(:stop_backup_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
2716 2717 2718 2719 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2716 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
2745 2746 2747 2748 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2745 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_backup_plan(params = {}) ⇒ Types::UpdateBackupPlanOutput
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
.
2827 2828 2829 2830 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2827 def update_backup_plan(params = {}, = {}) req = build_request(:update_backup_plan, params) req.send_request() end |
#update_global_settings(params = {}) ⇒ Struct
Updates the current global settings for the AWS account. Use the
DescribeGlobalSettings
API to determine the current settings.
2852 2853 2854 2855 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2852 def update_global_settings(params = {}, = {}) req = build_request(:update_global_settings, params) req.send_request() end |
#update_recovery_point_lifecycle(params = {}) ⇒ Types::UpdateRecoveryPointLifecycleOutput
Sets the transition lifecycle of a recovery point.
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Only Amazon EFS file system backups can be transitioned to cold storage.
Does not support continuous backups.
2927 2928 2929 2930 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2927 def update_recovery_point_lifecycle(params = {}, = {}) req = build_request(:update_recovery_point_lifecycle, params) req.send_request() end |
#update_region_settings(params = {}) ⇒ Struct
Updates the current service opt-in settings for the Region. If
service-opt-in is enabled for a service, AWS 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,
AWS 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.
2958 2959 2960 2961 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2958 def update_region_settings(params = {}, = {}) req = build_request(:update_region_settings, params) req.send_request() end |