AWS SDK Version 3 for .NET
API Reference

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

Backup

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.Backup.AmazonBackupClient

Namespace: Amazon.Backup
Assembly: AWSSDK.Backup.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonBackupClient : AmazonServiceClient
         IAmazonBackup, IAmazonService, IDisposable

The AmazonBackupClient type exposes the following members

Constructors

NameDescription
Public Method 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>
             

Public Method 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>
             

Public Method 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>
             

Public Method AmazonBackupClient(AWSCredentials)

Constructs AmazonBackupClient with AWS Credentials

Public Method AmazonBackupClient(AWSCredentials, RegionEndpoint)

Constructs AmazonBackupClient with AWS Credentials

Public Method AmazonBackupClient(AWSCredentials, AmazonBackupConfig)

Constructs AmazonBackupClient with AWS Credentials and an AmazonBackupClient Configuration object.

Public Method AmazonBackupClient(string, string)

Constructs AmazonBackupClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonBackupClient(string, string, RegionEndpoint)

Constructs AmazonBackupClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonBackupClient(string, string, AmazonBackupConfig)

Constructs AmazonBackupClient with AWS Access Key ID, AWS Secret Key and an AmazonBackupClient Configuration object.

Public Method AmazonBackupClient(string, string, string)

Constructs AmazonBackupClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonBackupClient(string, string, string, RegionEndpoint)

Constructs AmazonBackupClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonBackupClient(string, string, string, AmazonBackupConfig)

Constructs AmazonBackupClient with AWS Access Key ID, AWS Secret Key and an AmazonBackupClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.
Public Property Paginators Amazon.Backup.Model.IBackupPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CancelLegalHold(CancelLegalHoldRequest)

This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.

Public Method CancelLegalHoldAsync(CancelLegalHoldRequest, CancellationToken)

This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.

Public Method 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 CreateBackupPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Public Method 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 CreateBackupPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Public Method CreateBackupSelection(CreateBackupSelectionRequest)

Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically.

Public Method 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.

Public Method CreateBackupVault(CreateBackupVaultRequest)

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.

Public Method CreateBackupVaultAsync(CreateBackupVaultRequest, CancellationToken)

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.

Public Method 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.

Public Method 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.

Public Method CreateLegalHold(CreateLegalHoldRequest)

This action 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.

Public Method CreateLegalHoldAsync(CreateLegalHoldRequest, CancellationToken)

This action 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.

Public Method CreateLogicallyAirGappedBackupVault(CreateLogicallyAirGappedBackupVaultRequest)

This request 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.

Public Method CreateLogicallyAirGappedBackupVaultAsync(CreateLogicallyAirGappedBackupVaultRequest, CancellationToken)

This request 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.

Public Method 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 CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Public Method 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 CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Public Method CreateRestoreTestingPlan(CreateRestoreTestingPlanRequest)

This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.

You must include the parameter RestoreTestingPlan. You may optionally include CreatorRequestId and Tags.

Public Method CreateRestoreTestingPlanAsync(CreateRestoreTestingPlanRequest, CancellationToken)

This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.

You must include the parameter RestoreTestingPlan. You may optionally include CreatorRequestId and Tags.

Public Method 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 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.

Public Method 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 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.

Public Method 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.

Public Method 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.

Public Method DeleteBackupSelection(DeleteBackupSelectionRequest)

Deletes the resource selection associated with a backup plan that is specified by the SelectionId.

Public Method DeleteBackupSelectionAsync(DeleteBackupSelectionRequest, CancellationToken)

Deletes the resource selection associated with a backup plan that is specified by the SelectionId.

Public Method DeleteBackupVault(DeleteBackupVaultRequest)

Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.

Public Method DeleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest)

Deletes the policy document that manages permissions on a backup vault.

Public Method DeleteBackupVaultAccessPolicyAsync(DeleteBackupVaultAccessPolicyRequest, CancellationToken)

Deletes the policy document that manages permissions on a backup vault.

Public Method DeleteBackupVaultAsync(DeleteBackupVaultRequest, CancellationToken)

Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.

Public Method 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 InvalidRequestException if you attempt to do so. For more information, see Vault Lock in the Backup Developer Guide.

Public Method 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 InvalidRequestException if you attempt to do so. For more information, see Vault Lock in the Backup Developer Guide.

Public Method DeleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest)

Deletes event notifications for the specified backup vault.

Public Method DeleteBackupVaultNotificationsAsync(DeleteBackupVaultNotificationsRequest, CancellationToken)

Deletes event notifications for the specified backup vault.

Public Method DeleteFramework(DeleteFrameworkRequest)

Deletes the framework specified by a framework name.

Public Method DeleteFrameworkAsync(DeleteFrameworkRequest, CancellationToken)

Deletes the framework specified by a framework name.

Public Method 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 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.

Public Method 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 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.

Public Method DeleteReportPlan(DeleteReportPlanRequest)

Deletes the report plan specified by a report plan name.

Public Method DeleteReportPlanAsync(DeleteReportPlanRequest, CancellationToken)

Deletes the report plan specified by a report plan name.

Public Method DeleteRestoreTestingPlan(DeleteRestoreTestingPlanRequest)

This request deletes the specified restore testing plan.

Deletion can only successfully occur if all associated restore testing selections are deleted first.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method DescribeBackupJob(DescribeBackupJobRequest)

Returns backup job details for the specified BackupJobId.

Public Method DescribeBackupJobAsync(DescribeBackupJobRequest, CancellationToken)

Returns backup job details for the specified BackupJobId.

Public Method DescribeBackupVault(DescribeBackupVaultRequest)

Returns metadata about a backup vault specified by its name.

Public Method DescribeBackupVaultAsync(DescribeBackupVaultRequest, CancellationToken)

Returns metadata about a backup vault specified by its name.

Public Method DescribeCopyJob(DescribeCopyJobRequest)

Returns metadata associated with creating a copy of a resource.

Public Method DescribeCopyJobAsync(DescribeCopyJobRequest, CancellationToken)

Returns metadata associated with creating a copy of a resource.

Public Method DescribeFramework(DescribeFrameworkRequest)

Returns the framework details for the specified FrameworkName.

Public Method DescribeFrameworkAsync(DescribeFrameworkRequest, CancellationToken)

Returns the framework details for the specified FrameworkName.

Public Method 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: describe-global-settings --region us-west-2

Public Method 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: describe-global-settings --region us-west-2

Public Method 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.

Public Method 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.

Public Method DescribeRecoveryPoint(DescribeRecoveryPointRequest)

Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.

Public Method DescribeRecoveryPointAsync(DescribeRecoveryPointRequest, CancellationToken)

Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.

Public Method 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.

Public Method 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.

Public Method DescribeReportJob(DescribeReportJobRequest)

Returns the details associated with creating a report as specified by its ReportJobId.

Public Method DescribeReportJobAsync(DescribeReportJobRequest, CancellationToken)

Returns the details associated with creating a report as specified by its ReportJobId.

Public Method DescribeReportPlan(DescribeReportPlanRequest)

Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.

Public Method DescribeReportPlanAsync(DescribeReportPlanRequest, CancellationToken)

Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.

Public Method DescribeRestoreJob(DescribeRestoreJobRequest)

Returns metadata associated with a restore job that is specified by a job ID.

Public Method DescribeRestoreJobAsync(DescribeRestoreJobRequest, CancellationToken)

Returns metadata associated with a restore job that is specified by a job ID.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method ExportBackupPlanTemplate(ExportBackupPlanTemplateRequest)

Returns the backup plan that is specified by the plan ID as a backup template.

Public Method ExportBackupPlanTemplateAsync(ExportBackupPlanTemplateRequest, CancellationToken)

Returns the backup plan that is specified by the plan ID as a backup template.

Public Method GetBackupPlan(GetBackupPlanRequest)

Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.

Public Method GetBackupPlanAsync(GetBackupPlanRequest, CancellationToken)

Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.

Public Method GetBackupPlanFromJSON(GetBackupPlanFromJSONRequest)

Returns a valid JSON document specifying a backup plan or an error.

Public Method GetBackupPlanFromJSONAsync(GetBackupPlanFromJSONRequest, CancellationToken)

Returns a valid JSON document specifying a backup plan or an error.

Public Method GetBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest)

Returns the template specified by its templateId as a backup plan.

Public Method GetBackupPlanFromTemplateAsync(GetBackupPlanFromTemplateRequest, CancellationToken)

Returns the template specified by its templateId as a backup plan.

Public Method GetBackupSelection(GetBackupSelectionRequest)

Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.

Public Method 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.

Public Method GetBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest)

Returns the access policy document that is associated with the named backup vault.

Public Method GetBackupVaultAccessPolicyAsync(GetBackupVaultAccessPolicyRequest, CancellationToken)

Returns the access policy document that is associated with the named backup vault.

Public Method GetBackupVaultNotifications(GetBackupVaultNotificationsRequest)

Returns event notifications for the specified backup vault.

Public Method GetBackupVaultNotificationsAsync(GetBackupVaultNotificationsRequest, CancellationToken)

Returns event notifications for the specified backup vault.

Public Method 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.

Public Method 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.

Public Method GetRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest)

Returns a set of metadata key-value pairs that were used to create the backup.

Public Method GetRecoveryPointRestoreMetadataAsync(GetRecoveryPointRestoreMetadataRequest, CancellationToken)

Returns a set of metadata key-value pairs that were used to create the backup.

Public Method GetRestoreJobMetadata(GetRestoreJobMetadataRequest)

This request returns the metadata for the specified restore job.

Public Method GetRestoreJobMetadataAsync(GetRestoreJobMetadataRequest, CancellationToken)

This request returns the metadata for the specified restore job.

Public Method GetRestoreTestingInferredMetadata(GetRestoreTestingInferredMetadataRequest)

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.

Public Method GetRestoreTestingInferredMetadataAsync(GetRestoreTestingInferredMetadataRequest, CancellationToken)

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.

Public Method GetRestoreTestingPlan(GetRestoreTestingPlanRequest)

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.

Public Method GetRestoreTestingPlanAsync(GetRestoreTestingPlanRequest, CancellationToken)

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.

Public Method GetRestoreTestingSelection(GetRestoreTestingSelectionRequest)

Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.

Public Method GetRestoreTestingSelectionAsync(GetRestoreTestingSelectionRequest, CancellationToken)

Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.

Public Method GetSupportedResourceTypes(GetSupportedResourceTypesRequest)

Returns the Amazon Web Services resource types supported by Backup.

Public Method GetSupportedResourceTypesAsync(GetSupportedResourceTypesRequest, CancellationToken)

Returns the Amazon Web Services resource types supported by Backup.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method ListBackupPlans(ListBackupPlansRequest)

Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.

Public Method ListBackupPlansAsync(ListBackupPlansRequest, CancellationToken)

Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.

Public Method ListBackupPlanTemplates(ListBackupPlanTemplatesRequest)

Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.

Public Method ListBackupPlanTemplatesAsync(ListBackupPlanTemplatesRequest, CancellationToken)

Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.

Public Method 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.

Public Method 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.

Public Method ListBackupSelections(ListBackupSelectionsRequest)

Returns an array containing metadata of the resources associated with the target backup plan.

Public Method ListBackupSelectionsAsync(ListBackupSelectionsRequest, CancellationToken)

Returns an array containing metadata of the resources associated with the target backup plan.

Public Method ListBackupVaults(ListBackupVaultsRequest)

Returns a list of recovery point storage containers along with information about them.

Public Method ListBackupVaultsAsync(ListBackupVaultsRequest, CancellationToken)

Returns a list of recovery point storage containers along with information about them.

Public Method ListCopyJobs(ListCopyJobsRequest)

Returns metadata about your copy jobs.

Public Method ListCopyJobsAsync(ListCopyJobsRequest, CancellationToken)

Returns metadata about your copy jobs.

Public Method 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.

Public Method 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.

Public Method ListFrameworks(ListFrameworksRequest)

Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.

Public Method ListFrameworksAsync(ListFrameworksRequest, CancellationToken)

Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.

Public Method ListLegalHolds(ListLegalHoldsRequest)

This action returns metadata about active and previous legal holds.

Public Method ListLegalHoldsAsync(ListLegalHoldsRequest, CancellationToken)

This action returns metadata about active and previous legal holds.

Public Method 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.

Public Method 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.

Public Method ListProtectedResourcesByBackupVault(ListProtectedResourcesByBackupVaultRequest)

This request lists the protected resources corresponding to each backup vault.

Public Method ListProtectedResourcesByBackupVaultAsync(ListProtectedResourcesByBackupVaultRequest, CancellationToken)

This request lists the protected resources corresponding to each backup vault.

Public Method ListRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest)

Returns detailed information about the recovery points stored in a backup vault.

Public Method ListRecoveryPointsByBackupVaultAsync(ListRecoveryPointsByBackupVaultRequest, CancellationToken)

Returns detailed information about the recovery points stored in a backup vault.

Public Method ListRecoveryPointsByLegalHold(ListRecoveryPointsByLegalHoldRequest)

This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.

Public Method ListRecoveryPointsByLegalHoldAsync(ListRecoveryPointsByLegalHoldRequest, CancellationToken)

This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.

Public Method ListRecoveryPointsByResource(ListRecoveryPointsByResourceRequest)

Returns detailed information about all 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.

Public Method ListRecoveryPointsByResourceAsync(ListRecoveryPointsByResourceRequest, CancellationToken)

Returns detailed information about all 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.

Public Method ListReportJobs(ListReportJobsRequest)

Returns details about your report jobs.

Public Method ListReportJobsAsync(ListReportJobsRequest, CancellationToken)

Returns details about your report jobs.

Public Method ListReportPlans(ListReportPlansRequest)

Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.

Public Method ListReportPlansAsync(ListReportPlansRequest, CancellationToken)

Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.

Public Method ListRestoreJobs(ListRestoreJobsRequest)

Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.

Public Method ListRestoreJobsAsync(ListRestoreJobsRequest, CancellationToken)

Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.

Public Method ListRestoreJobsByProtectedResource(ListRestoreJobsByProtectedResourceRequest)

This returns restore jobs that contain the specified protected resource.

You must include ResourceArn. You can optionally include NextToken, ByStatus, MaxResults, ByRecoveryPointCreationDateAfter , and ByRecoveryPointCreationDateBefore.

Public Method ListRestoreJobsByProtectedResourceAsync(ListRestoreJobsByProtectedResourceRequest, CancellationToken)

This returns restore jobs that contain the specified protected resource.

You must include ResourceArn. You can optionally include NextToken, ByStatus, MaxResults, ByRecoveryPointCreationDateAfter , and ByRecoveryPointCreationDateBefore.

Public Method 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.

Public Method 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.

Public Method ListRestoreTestingPlans(ListRestoreTestingPlansRequest)

Returns a list of restore testing plans.

Public Method ListRestoreTestingPlansAsync(ListRestoreTestingPlansRequest, CancellationToken)

Returns a list of restore testing plans.

Public Method ListRestoreTestingSelections(ListRestoreTestingSelectionsRequest)

Returns a list of restore testing selections. Can be filtered by MaxResults and RestoreTestingPlanName.

Public Method ListRestoreTestingSelectionsAsync(ListRestoreTestingSelectionsRequest, CancellationToken)

Returns a list of restore testing selections. Can be filtered by MaxResults and RestoreTestingPlanName.

Public Method ListTags(ListTagsRequest)

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.

ListTags only works for resource types that support full Backup management of their backups. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table.

Public Method ListTagsAsync(ListTagsRequest, CancellationToken)

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.

ListTags only works for resource types that support full Backup management of their backups. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method PutBackupVaultNotifications(PutBackupVaultNotificationsRequest)

Turns on notifications on a backup vault for the specified topic and events.

Public Method PutBackupVaultNotificationsAsync(PutBackupVaultNotificationsRequest, CancellationToken)

Turns on notifications on a backup vault for the specified topic and events.

Public Method PutRestoreValidationResult(PutRestoreValidationResultRequest)

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.

Public Method PutRestoreValidationResultAsync(PutRestoreValidationResultRequest, CancellationToken)

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.

Public Method StartBackupJob(StartBackupJobRequest)

Starts an on-demand backup job for the specified resource.

Public Method StartBackupJobAsync(StartBackupJobRequest, CancellationToken)

Starts an on-demand backup job for the specified resource.

Public Method StartCopyJob(StartCopyJobRequest)

Starts a job to create a one-time copy of the specified resource.

Does not support continuous backups.

Public Method StartCopyJobAsync(StartCopyJobRequest, CancellationToken)

Starts a job to create a one-time copy of the specified resource.

Does not support continuous backups.

Public Method StartReportJob(StartReportJobRequest)

Starts an on-demand report job for the specified report plan.

Public Method StartReportJobAsync(StartReportJobRequest, CancellationToken)

Starts an on-demand report job for the specified report plan.

Public Method StartRestoreJob(StartRestoreJobRequest)

Recovers the saved resource identified by an Amazon Resource Name (ARN).

Public Method StartRestoreJobAsync(StartRestoreJobRequest, CancellationToken)

Recovers the saved resource identified by an Amazon Resource Name (ARN).

Public Method 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.

Public Method 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.

Public Method 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).

Public Method 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).

Public Method 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)

Public Method 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)

Public Method UpdateBackupPlan(UpdateBackupPlanRequest)

Updates an existing backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.

Public Method UpdateBackupPlanAsync(UpdateBackupPlanRequest, CancellationToken)

Updates an existing backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.

Public Method UpdateFramework(UpdateFrameworkRequest)

Updates an existing framework identified by its FrameworkName with the input document in JSON format.

Public Method UpdateFrameworkAsync(UpdateFrameworkRequest, CancellationToken)

Updates an existing framework identified by its FrameworkName with the input document in JSON format.

Public Method 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 DescribeGlobalSettings API to determine the current settings.

Public Method 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 DescribeGlobalSettings API to determine the current settings.

Public Method 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.

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.

Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

This operation does not support continuous backups.

Public Method 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.

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.

Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

This operation does not support continuous backups.

Public Method UpdateRegionSettings(UpdateRegionSettingsRequest)

Updates the current service opt-in settings for the Region.

Use the DescribeRegionSettings API to determine the resource types that are supported.

Public Method UpdateRegionSettingsAsync(UpdateRegionSettingsRequest, CancellationToken)

Updates the current service opt-in settings for the Region.

Use the DescribeRegionSettings API to determine the resource types that are supported.

Public Method UpdateReportPlan(UpdateReportPlanRequest)

Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.

Public Method UpdateReportPlanAsync(UpdateReportPlanRequest, CancellationToken)

Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.

Public Method UpdateRestoreTestingPlan(UpdateRestoreTestingPlanRequest)

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

Public Method UpdateRestoreTestingPlanAsync(UpdateRestoreTestingPlanRequest, CancellationToken)

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

Public Method UpdateRestoreTestingSelection(UpdateRestoreTestingSelectionRequest)

Most elements except the RestoreTestingSelectionName can be updated with this request.

RestoreTestingSelection can use either protected resource ARNs or conditions, but not both. That is, if your selection has ProtectedResourceArns, requesting an update with the parameter ProtectedResourceConditions will be unsuccessful.

Public Method UpdateRestoreTestingSelectionAsync(UpdateRestoreTestingSelectionRequest, CancellationToken)

Most elements except the RestoreTestingSelectionName can be updated with this request.

RestoreTestingSelection can use either protected resource ARNs or conditions, but not both. That is, if your selection has ProtectedResourceArns, requesting an update with the parameter ProtectedResourceConditions will be unsuccessful.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5