AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Implementation for accessing Backup
BackupBackup 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.
Namespace: Amazon.Backup
Assembly: AWSSDK.Backup.dll
Version: 3.x.y.z
public class AmazonBackupClient : AmazonServiceClient IAmazonBackup, IAmazonService, IDisposable
The AmazonBackupClient type exposes the following members
Name | Description | |
---|---|---|
AmazonBackupClient() |
Constructs AmazonBackupClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonBackupClient(RegionEndpoint) |
Constructs AmazonBackupClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonBackupClient(AmazonBackupConfig) |
Constructs AmazonBackupClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonBackupClient(AWSCredentials) |
Constructs AmazonBackupClient with AWS Credentials |
|
AmazonBackupClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonBackupClient with AWS Credentials |
|
AmazonBackupClient(AWSCredentials, AmazonBackupConfig) |
Constructs AmazonBackupClient with AWS Credentials and an AmazonBackupClient Configuration object. |
|
AmazonBackupClient(string, string) |
Constructs AmazonBackupClient with AWS Access Key ID and AWS Secret Key |
|
AmazonBackupClient(string, string, RegionEndpoint) |
Constructs AmazonBackupClient with AWS Access Key ID and AWS Secret Key |
|
AmazonBackupClient(string, string, AmazonBackupConfig) |
Constructs AmazonBackupClient with AWS Access Key ID, AWS Secret Key and an AmazonBackupClient Configuration object. |
|
AmazonBackupClient(string, string, string) |
Constructs AmazonBackupClient with AWS Access Key ID and AWS Secret Key |
|
AmazonBackupClient(string, string, string, RegionEndpoint) |
Constructs AmazonBackupClient with AWS Access Key ID and AWS Secret Key |
|
AmazonBackupClient(string, string, string, AmazonBackupConfig) |
Constructs AmazonBackupClient with AWS Access Key ID, AWS Secret Key and an AmazonBackupClient Configuration object. |
Name | Type | Description | |
---|---|---|---|
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. | |
Paginators | Amazon.Backup.Model.IBackupPaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
CancelLegalHold(CancelLegalHoldRequest) |
Removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions. |
|
CancelLegalHoldAsync(CancelLegalHoldRequest, CancellationToken) |
Removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions. |
|
CreateBackupPlan(CreateBackupPlanRequest) |
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 |
|
CreateBackupPlanAsync(CreateBackupPlanRequest, CancellationToken) |
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 |
|
CreateBackupSelection(CreateBackupSelectionRequest) |
Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically. |
|
CreateBackupSelectionAsync(CreateBackupSelectionRequest, CancellationToken) |
Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically. |
|
CreateBackupVault(CreateBackupVaultRequest) |
Creates a logical container where backups are stored. A
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
|
|
CreateBackupVaultAsync(CreateBackupVaultRequest, CancellationToken) |
Creates a logical container where backups are stored. A
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
|
|
CreateFramework(CreateFrameworkRequest) |
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. |
|
CreateFrameworkAsync(CreateFrameworkRequest, CancellationToken) |
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. |
|
CreateLegalHold(CreateLegalHoldRequest) |
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. |
|
CreateLegalHoldAsync(CreateLegalHoldRequest, CancellationToken) |
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. |
|
CreateLogicallyAirGappedBackupVault(CreateLogicallyAirGappedBackupVaultRequest) |
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. |
|
CreateLogicallyAirGappedBackupVaultAsync(CreateLogicallyAirGappedBackupVaultRequest, CancellationToken) |
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. |
|
CreateReportPlan(CreateReportPlanRequest) |
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 |
|
CreateReportPlanAsync(CreateReportPlanRequest, CancellationToken) |
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 |
|
CreateRestoreTestingPlan(CreateRestoreTestingPlanRequest) |
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. |
|
CreateRestoreTestingPlanAsync(CreateRestoreTestingPlanRequest, CancellationToken) |
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. |
|
CreateRestoreTestingSelection(CreateRestoreTestingSelectionRequest) |
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
Each protected resource type can have one single value.
A restore testing selection can include a wildcard value ("*") for Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included. |
|
CreateRestoreTestingSelectionAsync(CreateRestoreTestingSelectionRequest, CancellationToken) |
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
Each protected resource type can have one single value.
A restore testing selection can include a wildcard value ("*") for Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included. |
|
DeleteBackupPlan(DeleteBackupPlanRequest) |
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. |
|
DeleteBackupPlanAsync(DeleteBackupPlanRequest, CancellationToken) |
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. |
|
DeleteBackupSelection(DeleteBackupSelectionRequest) |
Deletes the resource selection associated with a backup plan that is specified by
the |
|
DeleteBackupSelectionAsync(DeleteBackupSelectionRequest, CancellationToken) |
Deletes the resource selection associated with a backup plan that is specified by
the |
|
DeleteBackupVault(DeleteBackupVaultRequest) |
Deletes the backup vault identified by its name. A vault can be deleted only if it is empty. |
|
DeleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest) |
Deletes the policy document that manages permissions on a backup vault. |
|
DeleteBackupVaultAccessPolicyAsync(DeleteBackupVaultAccessPolicyRequest, CancellationToken) |
Deletes the policy document that manages permissions on a backup vault. |
|
DeleteBackupVaultAsync(DeleteBackupVaultRequest, CancellationToken) |
Deletes the backup vault identified by its name. A vault can be deleted only if it is empty. |
|
DeleteBackupVaultLockConfiguration(DeleteBackupVaultLockConfigurationRequest) |
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 |
|
DeleteBackupVaultLockConfigurationAsync(DeleteBackupVaultLockConfigurationRequest, CancellationToken) |
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 |
|
DeleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest) |
Deletes event notifications for the specified backup vault. |
|
DeleteBackupVaultNotificationsAsync(DeleteBackupVaultNotificationsRequest, CancellationToken) |
Deletes event notifications for the specified backup vault. |
|
DeleteFramework(DeleteFrameworkRequest) |
Deletes the framework specified by a framework name. |
|
DeleteFrameworkAsync(DeleteFrameworkRequest, CancellationToken) |
Deletes the framework specified by a framework name. |
|
DeleteRecoveryPoint(DeleteRecoveryPointRequest) |
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
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 |
|
DeleteRecoveryPointAsync(DeleteRecoveryPointRequest, CancellationToken) |
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
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 |
|
DeleteReportPlan(DeleteReportPlanRequest) |
Deletes the report plan specified by a report plan name. |
|
DeleteReportPlanAsync(DeleteReportPlanRequest, CancellationToken) |
Deletes the report plan specified by a report plan name. |
|
DeleteRestoreTestingPlan(DeleteRestoreTestingPlanRequest) |
This request deletes the specified restore testing plan. Deletion can only successfully occur if all associated restore testing selections are deleted first. |
|
DeleteRestoreTestingPlanAsync(DeleteRestoreTestingPlanRequest, CancellationToken) |
This request deletes the specified restore testing plan. Deletion can only successfully occur if all associated restore testing selections are deleted first. |
|
DeleteRestoreTestingSelection(DeleteRestoreTestingSelectionRequest) |
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. |
|
DeleteRestoreTestingSelectionAsync(DeleteRestoreTestingSelectionRequest, CancellationToken) |
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. |
|
DescribeBackupJob(DescribeBackupJobRequest) |
Returns backup job details for the specified |
|
DescribeBackupJobAsync(DescribeBackupJobRequest, CancellationToken) |
Returns backup job details for the specified |
|
DescribeBackupVault(DescribeBackupVaultRequest) |
Returns metadata about a backup vault specified by its name. |
|
DescribeBackupVaultAsync(DescribeBackupVaultRequest, CancellationToken) |
Returns metadata about a backup vault specified by its name. |
|
DescribeCopyJob(DescribeCopyJobRequest) |
Returns metadata associated with creating a copy of a resource. |
|
DescribeCopyJobAsync(DescribeCopyJobRequest, CancellationToken) |
Returns metadata associated with creating a copy of a resource. |
|
DescribeFramework(DescribeFrameworkRequest) |
Returns the framework details for the specified |
|
DescribeFrameworkAsync(DescribeFrameworkRequest, CancellationToken) |
Returns the framework details for the specified |
|
DescribeGlobalSettings(DescribeGlobalSettingsRequest) |
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: |
|
DescribeGlobalSettingsAsync(DescribeGlobalSettingsRequest, CancellationToken) |
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: |
|
DescribeProtectedResource(DescribeProtectedResourceRequest) |
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. |
|
DescribeProtectedResourceAsync(DescribeProtectedResourceRequest, CancellationToken) |
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. |
|
DescribeRecoveryPoint(DescribeRecoveryPointRequest) |
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle. |
|
DescribeRecoveryPointAsync(DescribeRecoveryPointRequest, CancellationToken) |
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle. |
|
DescribeRegionSettings(DescribeRegionSettingsRequest) |
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. |
|
DescribeRegionSettingsAsync(DescribeRegionSettingsRequest, CancellationToken) |
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. |
|
DescribeReportJob(DescribeReportJobRequest) |
Returns the details associated with creating a report as specified by its |
|
DescribeReportJobAsync(DescribeReportJobRequest, CancellationToken) |
Returns the details associated with creating a report as specified by its |
|
DescribeReportPlan(DescribeReportPlanRequest) |
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region. |
|
DescribeReportPlanAsync(DescribeReportPlanRequest, CancellationToken) |
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region. |
|
DescribeRestoreJob(DescribeRestoreJobRequest) |
Returns metadata associated with a restore job that is specified by a job ID. |
|
DescribeRestoreJobAsync(DescribeRestoreJobRequest, CancellationToken) |
Returns metadata associated with a restore job that is specified by a job ID. |
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
DisassociateRecoveryPoint(DisassociateRecoveryPointRequest) |
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. |
|
DisassociateRecoveryPointAsync(DisassociateRecoveryPointRequest, CancellationToken) |
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. |
|
DisassociateRecoveryPointFromParent(DisassociateRecoveryPointFromParentRequest) |
This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point. |
|
DisassociateRecoveryPointFromParentAsync(DisassociateRecoveryPointFromParentRequest, CancellationToken) |
This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point. |
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExportBackupPlanTemplate(ExportBackupPlanTemplateRequest) |
Returns the backup plan that is specified by the plan ID as a backup template. |
|
ExportBackupPlanTemplateAsync(ExportBackupPlanTemplateRequest, CancellationToken) |
Returns the backup plan that is specified by the plan ID as a backup template. |
|
GetBackupPlan(GetBackupPlanRequest) |
Returns |
|
GetBackupPlanAsync(GetBackupPlanRequest, CancellationToken) |
Returns |
|
GetBackupPlanFromJSON(GetBackupPlanFromJSONRequest) |
Returns a valid JSON document specifying a backup plan or an error. |
|
GetBackupPlanFromJSONAsync(GetBackupPlanFromJSONRequest, CancellationToken) |
Returns a valid JSON document specifying a backup plan or an error. |
|
GetBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest) |
Returns the template specified by its |
|
GetBackupPlanFromTemplateAsync(GetBackupPlanFromTemplateRequest, CancellationToken) |
Returns the template specified by its |
|
GetBackupSelection(GetBackupSelectionRequest) |
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan. |
|
GetBackupSelectionAsync(GetBackupSelectionRequest, CancellationToken) |
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan. |
|
GetBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest) |
Returns the access policy document that is associated with the named backup vault. |
|
GetBackupVaultAccessPolicyAsync(GetBackupVaultAccessPolicyRequest, CancellationToken) |
Returns the access policy document that is associated with the named backup vault. |
|
GetBackupVaultNotifications(GetBackupVaultNotificationsRequest) |
Returns event notifications for the specified backup vault. |
|
GetBackupVaultNotificationsAsync(GetBackupVaultNotificationsRequest, CancellationToken) |
Returns event notifications for the specified backup vault. |
|
GetLegalHold(GetLegalHoldRequest) |
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. |
|
GetLegalHoldAsync(GetLegalHoldRequest, CancellationToken) |
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. |
|
GetRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest) |
Returns a set of metadata key-value pairs that were used to create the backup. |
|
GetRecoveryPointRestoreMetadataAsync(GetRecoveryPointRestoreMetadataRequest, CancellationToken) |
Returns a set of metadata key-value pairs that were used to create the backup. |
|
GetRestoreJobMetadata(GetRestoreJobMetadataRequest) |
This request returns the metadata for the specified restore job. |
|
GetRestoreJobMetadataAsync(GetRestoreJobMetadataRequest, CancellationToken) |
This request returns the metadata for the specified restore job. |
|
GetRestoreTestingInferredMetadata(GetRestoreTestingInferredMetadataRequest) |
This request returns the minimal required set of metadata needed to start a restore
job with secure default settings. |
|
GetRestoreTestingInferredMetadataAsync(GetRestoreTestingInferredMetadataRequest, CancellationToken) |
This request returns the minimal required set of metadata needed to start a restore
job with secure default settings. |
|
GetRestoreTestingPlan(GetRestoreTestingPlanRequest) |
Returns |
|
GetRestoreTestingPlanAsync(GetRestoreTestingPlanRequest, CancellationToken) |
Returns |
|
GetRestoreTestingSelection(GetRestoreTestingSelectionRequest) |
Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan. |
|
GetRestoreTestingSelectionAsync(GetRestoreTestingSelectionRequest, CancellationToken) |
Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan. |
|
GetSupportedResourceTypes(GetSupportedResourceTypesRequest) |
Returns the Amazon Web Services resource types supported by Backup. |
|
GetSupportedResourceTypesAsync(GetSupportedResourceTypesRequest, CancellationToken) |
Returns the Amazon Web Services resource types supported by Backup. |
|
ListBackupJobs(ListBackupJobsRequest) |
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. |
|
ListBackupJobsAsync(ListBackupJobsRequest, CancellationToken) |
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. |
|
ListBackupJobSummaries(ListBackupJobSummariesRequest) |
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. |
|
ListBackupJobSummariesAsync(ListBackupJobSummariesRequest, CancellationToken) |
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. |
|
ListBackupPlans(ListBackupPlansRequest) |
Lists the active backup plans for the account. |
|
ListBackupPlansAsync(ListBackupPlansRequest, CancellationToken) |
Lists the active backup plans for the account. |
|
ListBackupPlanTemplates(ListBackupPlanTemplatesRequest) |
Lists the backup plan templates. |
|
ListBackupPlanTemplatesAsync(ListBackupPlanTemplatesRequest, CancellationToken) |
Lists the backup plan templates. |
|
ListBackupPlanVersions(ListBackupPlanVersionsRequest) |
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs. |
|
ListBackupPlanVersionsAsync(ListBackupPlanVersionsRequest, CancellationToken) |
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs. |
|
ListBackupSelections(ListBackupSelectionsRequest) |
Returns an array containing metadata of the resources associated with the target backup plan. |
|
ListBackupSelectionsAsync(ListBackupSelectionsRequest, CancellationToken) |
Returns an array containing metadata of the resources associated with the target backup plan. |
|
ListBackupVaults(ListBackupVaultsRequest) |
Returns a list of recovery point storage containers along with information about them. |
|
ListBackupVaultsAsync(ListBackupVaultsRequest, CancellationToken) |
Returns a list of recovery point storage containers along with information about them. |
|
ListCopyJobs(ListCopyJobsRequest) |
Returns metadata about your copy jobs. |
|
ListCopyJobsAsync(ListCopyJobsRequest, CancellationToken) |
Returns metadata about your copy jobs. |
|
ListCopyJobSummaries(ListCopyJobSummariesRequest) |
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. |
|
ListCopyJobSummariesAsync(ListCopyJobSummariesRequest, CancellationToken) |
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. |
|
ListFrameworks(ListFrameworksRequest) |
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region. |
|
ListFrameworksAsync(ListFrameworksRequest, CancellationToken) |
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region. |
|
ListLegalHolds(ListLegalHoldsRequest) |
This action returns metadata about active and previous legal holds. |
|
ListLegalHoldsAsync(ListLegalHoldsRequest, CancellationToken) |
This action returns metadata about active and previous legal holds. |
|
ListProtectedResources(ListProtectedResourcesRequest) |
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. |
|
ListProtectedResourcesAsync(ListProtectedResourcesRequest, CancellationToken) |
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. |
|
ListProtectedResourcesByBackupVault(ListProtectedResourcesByBackupVaultRequest) |
This request lists the protected resources corresponding to each backup vault. |
|
ListProtectedResourcesByBackupVaultAsync(ListProtectedResourcesByBackupVaultRequest, CancellationToken) |
This request lists the protected resources corresponding to each backup vault. |
|
ListRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest) |
Returns detailed information about the recovery points stored in a backup vault. |
|
ListRecoveryPointsByBackupVaultAsync(ListRecoveryPointsByBackupVaultRequest, CancellationToken) |
Returns detailed information about the recovery points stored in a backup vault. |
|
ListRecoveryPointsByLegalHold(ListRecoveryPointsByLegalHoldRequest) |
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold. |
|
ListRecoveryPointsByLegalHoldAsync(ListRecoveryPointsByLegalHoldRequest, CancellationToken) |
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold. |
|
ListRecoveryPointsByResource(ListRecoveryPointsByResourceRequest) |
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.
|
|
ListRecoveryPointsByResourceAsync(ListRecoveryPointsByResourceRequest, CancellationToken) |
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.
|
|
ListReportJobs(ListReportJobsRequest) |
Returns details about your report jobs. |
|
ListReportJobsAsync(ListReportJobsRequest, CancellationToken) |
Returns details about your report jobs. |
|
ListReportPlans(ListReportPlansRequest) |
Returns a list of your report plans. For detailed information about a single report
plan, use |
|
ListReportPlansAsync(ListReportPlansRequest, CancellationToken) |
Returns a list of your report plans. For detailed information about a single report
plan, use |
|
ListRestoreJobs(ListRestoreJobsRequest) |
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process. |
|
ListRestoreJobsAsync(ListRestoreJobsRequest, CancellationToken) |
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process. |
|
ListRestoreJobsByProtectedResource(ListRestoreJobsByProtectedResourceRequest) |
This returns restore jobs that contain the specified protected resource.
You must include |
|
ListRestoreJobsByProtectedResourceAsync(ListRestoreJobsByProtectedResourceRequest, CancellationToken) |
This returns restore jobs that contain the specified protected resource.
You must include |
|
ListRestoreJobSummaries(ListRestoreJobSummariesRequest) |
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. |
|
ListRestoreJobSummariesAsync(ListRestoreJobSummariesRequest, CancellationToken) |
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. |
|
ListRestoreTestingPlans(ListRestoreTestingPlansRequest) |
Returns a list of restore testing plans. |
|
ListRestoreTestingPlansAsync(ListRestoreTestingPlansRequest, CancellationToken) |
Returns a list of restore testing plans. |
|
ListRestoreTestingSelections(ListRestoreTestingSelectionsRequest) |
Returns a list of restore testing selections. Can be filtered by |
|
ListRestoreTestingSelectionsAsync(ListRestoreTestingSelectionsRequest, CancellationToken) |
Returns a list of restore testing selections. Can be filtered by |
|
ListTags(ListTagsRequest) |
Returns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault. |
|
ListTagsAsync(ListTagsRequest, CancellationToken) |
Returns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault. |
|
PutBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest) |
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. |
|
PutBackupVaultAccessPolicyAsync(PutBackupVaultAccessPolicyRequest, CancellationToken) |
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. |
|
PutBackupVaultLockConfiguration(PutBackupVaultLockConfigurationRequest) |
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.
Backup Vault Lock has been assessed by Cohasset Associates for use in environments
that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about
how Backup Vault Lock relates to these regulations, see the Cohasset
Associates Compliance Assessment.
For more information, see Backup Vault Lock. |
|
PutBackupVaultLockConfigurationAsync(PutBackupVaultLockConfigurationRequest, CancellationToken) |
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.
Backup Vault Lock has been assessed by Cohasset Associates for use in environments
that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about
how Backup Vault Lock relates to these regulations, see the Cohasset
Associates Compliance Assessment.
For more information, see Backup Vault Lock. |
|
PutBackupVaultNotifications(PutBackupVaultNotificationsRequest) |
Turns on notifications on a backup vault for the specified topic and events. |
|
PutBackupVaultNotificationsAsync(PutBackupVaultNotificationsRequest, CancellationToken) |
Turns on notifications on a backup vault for the specified topic and events. |
|
PutRestoreValidationResult(PutRestoreValidationResultRequest) |
This request allows you to send your independent self-run restore test validation
results. |
|
PutRestoreValidationResultAsync(PutRestoreValidationResultRequest, CancellationToken) |
This request allows you to send your independent self-run restore test validation
results. |
|
StartBackupJob(StartBackupJobRequest) |
Starts an on-demand backup job for the specified resource. |
|
StartBackupJobAsync(StartBackupJobRequest, CancellationToken) |
Starts an on-demand backup job for the specified resource. |
|
StartCopyJob(StartCopyJobRequest) |
Starts a job to create a one-time copy of the specified resource. Does not support continuous backups. |
|
StartCopyJobAsync(StartCopyJobRequest, CancellationToken) |
Starts a job to create a one-time copy of the specified resource. Does not support continuous backups. |
|
StartReportJob(StartReportJobRequest) |
Starts an on-demand report job for the specified report plan. |
|
StartReportJobAsync(StartReportJobRequest, CancellationToken) |
Starts an on-demand report job for the specified report plan. |
|
StartRestoreJob(StartRestoreJobRequest) |
Recovers the saved resource identified by an Amazon Resource Name (ARN). |
|
StartRestoreJobAsync(StartRestoreJobRequest, CancellationToken) |
Recovers the saved resource identified by an Amazon Resource Name (ARN). |
|
StopBackupJob(StopBackupJobRequest) |
Attempts to cancel a job to create a one-time backup of a resource. This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP, Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune. |
|
StopBackupJobAsync(StopBackupJobRequest, CancellationToken) |
Attempts to cancel a job to create a one-time backup of a resource. This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP, Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune. |
|
TagResource(TagResourceRequest) |
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN). This API is supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon RDS. |
|
TagResourceAsync(TagResourceRequest, CancellationToken) |
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN). This API is supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon RDS. |
|
UntagResource(UntagResourceRequest) |
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. |
|
UntagResourceAsync(UntagResourceRequest, CancellationToken) |
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. |
|
UpdateBackupPlan(UpdateBackupPlanRequest) |
Updates the specified backup plan. The new version is uniquely identified by its ID. |
|
UpdateBackupPlanAsync(UpdateBackupPlanRequest, CancellationToken) |
Updates the specified backup plan. The new version is uniquely identified by its ID. |
|
UpdateFramework(UpdateFrameworkRequest) |
Updates the specified framework. |
|
UpdateFrameworkAsync(UpdateFrameworkRequest, CancellationToken) |
Updates the specified framework. |
|
UpdateGlobalSettings(UpdateGlobalSettingsRequest) |
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
|
|
UpdateGlobalSettingsAsync(UpdateGlobalSettingsRequest, CancellationToken) |
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
|
|
UpdateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest) |
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 This operation does not support continuous backups. |
|
UpdateRecoveryPointLifecycleAsync(UpdateRecoveryPointLifecycleRequest, CancellationToken) |
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 This operation does not support continuous backups. |
|
UpdateRegionSettings(UpdateRegionSettingsRequest) |
Updates the current service opt-in settings for the Region.
Use the |
|
UpdateRegionSettingsAsync(UpdateRegionSettingsRequest, CancellationToken) |
Updates the current service opt-in settings for the Region.
Use the |
|
UpdateReportPlan(UpdateReportPlanRequest) |
Updates the specified report plan. |
|
UpdateReportPlanAsync(UpdateReportPlanRequest, CancellationToken) |
Updates the specified report plan. |
|
UpdateRestoreTestingPlan(UpdateRestoreTestingPlanRequest) |
This request will send changes to your specified restore testing plan.
|
|
UpdateRestoreTestingPlanAsync(UpdateRestoreTestingPlanRequest, CancellationToken) |
This request will send changes to your specified restore testing plan.
|
|
UpdateRestoreTestingSelection(UpdateRestoreTestingSelectionRequest) |
Updates the specified restore testing selection.
Most elements except the You can use either protected resource ARNs or conditions, but not both. |
|
UpdateRestoreTestingSelectionAsync(UpdateRestoreTestingSelectionRequest, CancellationToken) |
Updates the specified restore testing selection.
Most elements except the You can use either protected resource ARNs or conditions, but not both. |
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5