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
-
#associate_backup_vault_mpa_approval_team(params = {}) ⇒ Struct
Associates an MPA approval team with a backup vault.
-
#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_access_backup_vault(params = {}) ⇒ Types::CreateRestoreAccessBackupVaultOutput
Creates a restore access backup vault that provides temporary access to recovery points in a logically air-gapped backup vault, subject to MPA approval.
-
#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_backup_vault_mpa_approval_team(params = {}) ⇒ Struct
Removes the association between an MPA approval team and a backup vault, disabling the MPA approval workflow for restore operations.
-
#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_access_backup_vaults(params = {}) ⇒ Types::ListRestoreAccessBackupVaultsOutput
Returns a list of restore access backup vaults associated with a specified backup vault.
-
#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.
-
#revoke_restore_access_backup_vault(params = {}) ⇒ Struct
Revokes access to a restore access backup vault, removing the ability to restore from its recovery points and permanently deleting the vault.
-
#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 resource.
-
#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.
476 477 478 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 476 def initialize(*args) super end |
Instance Method Details
#associate_backup_vault_mpa_approval_team(params = {}) ⇒ Struct
Associates an MPA approval team with a backup vault.
509 510 511 512 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 509 def associate_backup_vault_mpa_approval_team(params = {}, = {}) req = build_request(:associate_backup_vault_mpa_approval_team, params) req.send_request() end |
#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.
540 541 542 543 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 540 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.
648 649 650 651 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 648 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.
740 741 742 743 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 740 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.
806 807 808 809 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 806 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.
885 886 887 888 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 885 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.
968 969 970 971 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 968 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.
1041 1042 1043 1044 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1041 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.
1130 1131 1132 1133 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1130 def create_report_plan(params = {}, = {}) req = build_request(:create_report_plan, params) req.send_request() end |
#create_restore_access_backup_vault(params = {}) ⇒ Types::CreateRestoreAccessBackupVaultOutput
Creates a restore access backup vault that provides temporary access to recovery points in a logically air-gapped backup vault, subject to MPA approval.
1190 1191 1192 1193 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1190 def create_restore_access_backup_vault(params = {}, = {}) req = build_request(:create_restore_access_backup_vault, 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.
1258 1259 1260 1261 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1258 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.
1358 1359 1360 1361 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1358 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.
1395 1396 1397 1398 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1395 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
.
1423 1424 1425 1426 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1423 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.
1448 1449 1450 1451 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1448 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.
1474 1475 1476 1477 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1474 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.
1506 1507 1508 1509 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1506 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.
1530 1531 1532 1533 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1530 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.
1552 1553 1554 1555 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1552 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.
1603 1604 1605 1606 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1603 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.
1625 1626 1627 1628 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1625 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.
1650 1651 1652 1653 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1650 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.
1682 1683 1684 1685 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1682 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
.
1767 1768 1769 1770 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1767 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.
1835 1836 1837 1838 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1835 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.
1888 1889 1890 1891 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1888 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
.
1940 1941 1942 1943 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1940 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
1965 1966 1967 1968 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 1965 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.
2012 2013 2014 2015 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2012 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.
2111 2112 2113 2114 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2111 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.
2138 2139 2140 2141 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2138 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
.
2178 2179 2180 2181 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2178 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.
2227 2228 2229 2230 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2227 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.
2292 2293 2294 2295 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2292 def describe_restore_job(params = {}, = {}) req = build_request(:describe_restore_job, params) req.send_request() end |
#disassociate_backup_vault_mpa_approval_team(params = {}) ⇒ Struct
Removes the association between an MPA approval team and a backup vault, disabling the MPA approval workflow for restore operations.
2321 2322 2323 2324 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2321 def disassociate_backup_vault_mpa_approval_team(params = {}, = {}) req = build_request(:disassociate_backup_vault_mpa_approval_team, 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.
2354 2355 2356 2357 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2354 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.
2387 2388 2389 2390 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2387 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.
2416 2417 2418 2419 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2416 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.
2496 2497 2498 2499 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2496 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.
2550 2551 2552 2553 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2550 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.
2604 2605 2606 2607 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2604 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.
2667 2668 2669 2670 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2667 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.
2702 2703 2704 2705 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2702 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.
2739 2740 2741 2742 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2739 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.
2791 2792 2793 2794 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2791 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.
2845 2846 2847 2848 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2845 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.
2893 2894 2895 2896 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2893 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.
2924 2925 2926 2927 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2924 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.
2969 2970 2971 2972 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 2969 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.
3015 3016 3017 3018 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3015 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.
3064 3065 3066 3067 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3064 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.
3084 3085 3086 3087 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3084 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.
3222 3223 3224 3225 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3222 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.
3410 3411 3412 3413 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3410 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.
3451 3452 3453 3454 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3451 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.
3508 3509 3510 3511 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3508 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.
3564 3565 3566 3567 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3564 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.
3614 3615 3616 3617 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3614 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.
3674 3675 3676 3677 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3674 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.
3799 3800 3801 3802 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3799 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.
3962 3963 3964 3965 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 3962 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.
4008 4009 4010 4011 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4008 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.
4097 4098 4099 4100 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4097 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.
4143 4144 4145 4146 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4143 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.
4190 4191 4192 4193 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4190 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.
4246 4247 4248 4249 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4246 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.
4395 4396 4397 4398 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4395 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.
4443 4444 4445 4446 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4443 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.
4522 4523 4524 4525 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4522 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.
4596 4597 4598 4599 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4596 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.
4657 4658 4659 4660 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4657 def list_report_plans(params = {}, = {}) req = build_request(:list_report_plans, params) req.send_request() end |
#list_restore_access_backup_vaults(params = {}) ⇒ Types::ListRestoreAccessBackupVaultsOutput
Returns a list of restore access backup vaults associated with a specified backup vault.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4709 4710 4711 4712 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4709 def list_restore_access_backup_vaults(params = {}, = {}) req = build_request(:list_restore_access_backup_vaults, 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.
4815 4816 4817 4818 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4815 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.
4944 4945 4946 4947 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 4944 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.
5027 5028 5029 5030 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5027 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.
5074 5075 5076 5077 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5074 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.
5125 5126 5127 5128 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5125 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.
This operation returns results depending on the resource type used in
the value for resourceArn
. For example, recovery points of Amazon
DynamoDB with Advanced Settings have an ARN (Amazon Resource Name)
that begins with arn:aws:backup
. Recovery points (backups) of
DynamoDB without Advanced Settings enabled have an ARN that begins
with arn:aws:dynamodb
.
When this operation is called and when you include values of
resourceArn
that have an ARN other than arn:aws:backup
, it may
return one of the exceptions listed below. To prevent this exception,
include only values representing resource types that are fully managed
by Backup. These have an ARN that begins arn:aws:backup
and they are
noted in the Feature availability by resource table.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5190 5191 5192 5193 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5190 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.
5220 5221 5222 5223 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5220 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.
5331 5332 5333 5334 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5331 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.
5373 5374 5375 5376 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5373 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
.
5406 5407 5408 5409 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5406 def put_restore_validation_result(params = {}, = {}) req = build_request(:put_restore_validation_result, params) req.send_request() end |
#revoke_restore_access_backup_vault(params = {}) ⇒ Struct
Revokes access to a restore access backup vault, removing the ability to restore from its recovery points and permanently deleting the vault.
5440 5441 5442 5443 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5440 def revoke_restore_access_backup_vault(params = {}, = {}) req = build_request(:revoke_restore_access_backup_vault, params) req.send_request() end |
#start_backup_job(params = {}) ⇒ Types::StartBackupJobOutput
Starts an on-demand backup job for the specified resource.
5587 5588 5589 5590 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5587 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.
5678 5679 5680 5681 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5678 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.
5716 5717 5718 5719 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5716 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).
5868 5869 5870 5871 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5868 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 Aurora
Amazon DocumentDB (with MongoDB compatibility)
Amazon FSx for Lustre
Amazon FSx for NetApp ONTAP
Amazon FSx for OpenZFS
Amazon FSx for Windows File Server
Amazon Neptune
SAP HANA databases on Amazon EC2 instances
Amazon RDS
5910 5911 5912 5913 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5910 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 resource.
5941 5942 5943 5944 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5941 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.
5978 5979 5980 5981 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 5978 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.
6067 6068 6069 6070 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 6067 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.
6138 6139 6140 6141 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 6138 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.
6167 6168 6169 6170 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 6167 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
6227 6228 6229 6230 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 6227 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.
6313 6314 6315 6316 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 6313 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.
6364 6365 6366 6367 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 6364 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.
6441 6442 6443 6444 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 6441 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
6503 6504 6505 6506 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 6503 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.
6579 6580 6581 6582 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb', line 6579 def update_restore_testing_selection(params = {}, = {}) req = build_request(:update_restore_testing_selection, params) req.send_request() end |