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_index_details(params = {}) ⇒ Types::GetRecoveryPointIndexDetailsOutput
This operation returns the metadata and details specific to the backup index associated with the specified recovery point.
-
#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_indexed_recovery_points(params = {}) ⇒ Types::ListIndexedRecoveryPointsOutput
This operation returns a list of recovery points that have an associated index, belonging to the specified account.
-
#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_index_settings(params = {}) ⇒ Types::UpdateRecoveryPointIndexSettingsOutput
This operation updates the settings of a recovery point index.
-
#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.
466 467 468 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 466 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.
498 499 500 501 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 498 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.
603 604 605 606 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 603 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.
692 693 694 695 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 692 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.
755 756 757 758 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 755 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.
834 835 836 837 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 834 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.
914 915 916 917 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 914 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.
984 985 986 987 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 984 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.
1073 1074 1075 1076 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1073 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.
1141 1142 1143 1144 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1141 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.
1241 1242 1243 1244 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1241 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.
1278 1279 1280 1281 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1278 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
.
1306 1307 1308 1309 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1306 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.
1331 1332 1333 1334 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1331 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.
1357 1358 1359 1360 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1357 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.
1389 1390 1391 1392 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1389 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.
1413 1414 1415 1416 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1413 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.
1435 1436 1437 1438 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1435 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.
1486 1487 1488 1489 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1486 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.
1508 1509 1510 1511 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1508 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.
1533 1534 1535 1536 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1533 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.
1565 1566 1567 1568 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1565 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
.
1650 1651 1652 1653 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1650 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.
1706 1707 1708 1709 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1706 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.
1759 1760 1761 1762 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1759 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
.
1811 1812 1813 1814 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1811 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
1836 1837 1838 1839 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1836 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.
1883 1884 1885 1886 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1883 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.
1980 1981 1982 1983 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1980 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.
2007 2008 2009 2010 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2007 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
.
2047 2048 2049 2050 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2047 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.
2096 2097 2098 2099 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2096 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.
2161 2162 2163 2164 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2161 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.
2194 2195 2196 2197 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2194 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.
2227 2228 2229 2230 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2227 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.
2256 2257 2258 2259 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2256 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.
2336 2337 2338 2339 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2336 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.
2390 2391 2392 2393 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2390 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.
2444 2445 2446 2447 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2444 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.
2507 2508 2509 2510 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2507 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.
2542 2543 2544 2545 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2542 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.
2579 2580 2581 2582 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2579 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.
2631 2632 2633 2634 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2631 def get_legal_hold(params = {}, = {}) req = build_request(:get_legal_hold, params) req.send_request() end |
#get_recovery_point_index_details(params = {}) ⇒ Types::GetRecoveryPointIndexDetailsOutput
This operation returns the metadata and details specific to the backup index associated with the specified recovery point.
2685 2686 2687 2688 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2685 def get_recovery_point_index_details(params = {}, = {}) req = build_request(:get_recovery_point_index_details, 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.
2733 2734 2735 2736 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2733 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.
2764 2765 2766 2767 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2764 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.
2809 2810 2811 2812 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2809 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.
2855 2856 2857 2858 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2855 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.
2904 2905 2906 2907 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2904 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.
2924 2925 2926 2927 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2924 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.
3062 3063 3064 3065 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3062 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.
3250 3251 3252 3253 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3250 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.
3291 3292 3293 3294 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3291 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.
3348 3349 3350 3351 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3348 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.
3404 3405 3406 3407 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3404 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.
3454 3455 3456 3457 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3454 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.
3514 3515 3516 3517 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3514 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.
3639 3640 3641 3642 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3639 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.
3802 3803 3804 3805 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3802 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.
3848 3849 3850 3851 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3848 def list_frameworks(params = {}, = {}) req = build_request(:list_frameworks, params) req.send_request() end |
#list_indexed_recovery_points(params = {}) ⇒ Types::ListIndexedRecoveryPointsOutput
This operation returns a list of recovery points that have an associated index, belonging to the specified account.
Optional parameters you can include are: MaxResults; NextToken; SourceResourceArns; CreatedBefore; CreatedAfter; and ResourceType.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3937 3938 3939 3940 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3937 def list_indexed_recovery_points(params = {}, = {}) req = build_request(:list_indexed_recovery_points, 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.
3983 3984 3985 3986 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3983 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.
4030 4031 4032 4033 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4030 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.
4086 4087 4088 4089 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4086 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.
4234 4235 4236 4237 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4234 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.
4282 4283 4284 4285 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4282 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.
4361 4362 4363 4364 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4361 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.
4435 4436 4437 4438 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4435 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.
4496 4497 4498 4499 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4496 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.
4602 4603 4604 4605 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4602 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.
4731 4732 4733 4734 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4731 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.
4814 4815 4816 4817 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4814 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.
4861 4862 4863 4864 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4861 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.
4912 4913 4914 4915 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4912 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.
4959 4960 4961 4962 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4959 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.
4989 4990 4991 4992 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4989 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.
5100 5101 5102 5103 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5100 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.
5161 5162 5163 5164 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5161 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
.
5194 5195 5196 5197 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5194 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.
5338 5339 5340 5341 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5338 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.
5426 5427 5428 5429 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5426 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.
5464 5465 5466 5467 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5464 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).
5613 5614 5615 5616 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5613 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.
5640 5641 5642 5643 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5640 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.
5682 5683 5684 5685 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5682 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.
5719 5720 5721 5722 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5719 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.
5808 5809 5810 5811 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5808 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.
5879 5880 5881 5882 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5879 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.
5908 5909 5910 5911 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5908 def update_global_settings(params = {}, = {}) req = build_request(:update_global_settings, params) req.send_request() end |
#update_recovery_point_index_settings(params = {}) ⇒ Types::UpdateRecoveryPointIndexSettingsOutput
This operation updates the settings of a recovery point index.
Required: BackupVaultName, RecoveryPointArn, and IAMRoleArn
5968 5969 5970 5971 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5968 def update_recovery_point_index_settings(params = {}, = {}) req = build_request(:update_recovery_point_index_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.
6054 6055 6056 6057 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 6054 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.
6105 6106 6107 6108 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 6105 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.
6182 6183 6184 6185 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 6182 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
6244 6245 6246 6247 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 6244 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.
6320 6321 6322 6323 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 6320 def update_restore_testing_selection(params = {}, = {}) req = build_request(:update_restore_testing_selection, params) req.send_request() end |