AWS SDK for C++AWS SDK for C++ Version 1.11.611 |
#include <BackupClient.h>
<fullname>Backup</fullname>
Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.
Definition at line 24 of file BackupClient.h.
Definition at line 27 of file BackupClient.h.
Definition at line 31 of file BackupClient.h.
Definition at line 32 of file BackupClient.h.
Aws::Backup::BackupClientConfiguration()
,
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Backup::BackupClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Backup::BackupClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
nullptr
An Async wrapper for AssociateBackupVaultMpaApprovalTeam that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 103 of file BackupClient.h.
A Callable wrapper for AssociateBackupVaultMpaApprovalTeam that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 94 of file BackupClient.h.
Removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.
nullptr
An Async wrapper for CancelLegalHold that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 129 of file BackupClient.h.
A Callable wrapper for CancelLegalHold that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 120 of file BackupClient.h.
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.
nullptr
An Async wrapper for CreateBackupPlan that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 158 of file BackupClient.h.
A Callable wrapper for CreateBackupPlan that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 149 of file BackupClient.h.
Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically.
nullptr
An Async wrapper for CreateBackupSelection that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 186 of file BackupClient.h.
A Callable wrapper for CreateBackupSelection that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 177 of file BackupClient.h.
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.
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
nullptr
An Async wrapper for CreateBackupVault that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 215 of file BackupClient.h.
A Callable wrapper for CreateBackupVault that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 206 of file BackupClient.h.
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.
nullptr
An Async wrapper for CreateFramework that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 244 of file BackupClient.h.
A Callable wrapper for CreateFramework that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 235 of file BackupClient.h.
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.
nullptr
An Async wrapper for CreateLegalHold that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 273 of file BackupClient.h.
A Callable wrapper for CreateLegalHold that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 264 of file BackupClient.h.
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.
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
nullptr
An Async wrapper for CreateLogicallyAirGappedBackupVault that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 302 of file BackupClient.h.
A Callable wrapper for CreateLogicallyAirGappedBackupVault that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 293 of file BackupClient.h.
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.
nullptr
An Async wrapper for CreateReportPlan that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 330 of file BackupClient.h.
A Callable wrapper for CreateReportPlan that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 321 of file BackupClient.h.
Creates a restore access backup vault that provides temporary access to recovery points in a logically air-gapped backup vault, subject to MPA approval.
nullptr
An Async wrapper for CreateRestoreAccessBackupVault that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 357 of file BackupClient.h.
A Callable wrapper for CreateRestoreAccessBackupVault that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 348 of file BackupClient.h.
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.
nullptr
An Async wrapper for CreateRestoreTestingPlan that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 384 of file BackupClient.h.
A Callable wrapper for CreateRestoreTestingPlan that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 375 of file BackupClient.h.
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.
nullptr
An Async wrapper for CreateRestoreTestingSelection that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 421 of file BackupClient.h.
A Callable wrapper for CreateRestoreTestingSelection that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 412 of file BackupClient.h.
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.
nullptr
An Async wrapper for DeleteBackupPlan that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 449 of file BackupClient.h.
A Callable wrapper for DeleteBackupPlan that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 440 of file BackupClient.h.
Deletes the resource selection associated with a backup plan that is specified by the SelectionId
.
nullptr
An Async wrapper for DeleteBackupSelection that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 475 of file BackupClient.h.
A Callable wrapper for DeleteBackupSelection that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 466 of file BackupClient.h.
Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
nullptr
An Async wrapper for DeleteBackupVaultAccessPolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 527 of file BackupClient.h.
A Callable wrapper for DeleteBackupVaultAccessPolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 518 of file BackupClient.h.
nullptr
An Async wrapper for DeleteBackupVault that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 501 of file BackupClient.h.
A Callable wrapper for DeleteBackupVault that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 492 of file BackupClient.h.
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.
nullptr
An Async wrapper for DeleteBackupVaultLockConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 558 of file BackupClient.h.
A Callable wrapper for DeleteBackupVaultLockConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 549 of file BackupClient.h.
nullptr
An Async wrapper for DeleteBackupVaultNotifications that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 584 of file BackupClient.h.
A Callable wrapper for DeleteBackupVaultNotifications that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 575 of file BackupClient.h.
nullptr
An Async wrapper for DeleteFramework that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 610 of file BackupClient.h.
A Callable wrapper for DeleteFramework that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 601 of file BackupClient.h.
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.
nullptr
An Async wrapper for DeleteRecoveryPoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 647 of file BackupClient.h.
A Callable wrapper for DeleteRecoveryPoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 638 of file BackupClient.h.
nullptr
An Async wrapper for DeleteReportPlan that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 673 of file BackupClient.h.
A Callable wrapper for DeleteReportPlan that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 664 of file BackupClient.h.
This request deletes the specified restore testing plan.
Deletion can only successfully occur if all associated restore testing selections are deleted first.
nullptr
An Async wrapper for DeleteRestoreTestingPlan that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 700 of file BackupClient.h.
A Callable wrapper for DeleteRestoreTestingPlan that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 691 of file BackupClient.h.
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.
nullptr
An Async wrapper for DeleteRestoreTestingSelection that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 727 of file BackupClient.h.
A Callable wrapper for DeleteRestoreTestingSelection that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 718 of file BackupClient.h.
nullptr
An Async wrapper for DescribeBackupJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 753 of file BackupClient.h.
A Callable wrapper for DescribeBackupJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 744 of file BackupClient.h.
nullptr
An Async wrapper for DescribeBackupVault that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 779 of file BackupClient.h.
A Callable wrapper for DescribeBackupVault that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 770 of file BackupClient.h.
nullptr
An Async wrapper for DescribeCopyJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 805 of file BackupClient.h.
A Callable wrapper for DescribeCopyJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 796 of file BackupClient.h.
nullptr
An Async wrapper for DescribeFramework that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 831 of file BackupClient.h.
A Callable wrapper for DescribeFramework that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 822 of file BackupClient.h.
{}
)
const
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
nullptr
,
{}
An Async wrapper for DescribeGlobalSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 859 of file BackupClient.h.
{}
)
const
A Callable wrapper for DescribeGlobalSettings that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 850 of file BackupClient.h.
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.
nullptr
An Async wrapper for DescribeProtectedResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 886 of file BackupClient.h.
A Callable wrapper for DescribeProtectedResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 877 of file BackupClient.h.
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
nullptr
An Async wrapper for DescribeRecoveryPoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 912 of file BackupClient.h.
A Callable wrapper for DescribeRecoveryPoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 903 of file BackupClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for DescribeRegionSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 941 of file BackupClient.h.
{}
)
const
A Callable wrapper for DescribeRegionSettings that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 932 of file BackupClient.h.
Returns the details associated with creating a report as specified by its ReportJobId
.
nullptr
An Async wrapper for DescribeReportJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 967 of file BackupClient.h.
A Callable wrapper for DescribeReportJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 958 of file BackupClient.h.
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
nullptr
An Async wrapper for DescribeReportPlan that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 993 of file BackupClient.h.
A Callable wrapper for DescribeReportPlan that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 984 of file BackupClient.h.
Returns metadata associated with a restore job that is specified by a job ID.
nullptr
An Async wrapper for DescribeRestoreJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1019 of file BackupClient.h.
A Callable wrapper for DescribeRestoreJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1010 of file BackupClient.h.
Removes the association between an MPA approval team and a backup vault, disabling the MPA approval workflow for restore operations.
nullptr
An Async wrapper for DisassociateBackupVaultMpaApprovalTeam that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1046 of file BackupClient.h.
A Callable wrapper for DisassociateBackupVaultMpaApprovalTeam that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1037 of file BackupClient.h.
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.
nullptr
An Async wrapper for DisassociateRecoveryPoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1075 of file BackupClient.h.
A Callable wrapper for DisassociateRecoveryPoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1066 of file BackupClient.h.
This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.
nullptr
An Async wrapper for DisassociateRecoveryPointFromParent that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1102 of file BackupClient.h.
A Callable wrapper for DisassociateRecoveryPointFromParent that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1093 of file BackupClient.h.
Returns the backup plan that is specified by the plan ID as a backup template.
nullptr
An Async wrapper for ExportBackupPlanTemplate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1128 of file BackupClient.h.
A Callable wrapper for ExportBackupPlanTemplate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1119 of file BackupClient.h.
Returns BackupPlan
details for the specified BackupPlanId
. The details are the body of a backup plan in JSON format, in addition to plan metadata.
nullptr
An Async wrapper for GetBackupPlan that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1155 of file BackupClient.h.
A Callable wrapper for GetBackupPlan that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1146 of file BackupClient.h.
nullptr
An Async wrapper for GetBackupPlanFromJSON that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1181 of file BackupClient.h.
A Callable wrapper for GetBackupPlanFromJSON that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1172 of file BackupClient.h.
nullptr
An Async wrapper for GetBackupPlanFromTemplate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1207 of file BackupClient.h.
A Callable wrapper for GetBackupPlanFromTemplate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1198 of file BackupClient.h.
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
nullptr
An Async wrapper for GetBackupSelection that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1234 of file BackupClient.h.
A Callable wrapper for GetBackupSelection that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1225 of file BackupClient.h.
Returns the access policy document that is associated with the named backup vault.
nullptr
An Async wrapper for GetBackupVaultAccessPolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1260 of file BackupClient.h.
A Callable wrapper for GetBackupVaultAccessPolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1251 of file BackupClient.h.
nullptr
An Async wrapper for GetBackupVaultNotifications that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1286 of file BackupClient.h.
A Callable wrapper for GetBackupVaultNotifications that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1277 of file BackupClient.h.
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.
nullptr
An Async wrapper for GetLegalHold that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1313 of file BackupClient.h.
A Callable wrapper for GetLegalHold that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1304 of file BackupClient.h.
This operation returns the metadata and details specific to the backup index associated with the specified recovery point.
nullptr
An Async wrapper for GetRecoveryPointIndexDetails that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1339 of file BackupClient.h.
A Callable wrapper for GetRecoveryPointIndexDetails that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1330 of file BackupClient.h.
Returns a set of metadata key-value pairs that were used to create the backup.
nullptr
An Async wrapper for GetRecoveryPointRestoreMetadata that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1365 of file BackupClient.h.
A Callable wrapper for GetRecoveryPointRestoreMetadata that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1356 of file BackupClient.h.
nullptr
An Async wrapper for GetRestoreJobMetadata that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1391 of file BackupClient.h.
A Callable wrapper for GetRestoreJobMetadata that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1382 of file BackupClient.h.
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.
nullptr
An Async wrapper for GetRestoreTestingInferredMetadata that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1420 of file BackupClient.h.
A Callable wrapper for GetRestoreTestingInferredMetadata that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1411 of file BackupClient.h.
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.
nullptr
An Async wrapper for GetRestoreTestingPlan that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1448 of file BackupClient.h.
A Callable wrapper for GetRestoreTestingPlan that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1439 of file BackupClient.h.
Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
nullptr
An Async wrapper for GetRestoreTestingSelection that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1474 of file BackupClient.h.
A Callable wrapper for GetRestoreTestingSelection that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1465 of file BackupClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for GetSupportedResourceTypes that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1500 of file BackupClient.h.
{}
)
const
A Callable wrapper for GetSupportedResourceTypes that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1491 of file BackupClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ListBackupJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1558 of file BackupClient.h.
{}
)
const
A Callable wrapper for ListBackupJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1549 of file BackupClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ListBackupJobSummaries that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1530 of file BackupClient.h.
{}
)
const
A Callable wrapper for ListBackupJobSummaries that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1521 of file BackupClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListBackupPlans that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1635 of file BackupClient.h.
{}
)
const
A Callable wrapper for ListBackupPlans that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1626 of file BackupClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListBackupPlanTemplates that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1583 of file BackupClient.h.
{}
)
const
A Callable wrapper for ListBackupPlanTemplates that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1574 of file BackupClient.h.
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
nullptr
An Async wrapper for ListBackupPlanVersions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1610 of file BackupClient.h.
A Callable wrapper for ListBackupPlanVersions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1601 of file BackupClient.h.
Returns an array containing metadata of the resources associated with the target backup plan.
nullptr
An Async wrapper for ListBackupSelections that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1661 of file BackupClient.h.
A Callable wrapper for ListBackupSelections that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1652 of file BackupClient.h.
{}
)
const
Returns a list of recovery point storage containers along with information about them.
nullptr
,
{}
An Async wrapper for ListBackupVaults that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1687 of file BackupClient.h.
{}
)
const
A Callable wrapper for ListBackupVaults that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1678 of file BackupClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListCopyJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1742 of file BackupClient.h.
{}
)
const
A Callable wrapper for ListCopyJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1733 of file BackupClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ListCopyJobSummaries that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1717 of file BackupClient.h.
{}
)
const
A Callable wrapper for ListCopyJobSummaries that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1708 of file BackupClient.h.
{}
)
const
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
nullptr
,
{}
An Async wrapper for ListFrameworks that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1768 of file BackupClient.h.
{}
)
const
A Callable wrapper for ListFrameworks that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1759 of file BackupClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ListIndexedRecoveryPoints that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1796 of file BackupClient.h.
{}
)
const
A Callable wrapper for ListIndexedRecoveryPoints that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1787 of file BackupClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListLegalHolds that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1822 of file BackupClient.h.
{}
)
const
A Callable wrapper for ListLegalHolds that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1813 of file BackupClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ListProtectedResources that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1849 of file BackupClient.h.
This request lists the protected resources corresponding to each backup vault.
nullptr
An Async wrapper for ListProtectedResourcesByBackupVault that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1875 of file BackupClient.h.
A Callable wrapper for ListProtectedResourcesByBackupVault that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1866 of file BackupClient.h.
{}
)
const
A Callable wrapper for ListProtectedResources that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1840 of file BackupClient.h.
Returns detailed information about the recovery points stored in a backup vault.
nullptr
An Async wrapper for ListRecoveryPointsByBackupVault that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1901 of file BackupClient.h.
A Callable wrapper for ListRecoveryPointsByBackupVault that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1892 of file BackupClient.h.
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
nullptr
An Async wrapper for ListRecoveryPointsByLegalHold that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1927 of file BackupClient.h.
A Callable wrapper for ListRecoveryPointsByLegalHold that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1918 of file BackupClient.h.
The information about the recovery points of the type specified by a resource Amazon Resource Name (ARN).
For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.
nullptr
An Async wrapper for ListRecoveryPointsByResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1955 of file BackupClient.h.
A Callable wrapper for ListRecoveryPointsByResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1946 of file BackupClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListReportJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1980 of file BackupClient.h.
{}
)
const
A Callable wrapper for ListReportJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1971 of file BackupClient.h.
{}
)
const
Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan
.
nullptr
,
{}
An Async wrapper for ListReportPlans that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2006 of file BackupClient.h.
{}
)
const
A Callable wrapper for ListReportPlans that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1997 of file BackupClient.h.
Returns a list of restore access backup vaults associated with a specified backup vault.
nullptr
An Async wrapper for ListRestoreAccessBackupVaults that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2032 of file BackupClient.h.
A Callable wrapper for ListRestoreAccessBackupVaults that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2023 of file BackupClient.h.
{}
)
const
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
nullptr
,
{}
An Async wrapper for ListRestoreJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2088 of file BackupClient.h.
This returns restore jobs that contain the specified protected resource.
You must include ResourceArn
. You can optionally include NextToken
, ByStatus
, MaxResults
, ByRecoveryPointCreationDateAfter
, and ByRecoveryPointCreationDateBefore
.
nullptr
An Async wrapper for ListRestoreJobsByProtectedResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2117 of file BackupClient.h.
A Callable wrapper for ListRestoreJobsByProtectedResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2108 of file BackupClient.h.
{}
)
const
A Callable wrapper for ListRestoreJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2079 of file BackupClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ListRestoreJobSummaries that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2062 of file BackupClient.h.
{}
)
const
A Callable wrapper for ListRestoreJobSummaries that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2053 of file BackupClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListRestoreTestingPlans that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2142 of file BackupClient.h.
{}
)
const
A Callable wrapper for ListRestoreTestingPlans that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2133 of file BackupClient.h.
Returns a list of restore testing selections. Can be filtered by MaxResults
and RestoreTestingPlanName
.
nullptr
An Async wrapper for ListRestoreTestingSelections that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2169 of file BackupClient.h.
A Callable wrapper for ListRestoreTestingSelections that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2160 of file BackupClient.h.
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.