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.
422 423 424 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 422 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.
454 455 456 457 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 454 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.
554 555 556 557 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 554 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.
643 644 645 646 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 643 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.
706 707 708 709 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 706 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.
785 786 787 788 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 785 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.
865 866 867 868 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 865 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.
935 936 937 938 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 935 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.
1024 1025 1026 1027 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1024 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.
1092 1093 1094 1095 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1092 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.
1192 1193 1194 1195 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1192 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.
1229 1230 1231 1232 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1229 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
.
1257 1258 1259 1260 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1257 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.
1282 1283 1284 1285 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1282 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.
1308 1309 1310 1311 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1308 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.
1340 1341 1342 1343 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1340 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.
1364 1365 1366 1367 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1364 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.
1386 1387 1388 1389 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1386 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.
1437 1438 1439 1440 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1437 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.
1459 1460 1461 1462 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1459 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.
1484 1485 1486 1487 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1484 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.
1516 1517 1518 1519 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1516 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
.
1601 1602 1603 1604 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1601 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.
1657 1658 1659 1660 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1657 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.
1710 1711 1712 1713 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1710 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
.
1762 1763 1764 1765 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1762 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
1787 1788 1789 1790 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1787 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.
1834 1835 1836 1837 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1834 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.
1927 1928 1929 1930 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1927 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.
1954 1955 1956 1957 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1954 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
.
1994 1995 1996 1997 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1994 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.
2043 2044 2045 2046 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2043 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.
2108 2109 2110 2111 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2108 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.
2141 2142 2143 2144 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2141 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.
2174 2175 2176 2177 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2174 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.
2203 2204 2205 2206 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2203 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.
2280 2281 2282 2283 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2280 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.
2331 2332 2333 2334 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2331 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.
2382 2383 2384 2385 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2382 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.
2445 2446 2447 2448 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2445 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.
2480 2481 2482 2483 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2480 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.
2517 2518 2519 2520 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2517 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.
2569 2570 2571 2572 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2569 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.
2617 2618 2619 2620 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2617 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.
2648 2649 2650 2651 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2648 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.
2693 2694 2695 2696 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2693 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.
2739 2740 2741 2742 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2739 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.
2788 2789 2790 2791 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2788 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.
2808 2809 2810 2811 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2808 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.
2946 2947 2948 2949 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2946 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.
3134 3135 3136 3137 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3134 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.
3175 3176 3177 3178 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3175 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.
3232 3233 3234 3235 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3232 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.
3288 3289 3290 3291 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3288 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.
3338 3339 3340 3341 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3338 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.
3398 3399 3400 3401 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3398 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.
3523 3524 3525 3526 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3523 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.
3686 3687 3688 3689 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3686 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.
3732 3733 3734 3735 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3732 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.
3778 3779 3780 3781 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3778 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.
3825 3826 3827 3828 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3825 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.
3881 3882 3883 3884 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3881 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.
4027 4028 4029 4030 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4027 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.
4075 4076 4077 4078 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4075 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.
4152 4153 4154 4155 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4152 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.
4226 4227 4228 4229 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4226 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.
4287 4288 4289 4290 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4287 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.
4393 4394 4395 4396 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4393 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.
4522 4523 4524 4525 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4522 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.
4605 4606 4607 4608 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4605 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.
4652 4653 4654 4655 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4652 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.
4703 4704 4705 4706 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4703 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.
4750 4751 4752 4753 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4750 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.
4780 4781 4782 4783 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4780 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.
4891 4892 4893 4894 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4891 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.
4952 4953 4954 4955 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4952 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
.
4985 4986 4987 4988 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4985 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.
5111 5112 5113 5114 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5111 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.
5199 5200 5201 5202 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5199 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.
5237 5238 5239 5240 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5237 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).
5386 5387 5388 5389 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5386 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.
5413 5414 5415 5416 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5413 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.
5455 5456 5457 5458 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5455 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.
5492 5493 5494 5495 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5492 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.
5576 5577 5578 5579 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5576 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.
5647 5648 5649 5650 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5647 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.
5676 5677 5678 5679 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5676 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.
5762 5763 5764 5765 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5762 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.
5813 5814 5815 5816 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5813 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.
5890 5891 5892 5893 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5890 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
5952 5953 5954 5955 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5952 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.
6028 6029 6030 6031 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 6028 def update_restore_testing_selection(params = {}, = {}) req = build_request(:update_restore_testing_selection, params) req.send_request() end |