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.
-
#create_framework(params = {}) ⇒ Types::CreateFrameworkOutput
Creates a framework with one or more controls.
-
#create_report_plan(params = {}) ⇒ Types::CreateReportPlanOutput
Creates a report plan.
-
#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_lock_configuration(params = {}) ⇒ Struct
Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
-
#delete_backup_vault_notifications(params = {}) ⇒ Struct
Deletes event notifications for the specified backup vault.
-
#delete_framework(params = {}) ⇒ Struct
Deletes the framework specified by a framework name.
-
#delete_recovery_point(params = {}) ⇒ Struct
Deletes the recovery point specified by a recovery point ID.
-
#delete_report_plan(params = {}) ⇒ Struct
Deletes the report plan specified by a report plan name.
-
#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_framework(params = {}) ⇒ Types::DescribeFrameworkOutput
Returns the framework details for the specified
FrameworkName
. -
#describe_global_settings(params = {}) ⇒ Types::DescribeGlobalSettingsOutput
Describes whether the Amazon Web Services account 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 Amazon Web Services 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_report_job(params = {}) ⇒ Types::DescribeReportJobOutput
Returns the details associated with creating a report as specified by its
ReportJobId
. -
#describe_report_plan(params = {}) ⇒ Types::DescribeReportPlanOutput
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services 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 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 Amazon Web Services resource types supported by 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 all active 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_frameworks(params = {}) ⇒ Types::ListFrameworksOutput
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
-
#list_protected_resources(params = {}) ⇒ Types::ListProtectedResourcesOutput
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_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 all the recovery points of the type specified by a resource Amazon Resource Name (ARN).
-
#list_report_jobs(params = {}) ⇒ Types::ListReportJobsOutput
Returns details about your report jobs.
-
#list_report_plans(params = {}) ⇒ Types::ListReportPlansOutput
Returns a list of your report plans.
-
#list_restore_jobs(params = {}) ⇒ Types::ListRestoreJobsOutput
Returns a list of jobs that Backup initiated to restore a saved resource, including details 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_lock_configuration(params = {}) ⇒ Struct
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(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_report_job(params = {}) ⇒ Types::StartReportJobOutput
Starts an on-demand report job for the specified report plan.
-
#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_framework(params = {}) ⇒ Types::UpdateFrameworkOutput
Updates an existing framework identified by its
FrameworkName
with the input document in JSON format. -
#update_global_settings(params = {}) ⇒ Struct
Updates whether the Amazon Web Services account is opted in to cross-account backup.
-
#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.
-
#update_report_plan(params = {}) ⇒ Types::UpdateReportPlanOutput
Updates an existing report plan identified by its
ReportPlanName
with the input document in JSON format.
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.
348 349 350 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 348 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 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.
448 449 450 451 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 448 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. For examples, see Assigning resources programmatically.
539 540 541 542 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 539 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.
603 604 605 606 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 603 def create_backup_vault(params = {}, = {}) req = build_request(:create_backup_vault, params) req.send_request() end |
#create_framework(params = {}) ⇒ Types::CreateFrameworkOutput
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.
683 684 685 686 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 683 def create_framework(params = {}, = {}) req = build_request(:create_framework, params) req.send_request() end |
#create_report_plan(params = {}) ⇒ Types::CreateReportPlanOutput
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.
770 771 772 773 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 770 def create_report_plan(params = {}, = {}) req = build_request(:create_report_plan, 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.
807 808 809 810 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 807 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
.
835 836 837 838 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 835 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.
861 862 863 864 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 861 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.
887 888 889 890 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 887 def delete_backup_vault_access_policy(params = {}, = {}) req = build_request(:delete_backup_vault_access_policy, params) req.send_request() end |
#delete_backup_vault_lock_configuration(params = {}) ⇒ Struct
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.
919 920 921 922 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 919 def delete_backup_vault_lock_configuration(params = {}, = {}) req = build_request(:delete_backup_vault_lock_configuration, params) req.send_request() end |
#delete_backup_vault_notifications(params = {}) ⇒ Struct
Deletes event notifications for the specified backup vault.
944 945 946 947 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 944 def delete_backup_vault_notifications(params = {}, = {}) req = build_request(:delete_backup_vault_notifications, params) req.send_request() end |
#delete_framework(params = {}) ⇒ Struct
Deletes the framework specified by a framework name.
966 967 968 969 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 966 def delete_framework(params = {}, = {}) req = build_request(:delete_framework, 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.
1001 1002 1003 1004 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1001 def delete_recovery_point(params = {}, = {}) req = build_request(:delete_recovery_point, params) req.send_request() end |
#delete_report_plan(params = {}) ⇒ Struct
Deletes the report plan specified by a report plan name.
1023 1024 1025 1026 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1023 def delete_report_plan(params = {}, = {}) req = build_request(:delete_report_plan, params) req.send_request() end |
#describe_backup_job(params = {}) ⇒ Types::DescribeBackupJobOutput
Returns backup job details for the specified BackupJobId
.
1093 1094 1095 1096 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1093 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.
1142 1143 1144 1145 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1142 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.
1187 1188 1189 1190 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1187 def describe_copy_job(params = {}, = {}) req = build_request(:describe_copy_job, params) req.send_request() end |
#describe_framework(params = {}) ⇒ Types::DescribeFrameworkOutput
Returns the framework details for the specified FrameworkName
.
1239 1240 1241 1242 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1239 def describe_framework(params = {}, = {}) req = build_request(:describe_framework, params) req.send_request() end |
#describe_global_settings(params = {}) ⇒ Types::DescribeGlobalSettingsOutput
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
1264 1265 1266 1267 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1264 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 Amazon Web Services service type of the saved resource.
1299 1300 1301 1302 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1299 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.
1378 1379 1380 1381 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1378 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, 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.
1405 1406 1407 1408 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1405 def describe_region_settings(params = {}, = {}) req = build_request(:describe_region_settings, params) req.send_request() end |
#describe_report_job(params = {}) ⇒ Types::DescribeReportJobOutput
Returns the details associated with creating a report as specified by
its ReportJobId
.
1445 1446 1447 1448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1445 def describe_report_job(params = {}, = {}) req = build_request(:describe_report_job, params) req.send_request() end |
#describe_report_plan(params = {}) ⇒ Types::DescribeReportPlanOutput
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
1488 1489 1490 1491 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1488 def describe_report_plan(params = {}, = {}) req = build_request(:describe_report_plan, 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.
1541 1542 1543 1544 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1541 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 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.
1574 1575 1576 1577 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1574 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.
1603 1604 1605 1606 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1603 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.
1677 1678 1679 1680 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1677 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.
1725 1726 1727 1728 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1725 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.
1773 1774 1775 1776 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1773 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.
1836 1837 1838 1839 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1836 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.
1872 1873 1874 1875 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1872 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.
1910 1911 1912 1913 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1910 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.
1953 1954 1955 1956 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1953 def (params = {}, = {}) req = build_request(:get_recovery_point_restore_metadata, params) req.send_request() end |
#get_supported_resource_types(params = {}) ⇒ Types::GetSupportedResourceTypesOutput
Returns the Amazon Web Services resource types supported by Backup.
1973 1974 1975 1976 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1973 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.
2113 2114 2115 2116 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2113 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.
2155 2156 2157 2158 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2155 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.
2212 2213 2214 2215 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2212 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 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2271 2272 2273 2274 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2271 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.
2321 2322 2323 2324 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2321 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.
2371 2372 2373 2374 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2371 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.
2494 2495 2496 2497 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2494 def list_copy_jobs(params = {}, = {}) req = build_request(:list_copy_jobs, params) req.send_request() end |
#list_frameworks(params = {}) ⇒ Types::ListFrameworksOutput
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2540 2541 2542 2543 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2540 def list_frameworks(params = {}, = {}) req = build_request(:list_frameworks, params) req.send_request() end |
#list_protected_resources(params = {}) ⇒ Types::ListProtectedResourcesOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2584 2585 2586 2587 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2584 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.
2682 2683 2684 2685 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2682 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 all the 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.
2743 2744 2745 2746 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2743 def list_recovery_points_by_resource(params = {}, = {}) req = build_request(:list_recovery_points_by_resource, params) req.send_request() end |
#list_report_jobs(params = {}) ⇒ Types::ListReportJobsOutput
Returns details about your report jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2817 2818 2819 2820 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2817 def list_report_jobs(params = {}, = {}) req = build_request(:list_report_jobs, params) req.send_request() end |
#list_report_plans(params = {}) ⇒ Types::ListReportPlansOutput
Returns a list of your report plans. For detailed information about a
single report plan, use DescribeReportPlan
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2872 2873 2874 2875 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2872 def list_report_plans(params = {}, = {}) req = build_request(:list_report_plans, params) req.send_request() end |
#list_restore_jobs(params = {}) ⇒ Types::ListRestoreJobsOutput
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2952 2953 2954 2955 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2952 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
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3008 3009 3010 3011 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3008 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.
3039 3040 3041 3042 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3039 def put_backup_vault_access_policy(params = {}, = {}) req = build_request(:put_backup_vault_access_policy, params) req.send_request() end |
#put_backup_vault_lock_configuration(params = {}) ⇒ Struct
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.
3138 3139 3140 3141 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3138 def put_backup_vault_lock_configuration(params = {}, = {}) req = build_request(:put_backup_vault_lock_configuration, params) req.send_request() end |
#put_backup_vault_notifications(params = {}) ⇒ Struct
Turns on notifications on a backup vault for the specified topic and events.
3198 3199 3200 3201 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3198 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.
3309 3310 3311 3312 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3309 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.
3392 3393 3394 3395 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3392 def start_copy_job(params = {}, = {}) req = build_request(:start_copy_job, params) req.send_request() end |
#start_report_job(params = {}) ⇒ Types::StartReportJobOutput
Starts an on-demand report job for the specified report plan.
3430 3431 3432 3433 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3430 def start_report_job(params = {}, = {}) req = build_request(:start_report_job, params) req.send_request() end |
#start_restore_job(params = {}) ⇒ Types::StartRestoreJobOutput
Recovers the saved resource identified by an Amazon Resource Name (ARN).
3545 3546 3547 3548 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3545 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.
3567 3568 3569 3570 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3567 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).
3600 3601 3602 3603 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3600 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)
3629 3630 3631 3632 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3629 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
.
3711 3712 3713 3714 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3711 def update_backup_plan(params = {}, = {}) req = build_request(:update_backup_plan, params) req.send_request() end |
#update_framework(params = {}) ⇒ Types::UpdateFrameworkOutput
Updates an existing framework identified by its FrameworkName
with
the input document in JSON format.
3783 3784 3785 3786 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3783 def update_framework(params = {}, = {}) req = build_request(:update_framework, params) req.send_request() end |
#update_global_settings(params = {}) ⇒ Struct
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.
3812 3813 3814 3815 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3812 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. Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
This operation does not support continuous backups.
3894 3895 3896 3897 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3894 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, 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.
3939 3940 3941 3942 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3939 def update_region_settings(params = {}, = {}) req = build_request(:update_region_settings, params) req.send_request() end |
#update_report_plan(params = {}) ⇒ Types::UpdateReportPlanOutput
Updates an existing report plan identified by its ReportPlanName
with the input document in JSON format.
4015 4016 4017 4018 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4015 def update_report_plan(params = {}, = {}) req = build_request(:update_report_plan, params) req.send_request() end |