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
-
#cancel_legal_hold(params = {}) ⇒ Struct
Removes the specified legal hold on a recovery point.
-
#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_legal_hold(params = {}) ⇒ Types::CreateLegalHoldOutput
Creates a legal hold on a recovery point (backup).
-
#create_logically_air_gapped_backup_vault(params = {}) ⇒ Types::CreateLogicallyAirGappedBackupVaultOutput
Creates a logical container to where backups may be copied.
-
#create_report_plan(params = {}) ⇒ Types::CreateReportPlanOutput
Creates a report plan.
-
#create_restore_testing_plan(params = {}) ⇒ Types::CreateRestoreTestingPlanOutput
Creates a restore testing plan.
-
#create_restore_testing_selection(params = {}) ⇒ Types::CreateRestoreTestingSelectionOutput
This request can be sent after CreateRestoreTestingPlan request returns successfully.
-
#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.
-
#delete_restore_testing_plan(params = {}) ⇒ Struct
This request deletes the specified restore testing plan.
-
#delete_restore_testing_selection(params = {}) ⇒ Struct
Input the Restore Testing Plan name and Restore Testing Selection 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.
-
#disassociate_recovery_point_from_parent(params = {}) ⇒ Struct
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(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_legal_hold(params = {}) ⇒ Types::GetLegalHoldOutput
This action returns details for a specified legal hold.
-
#get_recovery_point_restore_metadata(params = {}) ⇒ Types::GetRecoveryPointRestoreMetadataOutput
Returns a set of metadata key-value pairs that were used to create the backup.
-
#get_restore_job_metadata(params = {}) ⇒ Types::GetRestoreJobMetadataOutput
This request returns the metadata for the specified restore job.
-
#get_restore_testing_inferred_metadata(params = {}) ⇒ Types::GetRestoreTestingInferredMetadataOutput
This request returns the minimal required set of metadata needed to start a restore job with secure default settings.
-
#get_restore_testing_plan(params = {}) ⇒ Types::GetRestoreTestingPlanOutput
Returns
RestoreTestingPlan
details for the specifiedRestoreTestingPlanName
. -
#get_restore_testing_selection(params = {}) ⇒ Types::GetRestoreTestingSelectionOutput
Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
-
#get_supported_resource_types(params = {}) ⇒ Types::GetSupportedResourceTypesOutput
Returns the Amazon Web Services resource types supported by Backup.
-
#list_backup_job_summaries(params = {}) ⇒ Types::ListBackupJobSummariesOutput
This is a request for a summary of backup jobs created or running within the most recent 30 days.
-
#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
Lists the backup plan templates.
-
#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
Lists the active backup plans for the 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_job_summaries(params = {}) ⇒ Types::ListCopyJobSummariesOutput
This request obtains a list of copy jobs created or running within the the most recent 30 days.
-
#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_legal_holds(params = {}) ⇒ Types::ListLegalHoldsOutput
This action returns metadata about active and previous legal holds.
-
#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_protected_resources_by_backup_vault(params = {}) ⇒ Types::ListProtectedResourcesByBackupVaultOutput
This request lists the protected resources corresponding to each backup vault.
-
#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_legal_hold(params = {}) ⇒ Types::ListRecoveryPointsByLegalHoldOutput
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
-
#list_recovery_points_by_resource(params = {}) ⇒ Types::ListRecoveryPointsByResourceOutput
The information about 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_job_summaries(params = {}) ⇒ Types::ListRestoreJobSummariesOutput
This request obtains a summary of restore jobs created or running within the the most recent 30 days.
-
#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_restore_jobs_by_protected_resource(params = {}) ⇒ Types::ListRestoreJobsByProtectedResourceOutput
This returns restore jobs that contain the specified protected resource.
-
#list_restore_testing_plans(params = {}) ⇒ Types::ListRestoreTestingPlansOutput
Returns a list of restore testing plans.
-
#list_restore_testing_selections(params = {}) ⇒ Types::ListRestoreTestingSelectionsOutput
Returns a list of restore testing selections.
-
#list_tags(params = {}) ⇒ Types::ListTagsOutput
Returns the tags assigned to the resource, such as 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.
-
#put_restore_validation_result(params = {}) ⇒ Struct
This request allows you to send your independent self-run restore test validation results.
-
#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 the specified backup plan.
-
#update_framework(params = {}) ⇒ Types::UpdateFrameworkOutput
Updates the specified framework.
-
#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 the specified report plan.
-
#update_restore_testing_plan(params = {}) ⇒ Types::UpdateRestoreTestingPlanOutput
This request will send changes to your specified restore testing plan.
-
#update_restore_testing_selection(params = {}) ⇒ Types::UpdateRestoreTestingSelectionOutput
Updates the specified restore testing selection.
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.
434 435 436 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 434 def initialize(*args) super end |
Instance Method Details
#cancel_legal_hold(params = {}) ⇒ Struct
Removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.
466 467 468 469 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 466 def cancel_legal_hold(params = {}, = {}) req = build_request(:cancel_legal_hold, params) req.send_request() end |
#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.
566 567 568 569 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 566 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.
655 656 657 658 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 655 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.
718 719 720 721 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 718 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.
797 798 799 800 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 797 def create_framework(params = {}, = {}) req = build_request(:create_framework, params) req.send_request() end |
#create_legal_hold(params = {}) ⇒ Types::CreateLegalHoldOutput
Creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.
877 878 879 880 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 877 def create_legal_hold(params = {}, = {}) req = build_request(:create_legal_hold, params) req.send_request() end |
#create_logically_air_gapped_backup_vault(params = {}) ⇒ Types::CreateLogicallyAirGappedBackupVaultOutput
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.
947 948 949 950 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 947 def create_logically_air_gapped_backup_vault(params = {}, = {}) req = build_request(:create_logically_air_gapped_backup_vault, 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.
1036 1037 1038 1039 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1036 def create_report_plan(params = {}, = {}) req = build_request(:create_report_plan, params) req.send_request() end |
#create_restore_testing_plan(params = {}) ⇒ Types::CreateRestoreTestingPlanOutput
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.
1104 1105 1106 1107 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1104 def create_restore_testing_plan(params = {}, = {}) req = build_request(:create_restore_testing_plan, params) req.send_request() end |
#create_restore_testing_selection(params = {}) ⇒ Types::CreateRestoreTestingSelectionOutput
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.
1204 1205 1206 1207 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1204 def create_restore_testing_selection(params = {}, = {}) req = build_request(:create_restore_testing_selection, 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.
1241 1242 1243 1244 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1241 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
.
1269 1270 1271 1272 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1269 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.
1294 1295 1296 1297 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1294 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.
1320 1321 1322 1323 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1320 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.
1352 1353 1354 1355 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1352 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.
1376 1377 1378 1379 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1376 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.
1398 1399 1400 1401 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1398 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.
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.
1449 1450 1451 1452 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1449 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.
1471 1472 1473 1474 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1471 def delete_report_plan(params = {}, = {}) req = build_request(:delete_report_plan, params) req.send_request() end |
#delete_restore_testing_plan(params = {}) ⇒ Struct
This request deletes the specified restore testing plan.
Deletion can only successfully occur if all associated restore testing selections are deleted first.
1496 1497 1498 1499 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1496 def delete_restore_testing_plan(params = {}, = {}) req = build_request(:delete_restore_testing_plan, params) req.send_request() end |
#delete_restore_testing_selection(params = {}) ⇒ Struct
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.
1528 1529 1530 1531 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1528 def delete_restore_testing_selection(params = {}, = {}) req = build_request(:delete_restore_testing_selection, params) req.send_request() end |
#describe_backup_job(params = {}) ⇒ Types::DescribeBackupJobOutput
Returns backup job details for the specified BackupJobId
.
1613 1614 1615 1616 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1613 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.
1669 1670 1671 1672 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1669 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.
1722 1723 1724 1725 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1722 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
.
1774 1775 1776 1777 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1774 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
1799 1800 1801 1802 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1799 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.
1846 1847 1848 1849 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1846 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.
1939 1940 1941 1942 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1939 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.
1966 1967 1968 1969 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1966 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
.
2006 2007 2008 2009 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2006 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.
2055 2056 2057 2058 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2055 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.
2120 2121 2122 2123 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2120 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.
2153 2154 2155 2156 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2153 def disassociate_recovery_point(params = {}, = {}) req = build_request(:disassociate_recovery_point, params) req.send_request() end |
#disassociate_recovery_point_from_parent(params = {}) ⇒ Struct
This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.
2186 2187 2188 2189 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2186 def disassociate_recovery_point_from_parent(params = {}, = {}) req = build_request(:disassociate_recovery_point_from_parent, 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.
2215 2216 2217 2218 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2215 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.
2292 2293 2294 2295 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2292 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.
2343 2344 2345 2346 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2343 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.
2394 2395 2396 2397 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2394 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.
2457 2458 2459 2460 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2457 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.
2492 2493 2494 2495 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2492 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.
2529 2530 2531 2532 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2529 def get_backup_vault_notifications(params = {}, = {}) req = build_request(:get_backup_vault_notifications, params) req.send_request() end |
#get_legal_hold(params = {}) ⇒ Types::GetLegalHoldOutput
This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.
2581 2582 2583 2584 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2581 def get_legal_hold(params = {}, = {}) req = build_request(:get_legal_hold, 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.
2629 2630 2631 2632 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2629 def (params = {}, = {}) req = build_request(:get_recovery_point_restore_metadata, params) req.send_request() end |
#get_restore_job_metadata(params = {}) ⇒ Types::GetRestoreJobMetadataOutput
This request returns the metadata for the specified restore job.
2660 2661 2662 2663 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2660 def (params = {}, = {}) req = build_request(:get_restore_job_metadata, params) req.send_request() end |
#get_restore_testing_inferred_metadata(params = {}) ⇒ Types::GetRestoreTestingInferredMetadataOutput
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.
2705 2706 2707 2708 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2705 def (params = {}, = {}) req = build_request(:get_restore_testing_inferred_metadata, params) req.send_request() end |
#get_restore_testing_plan(params = {}) ⇒ Types::GetRestoreTestingPlanOutput
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.
2751 2752 2753 2754 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2751 def get_restore_testing_plan(params = {}, = {}) req = build_request(:get_restore_testing_plan, params) req.send_request() end |
#get_restore_testing_selection(params = {}) ⇒ Types::GetRestoreTestingSelectionOutput
Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
2800 2801 2802 2803 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2800 def get_restore_testing_selection(params = {}, = {}) req = build_request(:get_restore_testing_selection, params) req.send_request() end |
#get_supported_resource_types(params = {}) ⇒ Types::GetSupportedResourceTypesOutput
Returns the Amazon Web Services resource types supported by Backup.
2820 2821 2822 2823 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2820 def get_supported_resource_types(params = {}, = {}) req = build_request(:get_supported_resource_types, params) req.send_request() end |
#list_backup_job_summaries(params = {}) ⇒ Types::ListBackupJobSummariesOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2958 2959 2960 2961 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2958 def list_backup_job_summaries(params = {}, = {}) req = build_request(:list_backup_job_summaries, 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.
3146 3147 3148 3149 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3146 def list_backup_jobs(params = {}, = {}) req = build_request(:list_backup_jobs, params) req.send_request() end |
#list_backup_plan_templates(params = {}) ⇒ Types::ListBackupPlanTemplatesOutput
Lists the backup plan templates.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3187 3188 3189 3190 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3187 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.
3244 3245 3246 3247 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3244 def list_backup_plan_versions(params = {}, = {}) req = build_request(:list_backup_plan_versions, params) req.send_request() end |
#list_backup_plans(params = {}) ⇒ Types::ListBackupPlansOutput
Lists the active backup plans for the account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3300 3301 3302 3303 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3300 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.
3350 3351 3352 3353 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3350 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.
3410 3411 3412 3413 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3410 def list_backup_vaults(params = {}, = {}) req = build_request(:list_backup_vaults, params) req.send_request() end |
#list_copy_job_summaries(params = {}) ⇒ Types::ListCopyJobSummariesOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3535 3536 3537 3538 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3535 def list_copy_job_summaries(params = {}, = {}) req = build_request(:list_copy_job_summaries, 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.
3698 3699 3700 3701 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3698 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.
3744 3745 3746 3747 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3744 def list_frameworks(params = {}, = {}) req = build_request(:list_frameworks, params) req.send_request() end |
#list_legal_holds(params = {}) ⇒ Types::ListLegalHoldsOutput
This action returns metadata about active and previous legal holds.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3790 3791 3792 3793 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3790 def list_legal_holds(params = {}, = {}) req = build_request(:list_legal_holds, 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.
3837 3838 3839 3840 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3837 def list_protected_resources(params = {}, = {}) req = build_request(:list_protected_resources, params) req.send_request() end |
#list_protected_resources_by_backup_vault(params = {}) ⇒ Types::ListProtectedResourcesByBackupVaultOutput
This request lists the protected resources corresponding to each backup vault.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3893 3894 3895 3896 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3893 def list_protected_resources_by_backup_vault(params = {}, = {}) req = build_request(:list_protected_resources_by_backup_vault, 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.
4039 4040 4041 4042 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4039 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_legal_hold(params = {}) ⇒ Types::ListRecoveryPointsByLegalHoldOutput
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4087 4088 4089 4090 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4087 def list_recovery_points_by_legal_hold(params = {}, = {}) req = build_request(:list_recovery_points_by_legal_hold, params) req.send_request() end |
#list_recovery_points_by_resource(params = {}) ⇒ Types::ListRecoveryPointsByResourceOutput
The information about 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.
4164 4165 4166 4167 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4164 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.
4238 4239 4240 4241 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4238 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.
4299 4300 4301 4302 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4299 def list_report_plans(params = {}, = {}) req = build_request(:list_report_plans, params) req.send_request() end |
#list_restore_job_summaries(params = {}) ⇒ Types::ListRestoreJobSummariesOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4405 4406 4407 4408 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4405 def list_restore_job_summaries(params = {}, = {}) req = build_request(:list_restore_job_summaries, 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.
4534 4535 4536 4537 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4534 def list_restore_jobs(params = {}, = {}) req = build_request(:list_restore_jobs, params) req.send_request() end |
#list_restore_jobs_by_protected_resource(params = {}) ⇒ Types::ListRestoreJobsByProtectedResourceOutput
This returns restore jobs that contain the specified protected resource.
You must include ResourceArn
. You can optionally include
NextToken
, ByStatus
, MaxResults
,
ByRecoveryPointCreationDateAfter
, and
ByRecoveryPointCreationDateBefore
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4617 4618 4619 4620 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4617 def list_restore_jobs_by_protected_resource(params = {}, = {}) req = build_request(:list_restore_jobs_by_protected_resource, params) req.send_request() end |
#list_restore_testing_plans(params = {}) ⇒ Types::ListRestoreTestingPlansOutput
Returns a list of restore testing plans.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4664 4665 4666 4667 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4664 def list_restore_testing_plans(params = {}, = {}) req = build_request(:list_restore_testing_plans, params) req.send_request() end |
#list_restore_testing_selections(params = {}) ⇒ Types::ListRestoreTestingSelectionsOutput
Returns a list of restore testing selections. Can be filtered by
MaxResults
and RestoreTestingPlanName
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4715 4716 4717 4718 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4715 def list_restore_testing_selections(params = {}, = {}) req = build_request(:list_restore_testing_selections, params) req.send_request() end |
#list_tags(params = {}) ⇒ Types::ListTagsOutput
Returns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4762 4763 4764 4765 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4762 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.
4792 4793 4794 4795 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4792 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.
For more information, see Backup Vault Lock.
4903 4904 4905 4906 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4903 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.
4964 4965 4966 4967 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4964 def put_backup_vault_notifications(params = {}, = {}) req = build_request(:put_backup_vault_notifications, params) req.send_request() end |
#put_restore_validation_result(params = {}) ⇒ Struct
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
.
4997 4998 4999 5000 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4997 def put_restore_validation_result(params = {}, = {}) req = build_request(:put_restore_validation_result, params) req.send_request() end |
#start_backup_job(params = {}) ⇒ Types::StartBackupJobOutput
Starts an on-demand backup job for the specified resource.
5123 5124 5125 5126 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5123 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.
5211 5212 5213 5214 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5211 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.
5249 5250 5251 5252 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5249 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).
5398 5399 5400 5401 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5398 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.
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.
5425 5426 5427 5428 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5425 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).
This API is supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon RDS.
5467 5468 5469 5470 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5467 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)
This API is not supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon RDS.
5504 5505 5506 5507 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5504 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_backup_plan(params = {}) ⇒ Types::UpdateBackupPlanOutput
Updates the specified backup plan. The new version is uniquely identified by its ID.
5588 5589 5590 5591 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5588 def update_backup_plan(params = {}, = {}) req = build_request(:update_backup_plan, params) req.send_request() end |
#update_framework(params = {}) ⇒ Types::UpdateFrameworkOutput
Updates the specified framework.
5659 5660 5661 5662 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5659 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.
5688 5689 5690 5691 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5688 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.
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.
5774 5775 5776 5777 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5774 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.
Use the DescribeRegionSettings
API to determine the resource types
that are supported.
5825 5826 5827 5828 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5825 def update_region_settings(params = {}, = {}) req = build_request(:update_region_settings, params) req.send_request() end |
#update_report_plan(params = {}) ⇒ Types::UpdateReportPlanOutput
Updates the specified report plan.
5902 5903 5904 5905 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5902 def update_report_plan(params = {}, = {}) req = build_request(:update_report_plan, params) req.send_request() end |
#update_restore_testing_plan(params = {}) ⇒ Types::UpdateRestoreTestingPlanOutput
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
5964 5965 5966 5967 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5964 def update_restore_testing_plan(params = {}, = {}) req = build_request(:update_restore_testing_plan, params) req.send_request() end |
#update_restore_testing_selection(params = {}) ⇒ Types::UpdateRestoreTestingSelectionOutput
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.
6040 6041 6042 6043 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 6040 def update_restore_testing_selection(params = {}, = {}) req = build_request(:update_restore_testing_selection, params) req.send_request() end |