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 AdvancedBackupSetting

A list of backup options for each resource type.

Class AlreadyExistsException

The required resource already exists.

Class BackupJob

Contains detailed information about a backup job.

Class BackupJobSummary

This is a summary of jobs created or running within the most recent 30 days.

The returned summary may contain the following: Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Class BackupPaginatorFactory

Paginators for the Backup service

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 Amazon Web Services 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.

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.

Specifying your desired Conditions, ListOfTags, NotResources, and/or Resources is recommended. If none of these are specified, Backup will attempt to select all supported and opted-in storage resources, which could have unintended cost implications.

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

Class CancelLegalHoldRequest

Container for the parameters to the CancelLegalHold operation. This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.

Class CancelLegalHoldResponse

This is the response object from the CancelLegalHold operation.

Class Condition

Contains an array of triplets made up of a condition type (such as StringEquals), a key, and a value. Used to filter resources using their tags and assign them to a backup plan. Case sensitive.

Class ConditionParameter

Includes information about tags you define to assign tagged resources to a backup plan.

Class Conditions

Contains information about which resources to include or exclude from a backup plan using their tags. Conditions are case sensitive.

Class ConflictException

Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.

Class ControlInputParameter

A list of parameters for a control. A control can have zero, one, or more than one parameter. An example of a control with two parameters is: "backup plan frequency is at least daily and the retention period is at least 1 year". The first parameter is daily. The second parameter is 1 year.

Class ControlScope

A framework consists of one or more controls. Each control has its own control scope. The control scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. If no scope is specified, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

To set a control scope that includes all of a particular resource, leave the ControlScope empty or do not pass it when calling CreateFramework.

Class CopyAction

The details of the copy operation.

Class CopyJob

Contains detailed information about a copy job.

Class CopyJobSummary

This is a summary of copy jobs created or running within the most recent 30 days.

The returned summary may contain the following: Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Class CreateBackupPlanRequest

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

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. For examples, see Assigning resources programmatically.

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.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

Class CreateBackupVaultResponse

This is the response object from the CreateBackupVault operation.

Class CreateFrameworkRequest

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

Class CreateFrameworkResponse

This is the response object from the CreateFramework operation.

Class CreateLegalHoldRequest

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

Class CreateLegalHoldResponse

This is the response object from the CreateLegalHold operation.

Class CreateLogicallyAirGappedBackupVaultRequest

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

Class CreateLogicallyAirGappedBackupVaultResponse

This is the response object from the CreateLogicallyAirGappedBackupVault operation.

Class CreateReportPlanRequest

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

Class CreateReportPlanResponse

This is the response object from the CreateReportPlan operation.

Class CreateRestoreTestingPlanRequest

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

Class CreateRestoreTestingPlanResponse

This is the response object from the CreateRestoreTestingPlan operation.

Class CreateRestoreTestingSelectionRequest

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

Class CreateRestoreTestingSelectionResponse

This is the response object from the CreateRestoreTestingSelection operation.

Class DateRange

This is a resource filter containing FromDate: DateTime and ToDate: DateTime. Both values are required. Future DateTime values are not permitted.

The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds ((milliseconds are optional). For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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 DeleteBackupVaultLockConfigurationRequest

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

Class DeleteBackupVaultLockConfigurationResponse

This is the response object from the DeleteBackupVaultLockConfiguration 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 DeleteFrameworkRequest

Container for the parameters to the DeleteFramework operation. Deletes the framework specified by a framework name.

Class DeleteFrameworkResponse

This is the response object from the DeleteFramework operation.

Class DeleteRecoveryPointRequest

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

Class DeleteRecoveryPointResponse

This is the response object from the DeleteRecoveryPoint operation.

Class DeleteReportPlanRequest

Container for the parameters to the DeleteReportPlan operation. Deletes the report plan specified by a report plan name.

Class DeleteReportPlanResponse

This is the response object from the DeleteReportPlan operation.

Class DeleteRestoreTestingPlanRequest

Container for the parameters to the DeleteRestoreTestingPlan operation. This request deletes the specified restore testing plan.

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

Class DeleteRestoreTestingPlanResponse

This is the response object from the DeleteRestoreTestingPlan operation.

Class DeleteRestoreTestingSelectionRequest

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

Class DeleteRestoreTestingSelectionResponse

This is the response object from the DeleteRestoreTestingSelection operation.

Class DependencyFailureException

A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.

Class DescribeBackupJobRequest

Container for the parameters to the DescribeBackupJob operation. Returns backup job details for the specified BackupJobId.

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 DescribeFrameworkRequest

Container for the parameters to the DescribeFramework operation. Returns the framework details for the specified FrameworkName.

Class DescribeFrameworkResponse

This is the response object from the DescribeFramework operation.

Class DescribeGlobalSettingsRequest

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

Class DescribeGlobalSettingsResponse

This is the response object from the DescribeGlobalSettings 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 Amazon Web Services 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 DescribeRegionSettingsRequest

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

Class DescribeRegionSettingsResponse

This is the response object from the DescribeRegionSettings operation.

Class DescribeReportJobRequest

Container for the parameters to the DescribeReportJob operation. Returns the details associated with creating a report as specified by its ReportJobId.

Class DescribeReportJobResponse

This is the response object from the DescribeReportJob operation.

Class DescribeReportPlanRequest

Container for the parameters to the DescribeReportPlan operation. Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.

Class DescribeReportPlanResponse

This is the response object from the DescribeReportPlan 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 DisassociateRecoveryPointFromParentRequest

Container for the parameters to the DisassociateRecoveryPointFromParent operation. This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.

Class DisassociateRecoveryPointFromParentResponse

This is the response object from the DisassociateRecoveryPointFromParent operation.

Class DisassociateRecoveryPointRequest

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

Class DisassociateRecoveryPointResponse

This is the response object from the DisassociateRecoveryPoint 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 Framework

Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.

Class FrameworkControl

Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.

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 BackupPlan details for the specified BackupPlanId. The details are 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 GetLegalHoldRequest

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

Class GetLegalHoldResponse

This is the response object from the GetLegalHold 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 GetRestoreJobMetadataRequest

Container for the parameters to the GetRestoreJobMetadata operation. This request returns the metadata for the specified restore job.

Class GetRestoreJobMetadataResponse

This is the response object from the GetRestoreJobMetadata operation.

Class GetRestoreTestingInferredMetadataRequest

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

Class GetRestoreTestingInferredMetadataResponse

This is the response object from the GetRestoreTestingInferredMetadata operation.

Class GetRestoreTestingPlanRequest

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

Class GetRestoreTestingPlanResponse

This is the response object from the GetRestoreTestingPlan operation.

Class GetRestoreTestingSelectionRequest

Container for the parameters to the GetRestoreTestingSelection operation. Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.

Class GetRestoreTestingSelectionResponse

This is the response object from the GetRestoreTestingSelection operation.

Class GetSupportedResourceTypesRequest

Container for the parameters to the GetSupportedResourceTypes operation. Returns the Amazon Web Services resource types supported by Backup.

Class GetSupportedResourceTypesResponse

This is the response object from the GetSupportedResourceTypes operation.

Class InvalidParameterValueException

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

Class InvalidRequestException

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

Class InvalidResourceStateException

Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.

Class KeyValue

Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: + - = . _ : /

Class LegalHold

A legal hold is an administrative tool that helps prevent backups from being deleted while under a hold. While the hold is in place, backups under a hold cannot be deleted and lifecycle policies that would alter the backup status (such as transition to cold storage) are delayed until the legal hold is removed. A backup can have more than one legal hold. Legal holds are applied to one or more backups (also known as recovery points). These backups can be filtered by resource types and by resource IDs.

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 “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.

Class LimitExceededException

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

Class ListBackupJobsRequest

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

Class ListBackupJobsResponse

This is the response object from the ListBackupJobs operation.

Class ListBackupJobSummariesRequest

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

Class ListBackupJobSummariesResponse

This is the response object from the ListBackupJobSummaries operation.

Class ListBackupPlansRequest

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

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 ListCopyJobSummariesRequest

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

Class ListCopyJobSummariesResponse

This is the response object from the ListCopyJobSummaries operation.

Class ListFrameworksRequest

Container for the parameters to the ListFrameworks operation. Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.

Class ListFrameworksResponse

This is the response object from the ListFrameworks operation.

Class ListLegalHoldsRequest

Container for the parameters to the ListLegalHolds operation. This action returns metadata about active and previous legal holds.

Class ListLegalHoldsResponse

This is the response object from the ListLegalHolds operation.

Class ListProtectedResourcesByBackupVaultRequest

Container for the parameters to the ListProtectedResourcesByBackupVault operation. This request lists the protected resources corresponding to each backup vault.

Class ListProtectedResourcesByBackupVaultResponse

This is the response object from the ListProtectedResourcesByBackupVault operation.

Class ListProtectedResourcesRequest

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

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 ListRecoveryPointsByLegalHoldRequest

Container for the parameters to the ListRecoveryPointsByLegalHold operation. This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.

Class ListRecoveryPointsByLegalHoldResponse

This is the response object from the ListRecoveryPointsByLegalHold operation.

Class ListRecoveryPointsByResourceRequest

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

Class ListRecoveryPointsByResourceResponse

This is the response object from the ListRecoveryPointsByResource operation.

Class ListReportJobsRequest

Container for the parameters to the ListReportJobs operation. Returns details about your report jobs.

Class ListReportJobsResponse

This is the response object from the ListReportJobs operation.

Class ListReportPlansRequest

Container for the parameters to the ListReportPlans operation. Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.

Class ListReportPlansResponse

This is the response object from the ListReportPlans operation.

Class ListRestoreJobsByProtectedResourceRequest

Container for the parameters to the ListRestoreJobsByProtectedResource operation. This returns restore jobs that contain the specified protected resource.

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

Class ListRestoreJobsByProtectedResourceResponse

This is the response object from the ListRestoreJobsByProtectedResource operation.

Class ListRestoreJobsRequest

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

Class ListRestoreJobsResponse

This is the response object from the ListRestoreJobs operation.

Class ListRestoreJobSummariesRequest

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

Class ListRestoreJobSummariesResponse

This is the response object from the ListRestoreJobSummaries operation.

Class ListRestoreTestingPlansRequest

Container for the parameters to the ListRestoreTestingPlans operation. Returns a list of restore testing plans.

Class ListRestoreTestingPlansResponse

This is the response object from the ListRestoreTestingPlans operation.

Class ListRestoreTestingSelectionsRequest

Container for the parameters to the ListRestoreTestingSelections operation. Returns a list of restore testing selections. Can be filtered by MaxResults and RestoreTestingPlanName.

Class ListRestoreTestingSelectionsResponse

This is the response object from the ListRestoreTestingSelections 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.

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.

Class ListTagsResponse

This is the response object from the ListTags operation.

Class MissingParameterValueException

Indicates that a required parameter is missing.

Class ProtectedResource

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

Class ProtectedResourceConditions

A list of conditions that you define for resources in your restore testing plan using tags.

For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "true" },. Condition operators are case sensitive.

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 PutBackupVaultLockConfigurationRequest

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

Class PutBackupVaultLockConfigurationResponse

This is the response object from the PutBackupVaultLockConfiguration 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 PutRestoreValidationResultRequest

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

Class PutRestoreValidationResultResponse

This is the response object from the PutRestoreValidationResult 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 Backup used to initiate the recovery point backup.

Class RecoveryPointMember

This is a recovery point which is a child (nested) recovery point of a parent (composite) recovery point. These recovery points can be disassociated from their parent (composite) recovery point, in which case they will no longer be a member.

Class RecoveryPointSelection

This specifies criteria to assign a set of resources, such as resource types or backup vaults.

Class ReportDeliveryChannel

Contains information from your report plan about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

Class ReportDestination

Contains information from your report job about your report destination.

Class ReportJob

Contains detailed information about a report job. A report job compiles a report based on a report plan and publishes it to Amazon S3.

Class ReportPlan

Contains detailed information about a report plan.

Class ReportSetting

Contains detailed information about a report setting.

Class ResourceNotFoundException

A resource that is required for the action doesn't exist.

Class RestoreJobCreator

Contains information about the restore testing plan that Backup used to initiate the restore job.

Class RestoreJobsListMember

Contains metadata about a restore job.

Class RestoreJobSummary

This is a summary of restore jobs created or running within the most recent 30 days.

The returned summary may contain the following: Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

Class RestoreTestingPlanForCreate

This contains metadata about a restore testing plan.

Class RestoreTestingPlanForGet

This contains metadata about a restore testing plan.

Class RestoreTestingPlanForList

This contains metadata about a restore testing plan.

Class RestoreTestingPlanForUpdate

This contains metadata about a restore testing plan.

Class RestoreTestingRecoveryPointSelection

Required: Algorithm; Required: Recovery point types; IncludeVaults(one or more). Optional: SelectionWindowDays ('30' if not specified);ExcludeVaults (list of selectors), defaults to empty list if not listed.

Class RestoreTestingSelectionForCreate

This contains metadata about a specific restore testing selection.

ProtectedResourceType is required, such as Amazon EBS or Amazon EC2.

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.

ProtectedResourceConditions examples include as StringEquals and StringNotEquals.

Class RestoreTestingSelectionForGet

This contains metadata about a restore testing selection.

Class RestoreTestingSelectionForList

This contains metadata about a restore testing selection.

Class RestoreTestingSelectionForUpdate

This contains metadata about a restore testing selection.

Class ServiceUnavailableException

The request failed due to a temporary failure of the server.

Class StartBackupJobRequest

Container for the parameters to the StartBackupJob operation. Starts an on-demand backup job for 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.

Does not support continuous backups.

Class StartCopyJobResponse

This is the response object from the StartCopyJob operation.

Class StartReportJobRequest

Container for the parameters to the StartReportJob operation. Starts an on-demand report job for the specified report plan.

Class StartReportJobResponse

This is the response object from the StartReportJob operation.

Class StartRestoreJobRequest

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

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.

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.

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

Class UpdateBackupPlanResponse

This is the response object from the UpdateBackupPlan operation.

Class UpdateFrameworkRequest

Container for the parameters to the UpdateFramework operation. Updates an existing framework identified by its FrameworkName with the input document in JSON format.

Class UpdateFrameworkResponse

This is the response object from the UpdateFramework operation.

Class UpdateGlobalSettingsRequest

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

Class UpdateGlobalSettingsResponse

This is the response object from the UpdateGlobalSettings 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. 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.

Class UpdateRecoveryPointLifecycleResponse

This is the response object from the UpdateRecoveryPointLifecycle operation.

Class UpdateRegionSettingsRequest

Container for the parameters to the UpdateRegionSettings operation. Updates the current service opt-in settings for the Region.

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

Class UpdateRegionSettingsResponse

This is the response object from the UpdateRegionSettings operation.

Class UpdateReportPlanRequest

Container for the parameters to the UpdateReportPlan operation. Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.

Class UpdateReportPlanResponse

This is the response object from the UpdateReportPlan operation.

Class UpdateRestoreTestingPlanRequest

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

Class UpdateRestoreTestingPlanResponse

This is the response object from the UpdateRestoreTestingPlan operation.

Class UpdateRestoreTestingSelectionRequest

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

Class UpdateRestoreTestingSelectionResponse

This is the response object from the UpdateRestoreTestingSelection operation.

Interfaces

NameDescription
Interface IBackupPaginatorFactory

Paginators for the Backup service

Interface IListBackupJobsPaginator

Paginator for the ListBackupJobs operation

Interface IListBackupJobSummariesPaginator

Paginator for the ListBackupJobSummaries operation

Interface IListBackupPlansPaginator

Paginator for the ListBackupPlans operation

Interface IListBackupPlanTemplatesPaginator

Paginator for the ListBackupPlanTemplates operation

Interface IListBackupPlanVersionsPaginator

Paginator for the ListBackupPlanVersions operation

Interface IListBackupSelectionsPaginator

Paginator for the ListBackupSelections operation

Interface IListBackupVaultsPaginator

Paginator for the ListBackupVaults operation

Interface IListCopyJobsPaginator

Paginator for the ListCopyJobs operation

Interface IListCopyJobSummariesPaginator

Paginator for the ListCopyJobSummaries operation

Interface IListFrameworksPaginator

Paginator for the ListFrameworks operation

Interface IListLegalHoldsPaginator

Paginator for the ListLegalHolds operation

Interface IListProtectedResourcesByBackupVaultPaginator

Paginator for the ListProtectedResourcesByBackupVault operation

Interface IListProtectedResourcesPaginator

Paginator for the ListProtectedResources operation

Interface IListRecoveryPointsByBackupVaultPaginator

Paginator for the ListRecoveryPointsByBackupVault operation

Interface IListRecoveryPointsByLegalHoldPaginator

Paginator for the ListRecoveryPointsByLegalHold operation

Interface IListRecoveryPointsByResourcePaginator

Paginator for the ListRecoveryPointsByResource operation

Interface IListReportJobsPaginator

Paginator for the ListReportJobs operation

Interface IListReportPlansPaginator

Paginator for the ListReportPlans operation

Interface IListRestoreJobsByProtectedResourcePaginator

Paginator for the ListRestoreJobsByProtectedResource operation

Interface IListRestoreJobsPaginator

Paginator for the ListRestoreJobs operation

Interface IListRestoreJobSummariesPaginator

Paginator for the ListRestoreJobSummaries operation

Interface IListRestoreTestingPlansPaginator

Paginator for the ListRestoreTestingPlans operation

Interface IListRestoreTestingSelectionsPaginator

Paginator for the ListRestoreTestingSelections operation

Interface IListTagsPaginator

Paginator for the ListTags operation