Package-level declarations

Types

Link copied to clipboard

The backup options for each resource type.

Link copied to clipboard
sealed class AggregationPeriod
Link copied to clipboard

The required resource already exists.

Link copied to clipboard

Base class for all service related exceptions thrown by the Backup client

Link copied to clipboard
class BackupJob

Contains detailed information about a backup job.

Link copied to clipboard
sealed class BackupJobState
Link copied to clipboard
sealed class BackupJobStatus
Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Contains metadata about a backup plan.

Link copied to clipboard

An object specifying metadata associated with a backup plan template.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Contains metadata about a BackupSelection object.

Link copied to clipboard
sealed class BackupVaultEvent
Link copied to clipboard

Contains metadata about a backup vault.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
sealed class ConditionType
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The details of the copy operation.

Link copied to clipboard
class CopyJob

Contains detailed information about a copy job.

Link copied to clipboard
sealed class CopyJobState
Link copied to clipboard
sealed class CopyJobStatus
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class DateRange

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
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.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class Index
Link copied to clipboard

This is an optional array within a BackupRule.

Link copied to clipboard

This is a recovery point that has an associated backup index.

Link copied to clipboard
sealed class IndexStatus
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
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: + - = . _ : /

Link copied to clipboard

Contains information about the latest update to an MPA approval team association.

Link copied to clipboard

Contains information about the latest request to revoke access to a backup vault.

Link copied to clipboard
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.

Link copied to clipboard
sealed class LegalHoldStatus
Link copied to clipboard
class Lifecycle

Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Indicates that a required parameter is missing.

Link copied to clipboard
Link copied to clipboard
sealed class MpaSessionStatus
Link copied to clipboard

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

Link copied to clipboard

The conditions that you define for resources in your restore testing plan using tags.

Link copied to clipboard

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

Link copied to clipboard

Contains detailed information about a saved recovery point.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
sealed class RecoveryPointStatus
Link copied to clipboard

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.

Link copied to clipboard

Contains information from your report job about your report destination.

Link copied to clipboard
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.

Link copied to clipboard

Contains detailed information about a report plan.

Link copied to clipboard

Contains detailed information about a report setting.

Link copied to clipboard

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

Link copied to clipboard

Contains information about a restore access backup vault.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

Contains metadata about a restore job.

Link copied to clipboard
sealed class RestoreJobState
Link copied to clipboard
sealed class RestoreJobStatus
Link copied to clipboard

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

Link copied to clipboard

This contains metadata about a restore testing plan.

Link copied to clipboard

This contains metadata about a restore testing plan.

Link copied to clipboard

This contains metadata about a restore testing plan.

Link copied to clipboard

This contains metadata about a restore testing plan.

Link copied to clipboard

RecoveryPointSelection has five parameters (three required and two optional). The values you specify determine which recovery point is included in the restore test. You must indicate with Algorithm if you want the latest recovery point within your SelectionWindowDays or if you want a random recovery point, and you must indicate through IncludeVaults from which vaults the recovery points can be chosen.

Link copied to clipboard

This contains metadata about a specific restore testing selection.

Link copied to clipboard

This contains metadata about a restore testing selection.

Link copied to clipboard

This contains metadata about a restore testing selection.

Link copied to clipboard

This contains metadata about a restore testing selection.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class StorageClass
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class VaultState
Link copied to clipboard
sealed class VaultType