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.

Classes

NameDescription
Class AlreadyExistsException

Backup exception

Class BackupJob

Contains detailed information about a backup job.

Class BackupPlan

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.

Class BackupPlanInput

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.

Class BackupPlansListMember

Contains metadata about a backup plan.

Class BackupPlanTemplatesListMember

An object specifying metadata associated with a backup plan template.

Class BackupRule

Specifies a scheduled task used to back up a selection of resources.

Class BackupRuleInput

Specifies a scheduled task used to back up a selection of resources.

Class BackupSelection

Used to specify a set of resources to a backup plan.

Class BackupSelectionsListMember

Contains metadata about a BackupSelection object.

Class BackupVaultListMember

Contains metadata about a backup vault.

Class CalculatedLifecycle

Contains DeleteAt and MoveToColdStorageAt timestamps, which are used to specify a lifecycle for a recovery point.

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS 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 “expire after days” 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.

Class Condition

Contains an array of triplets made up of a condition type (such as STRINGEQUALS), a key, and a value. Conditions are used to filter resources in a selection that is assigned to a backup plan.

Class CopyAction

The details of the copy operation.

Class CopyJob

Contains detailed information about a copy job.

Class CreateBackupPlanRequest

Container for the parameters to the CreateBackupPlan operation. Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery points of resources.

If you call CreateBackupPlan with a plan that already exists, an AlreadyExistsException is returned.

Class CreateBackupPlanResponse

This is the response object from the CreateBackupPlan operation.

Class CreateBackupSelectionRequest

Container for the parameters to the CreateBackupSelection operation. Creates a JSON document that specifies a set of resources to assign to a backup plan. Resources can be included by specifying patterns for a ListOfTags and selected Resources.

For example, consider the following patterns:

  • Resources: "arn:aws:ec2:region:account-id:volume/volume-id"

  • ConditionKey:"department"

    ConditionValue:"finance"

    ConditionType:"STRINGEQUALS"

  • ConditionKey:"importance"

    ConditionValue:"critical"

    ConditionType:"STRINGEQUALS"

Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as "department=finance", "importance=critical", in addition to an EBS volume with the specified volume Id.

Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically 'put together using the OR operator. In other words, all patterns that match are selected for backup.

Class CreateBackupSelectionResponse

This is the response object from the CreateBackupSelection operation.

Class CreateBackupVaultRequest

Container for the parameters to the CreateBackupVault operation. 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.

Sensitive data, such as passport numbers, should not be included the name of a backup vault.

Class CreateBackupVaultResponse

This is the response object from the CreateBackupVault operation.

Class DeleteBackupPlanRequest

Container for the parameters to the DeleteBackupPlan operation. 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.

Class DeleteBackupPlanResponse

This is the response object from the DeleteBackupPlan operation.

Class DeleteBackupSelectionRequest

Container for the parameters to the DeleteBackupSelection operation. Deletes the resource selection associated with a backup plan that is specified by the SelectionId.

Class DeleteBackupSelectionResponse

This is the response object from the DeleteBackupSelection operation.

Class DeleteBackupVaultAccessPolicyRequest

Container for the parameters to the DeleteBackupVaultAccessPolicy operation. Deletes the policy document that manages permissions on a backup vault.

Class DeleteBackupVaultAccessPolicyResponse

This is the response object from the DeleteBackupVaultAccessPolicy operation.

Class DeleteBackupVaultNotificationsRequest

Container for the parameters to the DeleteBackupVaultNotifications operation. Deletes event notifications for the specified backup vault.

Class DeleteBackupVaultNotificationsResponse

This is the response object from the DeleteBackupVaultNotifications operation.

Class DeleteBackupVaultRequest

Container for the parameters to the DeleteBackupVault operation. Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.

Class DeleteBackupVaultResponse

This is the response object from the DeleteBackupVault operation.

Class DeleteRecoveryPointRequest

Container for the parameters to the DeleteRecoveryPoint operation. Deletes the recovery point specified by a recovery point ID.

Class DeleteRecoveryPointResponse

This is the response object from the DeleteRecoveryPoint operation.

Class DependencyFailureException

Backup exception

Class DescribeBackupJobRequest

Container for the parameters to the DescribeBackupJob operation. Returns metadata associated with creating a backup of a resource.

Class DescribeBackupJobResponse

This is the response object from the DescribeBackupJob operation.

Class DescribeBackupVaultRequest

Container for the parameters to the DescribeBackupVault operation. Returns metadata about a backup vault specified by its name.

Class DescribeBackupVaultResponse

This is the response object from the DescribeBackupVault operation.

Class DescribeCopyJobRequest

Container for the parameters to the DescribeCopyJob operation. Returns metadata associated with creating a copy of a resource.

Class DescribeCopyJobResponse

This is the response object from the DescribeCopyJob operation.

Class DescribeProtectedResourceRequest

Container for the parameters to the DescribeProtectedResource operation. Returns information about a saved resource, including the last time it was backed-up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource.

Class DescribeProtectedResourceResponse

This is the response object from the DescribeProtectedResource operation.

Class DescribeRecoveryPointRequest

Container for the parameters to the DescribeRecoveryPoint operation. Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.

Class DescribeRecoveryPointResponse

This is the response object from the DescribeRecoveryPoint operation.

Class DescribeRestoreJobRequest

Container for the parameters to the DescribeRestoreJob operation. Returns metadata associated with a restore job that is specified by a job ID.

Class DescribeRestoreJobResponse

This is the response object from the DescribeRestoreJob operation.

Class ExportBackupPlanTemplateRequest

Container for the parameters to the ExportBackupPlanTemplate operation. Returns the backup plan that is specified by the plan ID as a backup template.

Class ExportBackupPlanTemplateResponse

This is the response object from the ExportBackupPlanTemplate operation.

Class GetBackupPlanFromJSONRequest

Container for the parameters to the GetBackupPlanFromJSON operation. Returns a valid JSON document specifying a backup plan or an error.

Class GetBackupPlanFromJSONResponse

This is the response object from the GetBackupPlanFromJSON operation.

Class GetBackupPlanFromTemplateRequest

Container for the parameters to the GetBackupPlanFromTemplate operation. Returns the template specified by its templateId as a backup plan.

Class GetBackupPlanFromTemplateResponse

This is the response object from the GetBackupPlanFromTemplate operation.

Class GetBackupPlanRequest

Container for the parameters to the GetBackupPlan operation. Returns the body of a backup plan in JSON format, in addition to plan metadata.

Class GetBackupPlanResponse

This is the response object from the GetBackupPlan operation.

Class GetBackupSelectionRequest

Container for the parameters to the GetBackupSelection operation. Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.

Class GetBackupSelectionResponse

This is the response object from the GetBackupSelection operation.

Class GetBackupVaultAccessPolicyRequest

Container for the parameters to the GetBackupVaultAccessPolicy operation. Returns the access policy document that is associated with the named backup vault.

Class GetBackupVaultAccessPolicyResponse

This is the response object from the GetBackupVaultAccessPolicy operation.

Class GetBackupVaultNotificationsRequest

Container for the parameters to the GetBackupVaultNotifications operation. Returns event notifications for the specified backup vault.

Class GetBackupVaultNotificationsResponse

This is the response object from the GetBackupVaultNotifications operation.

Class GetRecoveryPointRestoreMetadataRequest

Container for the parameters to the GetRecoveryPointRestoreMetadata operation. Returns a set of metadata key-value pairs that were used to create the backup.

Class GetRecoveryPointRestoreMetadataResponse

This is the response object from the GetRecoveryPointRestoreMetadata operation.

Class GetSupportedResourceTypesRequest

Container for the parameters to the GetSupportedResourceTypes operation. Returns the AWS resource types supported by AWS Backup.

Class GetSupportedResourceTypesResponse

This is the response object from the GetSupportedResourceTypes operation.

Class InvalidParameterValueException

Backup exception

Class InvalidRequestException

Backup exception

Class Lifecycle

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” 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.

Class LimitExceededException

Backup exception

Class ListBackupJobsRequest

Container for the parameters to the ListBackupJobs operation. Returns metadata about your backup jobs.

Class ListBackupJobsResponse

This is the response object from the ListBackupJobs operation.

Class ListBackupPlansRequest

Container for the parameters to the ListBackupPlans operation. Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.

Class ListBackupPlansResponse

This is the response object from the ListBackupPlans operation.

Class ListBackupPlanTemplatesRequest

Container for the parameters to the ListBackupPlanTemplates operation. Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.

Class ListBackupPlanTemplatesResponse

This is the response object from the ListBackupPlanTemplates operation.

Class ListBackupPlanVersionsRequest

Container for the parameters to the ListBackupPlanVersions operation. Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.

Class ListBackupPlanVersionsResponse

This is the response object from the ListBackupPlanVersions operation.

Class ListBackupSelectionsRequest

Container for the parameters to the ListBackupSelections operation. Returns an array containing metadata of the resources associated with the target backup plan.

Class ListBackupSelectionsResponse

This is the response object from the ListBackupSelections operation.

Class ListBackupVaultsRequest

Container for the parameters to the ListBackupVaults operation. Returns a list of recovery point storage containers along with information about them.

Class ListBackupVaultsResponse

This is the response object from the ListBackupVaults operation.

Class ListCopyJobsRequest

Container for the parameters to the ListCopyJobs operation. Returns metadata about your copy jobs.

Class ListCopyJobsResponse

This is the response object from the ListCopyJobs operation.

Class ListProtectedResourcesRequest

Container for the parameters to the ListProtectedResources operation. Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.

Class ListProtectedResourcesResponse

This is the response object from the ListProtectedResources operation.

Class ListRecoveryPointsByBackupVaultRequest

Container for the parameters to the ListRecoveryPointsByBackupVault operation. Returns detailed information about the recovery points stored in a backup vault.

Class ListRecoveryPointsByBackupVaultResponse

This is the response object from the ListRecoveryPointsByBackupVault operation.

Class ListRecoveryPointsByResourceRequest

Container for the parameters to the ListRecoveryPointsByResource operation. Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).

Class ListRecoveryPointsByResourceResponse

This is the response object from the ListRecoveryPointsByResource operation.

Class ListRestoreJobsRequest

Container for the parameters to the ListRestoreJobs operation. Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.

Class ListRestoreJobsResponse

This is the response object from the ListRestoreJobs operation.

Class ListTagsRequest

Container for the parameters to the ListTags operation. Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.

Class ListTagsResponse

This is the response object from the ListTags operation.

Class MissingParameterValueException

Backup exception

Class ProtectedResource

A structure that contains information about a backed-up resource.

Class PutBackupVaultAccessPolicyRequest

Container for the parameters to the PutBackupVaultAccessPolicy operation. 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.

Class PutBackupVaultAccessPolicyResponse

This is the response object from the PutBackupVaultAccessPolicy operation.

Class PutBackupVaultNotificationsRequest

Container for the parameters to the PutBackupVaultNotifications operation. Turns on notifications on a backup vault for the specified topic and events.

Class PutBackupVaultNotificationsResponse

This is the response object from the PutBackupVaultNotifications operation.

Class RecoveryPointByBackupVault

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

Class RecoveryPointByResource

Contains detailed information about a saved recovery point.

Class RecoveryPointCreator

Contains information about the backup plan and rule that AWS Backup used to initiate the recovery point backup.

Class ResourceNotFoundException

Backup exception

Class RestoreJobsListMember

Contains metadata about a restore job.

Class ServiceUnavailableException

Backup exception

Class StartBackupJobRequest

Container for the parameters to the StartBackupJob operation. Starts a job to create a one-time backup of the specified resource.

Class StartBackupJobResponse

This is the response object from the StartBackupJob operation.

Class StartCopyJobRequest

Container for the parameters to the StartCopyJob operation. Starts a job to create a one-time copy of the specified resource.

Class StartCopyJobResponse

This is the response object from the StartCopyJob operation.

Class StartRestoreJobRequest

Container for the parameters to the StartRestoreJob operation. Recovers the saved resource identified by an Amazon Resource Name (ARN).

If the resource ARN is included in the request, then the last complete backup of that resource is recovered. If the ARN of a recovery point is supplied, then that recovery point is restored.

Class StartRestoreJobResponse

This is the response object from the StartRestoreJob operation.

Class StopBackupJobRequest

Container for the parameters to the StopBackupJob operation. Attempts to cancel a job to create a one-time backup of a resource.

Class StopBackupJobResponse

This is the response object from the StopBackupJob operation.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).

Class TagResourceResponse

This is the response object from the TagResource operation.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateBackupPlanRequest

Container for the parameters to the UpdateBackupPlan operation. Replaces the body of a saved backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.

Class UpdateBackupPlanResponse

This is the response object from the UpdateBackupPlan operation.

Class UpdateRecoveryPointLifecycleRequest

Container for the parameters to the UpdateRecoveryPointLifecycle operation. Sets the transition lifecycle of a recovery point.

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS 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 “expire after days” 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.

Class UpdateRecoveryPointLifecycleResponse

This is the response object from the UpdateRecoveryPointLifecycle operation.