String resourceType
Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.
Valid values: EC2.
Map<K,V> backupOptions
Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
Valid values:
Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a
Windows VSS backup.
Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not
enabled by default.
If you specify an invalid option, you get an InvalidParameterValueException exception.
For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.
String accountId
The account ID that owns the backup job.
String backupJobId
Uniquely identifies a request to Backup to back up a resource.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String backupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String recoveryPointArn
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
String resourceArn
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
Date creationDate
The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
Date completionDate
The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC).
The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
String state
The current state of a resource recovery point.
String statusMessage
A detailed message explaining the status of the job to back up a resource.
String percentDone
Contains an estimated percentage complete of a job at the time the job status was queried.
Long backupSizeInBytes
The size, in bytes, of a backup.
String iamRoleArn
Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must
include either AWSBackup or AwsBackup in the role name. For example,
arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions
to perform backup jobs.
RecoveryPointCreator createdBy
Contains identifying information about the creation of a backup job, including the BackupPlanArn,
BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used
to create it.
Date expectedCompletionDate
The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated
Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example,
the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Date startBy
Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before
it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled
time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date
specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
String resourceType
The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
Long bytesTransferred
The size in bytes transferred to a backup vault at the time that the job status was queried.
Map<K,V> backupOptions
Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and
create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you
specify an invalid option, you get an InvalidParameterValueException exception.
String backupType
Represents the type of backup for a backup job.
String backupPlanName
The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
List<E> rules
An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a
selection of resources.
List<E> advancedBackupSettings
Contains a list of BackupOptions for each resource type.
String backupPlanName
The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
List<E> rules
An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a
selection of resources.
List<E> advancedBackupSettings
Specifies a list of BackupOptions for each resource type. These settings are only available for
Windows Volume Shadow Copy Service (VSS) backup jobs.
String backupPlanArn
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
String backupPlanId
Uniquely identifies a backup plan.
Date creationDate
The date and time a resource backup plan is created, in Unix format and Coordinated Universal Time (UTC). The
value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents
Friday, January 26, 2018 12:11:30.087 AM.
Date deletionDate
The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of
DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
String versionId
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
String backupPlanName
The display name of a saved backup plan.
String creatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
Date lastExecutionDate
The last time a job to back up resources was run with this rule. A date and time, in Unix format and Coordinated
Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the
value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
List<E> advancedBackupSettings
Contains a list of BackupOptions for a resource type.
String ruleName
A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
String targetBackupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String scheduleExpression
A cron expression in UTC specifying when Backup initiates a backup job. For more information about Amazon Web
Services cron expressions, see Schedule Expressions for
Rules in the Amazon CloudWatch Events User Guide.. Two examples of Amazon Web Services cron
expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and
0 12 * * ? * (take a backup every day at 12 noon UTC). For a table of examples, click the preceding
link and scroll down the page.
Long startWindowMinutes
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional.
Long completionWindowMinutes
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.
Lifecycle lifecycle
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 “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.
Only Amazon EFS file system backups can be transitioned to cold storage.
Map<K,V> recoveryPointTags
An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.
String ruleId
Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
List<E> copyActions
An array of CopyAction objects, which contains the details of the copy operation.
Boolean enableContinuousBackup
Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.
String ruleName
A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
String targetBackupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String scheduleExpression
A CRON expression in UTC specifying when Backup initiates a backup job.
Long startWindowMinutes
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional.
Long completionWindowMinutes
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.
Lifecycle lifecycle
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire 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.
Only Amazon EFS file system backups can be transitioned to cold storage.
Map<K,V> recoveryPointTags
To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
List<E> copyActions
An array of CopyAction objects, which contains the details of the copy operation.
Boolean enableContinuousBackup
Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.
String selectionName
The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.
String iamRoleArn
The ARN of the IAM role that Backup uses to authenticate when backing up the target resource; for example,
arn:aws:iam::123456789012:role/S3Access.
List<E> resources
A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.
If you need to assign many resources to a backup plan, consider a different resource selection strategy, such as assigning all resources of a resource type or refining your resource selection using tags.
List<E> listOfTags
A list of conditions that you define to assign resources to your backup plans using tags. For example,
"StringEquals": {"Department": "accounting". Condition operators are case sensitive.
ListOfTags differs from Conditions as follows:
When you specify more than one condition, you assign all resources that match AT LEAST ONE condition (using OR logic).
ListOfTags only supports StringEquals. Conditions supports
StringEquals, StringLike, StringNotEquals, and StringNotLike.
List<E> notResources
A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.
If you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags.
Conditions conditions
A list of conditions that you define to assign resources to your backup plans using tags. For example,
"StringEquals": {"Department": "accounting". Condition operators are case sensitive.
Conditions differs from ListOfTags as follows:
When you specify more than one condition, you only assign the resources that match ALL conditions (using AND logic).
Conditions supports StringEquals, StringLike, StringNotEquals
, and StringNotLike. ListOfTags only supports StringEquals.
String selectionId
Uniquely identifies a request to assign a set of resources to a backup plan.
String selectionName
The display name of a resource selection document.
String backupPlanId
Uniquely identifies a backup plan.
Date creationDate
The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
String creatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
String iamRoleArn
Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String backupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Date creationDate
The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
String encryptionKeyArn
The server-side encryption key that is used to protect your backups; for example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
String creatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
Long numberOfRecoveryPoints
The number of recovery points that are stored in a backup vault.
Boolean locked
A Boolean value that indicates whether Backup Vault Lock applies to the selected backup vault. If
true, Vault Lock prevents delete and update operations on the recovery points in the selected vault.
Long minRetentionDays
The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
Long maxRetentionDays
The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
Date lockDate
The date and time when Backup Vault Lock configuration becomes immutable, meaning it cannot be changed or deleted.
If you applied Vault Lock to your vault without specifying a lock date, you can change your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.
This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
String conditionType
An operation applied to a key-value pair used to assign resources to your backup plan. Condition only supports
StringEquals. For more flexible assignment options, incluidng StringLike and the
ability to exclude resources from your backup plan, use Conditions (with an "s" on the end) for your
BackupSelection .
String conditionKey
The key in a key-value pair. For example, in the tag Department: Accounting, Department
is the key.
String conditionValue
The value in a key-value pair. For example, in the tag Department: Accounting,
Accounting is the value.
List<E> stringEquals
Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching."
List<E> stringNotEquals
Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called "negated matching."
List<E> stringLike
Filters the values of your tagged resources for matching tag values with the use of a wildcard character (*) anywhere in the string. For example, "prod*" or "*rod*" matches the tag value "production".
List<E> stringNotLike
Filters the values of your tagged resources for non-matching tag values with the use of a wildcard character (*) anywhere in the string.
List<E> complianceResourceIds
The ID of the only Amazon Web Services resource that you want your control scope to contain.
List<E> complianceResourceTypes
Describes whether the control scope includes one or more types of resources, such as EFS or
RDS.
Map<K,V> tags
The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for
a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty
string. The structure to assign a tag is: [{"Key":"string","Value":"string"}].
String accountId
The account ID that owns the copy job.
String copyJobId
Uniquely identifies a copy job.
String sourceBackupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String sourceRecoveryPointArn
An ARN that uniquely identifies a source recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
String destinationBackupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String destinationRecoveryPointArn
An ARN that uniquely identifies a destination recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
String resourceArn
The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Date creationDate
The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
Date completionDate
The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of
CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
String state
The current state of a copy job.
String statusMessage
A detailed message explaining the status of the job to copy a resource.
Long backupSizeInBytes
The size, in bytes, of a copy job.
String iamRoleArn
Specifies the IAM role ARN used to copy the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
RecoveryPointCreator createdBy
String resourceType
The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
BackupPlanInput backupPlan
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of
Rules.
Map<K,V> backupPlanTags
To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.
String creatorRequestId
Identifies the request and allows failed requests to be retried without the risk of running the operation twice.
If the request includes a CreatorRequestId that matches an existing backup plan, that plan is
returned. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
String backupPlanId
Uniquely identifies a backup plan.
String backupPlanArn
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
Date creationDate
The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value
of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents
Friday, January 26, 2018 12:11:30.087 AM.
String versionId
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
List<E> advancedBackupSettings
A list of BackupOptions settings for a resource type. This option is only available for Windows
Volume Shadow Copy Service (VSS) backup jobs.
String backupPlanId
Uniquely identifies the backup plan to be associated with the selection of resources.
BackupSelection backupSelection
Specifies the body of a request to assign a set of resources to a backup plan.
String creatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
String selectionId
Uniquely identifies the body of a request to assign a set of resources to a backup plan.
String backupPlanId
Uniquely identifies a backup plan.
Date creationDate
The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value
of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents
Friday, January 26, 2018 12:11:30.087 AM.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.
Map<K,V> backupVaultTags
Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.
String encryptionKeyArn
The server-side encryption key that is used to protect your backups; for example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
String creatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String backupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Date creationDate
The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
String frameworkName
The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
String frameworkDescription
An optional description of the framework with a maximum of 1,024 characters.
List<E> frameworkControls
A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
String idempotencyToken
A customer-chosen string that you can use to distinguish between otherwise identical calls to
CreateFrameworkInput. Retrying a successful request with the same idempotency token results in a
success message with no action taken.
Map<K,V> frameworkTags
Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
String frameworkName
The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
String frameworkArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
String reportPlanName
The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
String reportPlanDescription
An optional description of the report plan with a maximum of 1,024 characters.
ReportDeliveryChannel reportDeliveryChannel
A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
ReportSetting reportSetting
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this
API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
Map<K,V> reportPlanTags
Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
String idempotencyToken
A customer-chosen string that you can use to distinguish between otherwise identical calls to
CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a
success message with no action taken.
String reportPlanName
The unique name of the report plan.
String reportPlanArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Date creationTime
The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
String backupPlanId
Uniquely identifies a backup plan.
String backupPlanId
Uniquely identifies a backup plan.
String backupPlanArn
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
Date deletionDate
The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of
DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
String versionId
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String backupVaultName
The name of the backup vault from which to delete Backup Vault Lock.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String frameworkName
The unique name of a framework.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String recoveryPointArn
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
String reportPlanName
The unique name of a report plan.
String backupJobId
Uniquely identifies a request to Backup to back up a resource.
String accountId
Returns the account ID that owns the backup job.
String backupJobId
Uniquely identifies a request to Backup to back up a resource.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String backupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String recoveryPointArn
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
String resourceArn
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
Date creationDate
The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
Date completionDate
The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time
(UTC). The value of CompletionDate is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
String state
The current state of a resource recovery point.
String statusMessage
A detailed message explaining the status of the job to back up a resource.
String percentDone
Contains an estimated percentage that is complete of a job at the time the job status was queried.
Long backupSizeInBytes
The size, in bytes, of a backup.
String iamRoleArn
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
RecoveryPointCreator createdBy
Contains identifying information about the creation of a backup job, including the BackupPlanArn,
BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that
is used to create it.
String resourceType
The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Long bytesTransferred
The size in bytes transferred to a backup vault at the time that the job status was queried.
Date expectedCompletionDate
The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated
Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example,
the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Date startBy
Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before
it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled
time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date
specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
Map<K,V> backupOptions
Represents the options specified as part of backup plan or on-demand backup job.
String backupType
Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow
Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If
BackupType is empty, then the backup type was a regular backup.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String backupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String encryptionKeyArn
The server-side encryption key that is used to protect your backups; for example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Date creationDate
The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value
of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents
Friday, January 26, 2018 12:11:30.087 AM.
String creatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
Long numberOfRecoveryPoints
The number of recovery points that are stored in a backup vault.
Boolean locked
A Boolean that indicates whether Backup Vault Lock is currently protecting the backup vault. True
means that Vault Lock causes delete or update operations on the recovery points stored in the vault to fail.
Long minRetentionDays
The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
Long maxRetentionDays
The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
Date lockDate
The date and time when Backup Vault Lock configuration cannot be changed or deleted.
If you applied Vault Lock to your vault without specifying a lock date, you can change any of your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.
This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
String copyJobId
Uniquely identifies a copy job.
CopyJob copyJob
Contains detailed information about a copy job.
String frameworkName
The unique name of a framework.
String frameworkName
The unique name of a framework.
String frameworkArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
String frameworkDescription
An optional description of the framework.
List<E> frameworkControls
A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
Date creationTime
The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
String deploymentStatus
The deployment status of a framework. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
String frameworkStatus
A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:
ACTIVE when recording is turned on for all resources governed by the framework.
PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.
INACTIVE when recording is turned off for all resources governed by the framework.
UNAVAILABLE when Backup is unable to validate recording status at this time.
String idempotencyToken
A customer-chosen string that you can use to distinguish between otherwise identical calls to
DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a
success message with no action taken.
Map<K,V> globalSettings
The status of the flag isCrossAccountBackupEnabled.
Date lastUpdateTime
The date and time that the flag isCrossAccountBackupEnabled was last updated. This update is in Unix
format and Coordinated Universal Time (UTC). The value of LastUpdateTime is accurate to
milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
String resourceArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
String resourceArn
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
String resourceType
The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon EBS volume or an Amazon RDS database.
Date lastBackupTime
The date and time that a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The
value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String recoveryPointArn
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
String recoveryPointArn
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String backupVaultArn
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String sourceBackupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed
up in; for example, arn:aws:backup:us-east-1:123456789012:vault:BackupVault. If the recovery is
restored to the same Amazon Web Services account or Region, this value will be null.
String resourceArn
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
String resourceType
The type of Amazon Web Services resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
RecoveryPointCreator createdBy
Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan
used to create it.
String iamRoleArn
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
String status
A status code specifying the state of the recovery point.
PARTIAL status indicates Backup could not create the recovery point before the backup window closed.
To increase your backup plan window using the API, see UpdateBackupPlan. You
can also increase your backup plan window using the Console by choosing and editing your backup plan.
EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks
permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3:
Delete the recovery points in the Clean up resources section of Getting started.
String statusMessage
A status message explaining the reason for the recovery point deletion failure.
Date creationDate
The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The
value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents
Friday, January 26, 2018 12:11:30.087 AM.
Date completionDate
The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal
Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Long backupSizeInBytes
The size, in bytes, of a backup.
CalculatedLifecycle calculatedLifecycle
A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt
timestamps.
Lifecycle lifecycle
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 that are 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.
Only Amazon EFS file system backups can be transitioned to cold storage.
String encryptionKeyArn
The server-side encryption key used to protect your backups; for example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Boolean isEncrypted
A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or
FALSE if the recovery point is not encrypted.
String storageClass
Specifies the storage class of the recovery point. Valid values are WARM or COLD.
Date lastRestoreTime
The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC).
The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
Map<K,V> resourceTypeOptInPreference
Returns a list of all services along with the opt-in preferences in the Region.
Map<K,V> resourceTypeManagementPreference
Returns whether a DynamoDB recovery point was taken using Backup's advanced DynamoDB backup features.
String reportJobId
The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.
ReportJob reportJob
A list of information about a report job, including its completion and creation times, report destination, unique report job ID, Amazon Resource Name (ARN), report template, status, and status message.
String reportPlanName
The unique name of a report plan.
ReportPlan reportPlan
Returns details about the report plan that is specified by its name. These details include the report plan's Amazon Resource Name (ARN), description, settings, delivery channel, deployment status, creation time, and last attempted and successful run times.
String restoreJobId
Uniquely identifies the job that restores a recovery point.
String accountId
Returns the account ID that owns the restore job.
String restoreJobId
Uniquely identifies the job that restores a recovery point.
String recoveryPointArn
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Date creationDate
The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value
of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents
Friday, January 26, 2018 12:11:30.087 AM.
Date completionDate
The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal
Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
String status
Status code specifying the state of the job that is initiated by Backup to restore a recovery point.
String statusMessage
A message showing the status of a job to restore a recovery point.
String percentDone
Contains an estimated percentage that is complete of a job at the time the job status was queried.
Long backupSizeInBytes
The size, in bytes, of the restored resource.
String iamRoleArn
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
Long expectedCompletionTimeMinutes
The amount of time in minutes that a job restoring a recovery point is expected to take.
String createdResourceArn
An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.
String resourceType
Returns metadata associated with a restore job listed by resource type.
String backupPlanId
Uniquely identifies a backup plan.
String backupPlanTemplateJson
The body of a backup plan template in JSON format.
This is a signed JSON document that cannot be modified before being passed to GetBackupPlanFromJSON.
String frameworkName
The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
String frameworkArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
String frameworkDescription
An optional description of the framework with a maximum 1,024 characters.
Integer numberOfControls
The number of controls contained by the framework.
Date creationTime
The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
String deploymentStatus
The deployment status of a framework. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
String controlName
The name of a control. This name is between 1 and 256 characters.
List<E> controlInputParameters
A list of ParameterName and ParameterValue pairs.
ControlScope controlScope
The scope of a control. The control scope defines what the control will evaluate. Three examples of control
scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans. For more
information, see ControlScope.
String backupPlanTemplateJson
A customer-supplied backup plan document in JSON format.
BackupPlan backupPlan
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of
Rules.
String backupPlanTemplateId
Uniquely identifies a stored backup plan template.
BackupPlan backupPlanDocument
Returns the body of a backup plan based on the target template, including the name, rules, and backup vault of the plan.
BackupPlan backupPlan
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of
Rules.
String backupPlanId
Uniquely identifies a backup plan.
String backupPlanArn
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
String versionId
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
String creatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
Date creationDate
The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value
of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents
Friday, January 26, 2018 12:11:30.087 AM.
Date deletionDate
The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value
of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents
Friday, January 26, 2018 12:11:30.087 AM.
Date lastExecutionDate
The last time a job to back up resources was run with this backup plan. A date and time, in Unix format and
Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For
example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
List<E> advancedBackupSettings
Contains a list of BackupOptions for each resource type. The list is populated only if the advanced
option is set for the backup plan.
BackupSelection backupSelection
Specifies the body of a request to assign a set of resources to a backup plan.
String selectionId
Uniquely identifies the body of a request to assign a set of resources to a backup plan.
String backupPlanId
Uniquely identifies a backup plan.
Date creationDate
The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value
of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents
Friday, January 26, 2018 12:11:30.087 AM.
String creatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String backupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String policy
The backup vault access policy document in JSON format.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String backupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String sNSTopicArn
An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example,
arn:aws:sns:us-west-2:111122223333:MyTopic.
List<E> backupVaultEvents
An array of events that indicate the status of jobs to back up resources to the backup vault.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String recoveryPointArn
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
String backupVaultArn
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String recoveryPointArn
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Map<K,V> restoreMetadata
The set of metadata key-value pairs that describe the original configuration of the backed-up resource. These values vary depending on the service that is being restored.
List<E> resourceTypes
Contains a string with the supported Amazon Web Services resource types:
Aurora for Amazon Aurora
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSX for Amazon FSx
RDS for Amazon Relational Database Service
Storage Gateway for Storage Gateway
Long moveToColdStorageAfterDays
Specifies the number of days after creation that a recovery point is moved to cold storage.
Long deleteAfterDays
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus
MoveToColdStorageAfterDays.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
Integer maxResults
The maximum number of items to be returned.
String byResourceArn
Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
String byState
Returns only backup jobs that are in the specified state.
String byBackupVaultName
Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
Date byCreatedBefore
Returns only backup jobs that were created before the specified date.
Date byCreatedAfter
Returns only backup jobs that were created after the specified date.
String byResourceType
Returns only backup jobs for the specified resources:
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
RDS for Amazon Relational Database Service
Aurora for Amazon Aurora
Storage Gateway for Storage Gateway
String byAccountId
The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.
If used from an Organizations management account, passing * returns all jobs across the
organization.
List<E> backupJobs
An array of structures containing metadata about your backup jobs returned in JSON format.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
Integer maxResults
The maximum number of items to be returned.
Boolean includeDeleted
A Boolean value with a default value of FALSE that returns deleted backup plans when set to
TRUE.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
List<E> backupPlansList
An array of backup plan list items containing metadata about your saved backup plans.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
Integer maxResults
The maximum number of items to be returned.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
List<E> backupPlanTemplatesList
An array of template list items containing metadata about your saved templates.
String backupPlanId
Uniquely identifies a backup plan.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
Integer maxResults
The maximum number of items to be returned.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
List<E> backupPlanVersionsList
An array of version list items containing metadata about your backup plans.
String backupPlanId
Uniquely identifies a backup plan.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
Integer maxResults
The maximum number of items to be returned.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
List<E> backupSelectionsList
An array of backup selection list items containing metadata about each resource in the list.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
Integer maxResults
The maximum number of items to be returned.
List<E> backupVaultList
An array of backup vault list members containing vault metadata, including Amazon Resource Name (ARN), display name, creation date, number of saved recovery points, and encryption information if the resources saved in the backup vault are encrypted.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
Integer maxResults
The maximum number of items to be returned.
String byResourceArn
Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
String byState
Returns only copy jobs that are in the specified state.
Date byCreatedBefore
Returns only copy jobs that were created before the specified date.
Date byCreatedAfter
Returns only copy jobs that were created after the specified date.
String byResourceType
Returns only backup jobs for the specified resources:
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
RDS for Amazon Relational Database Service
Aurora for Amazon Aurora
Storage Gateway for Storage Gateway
String byDestinationVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String byAccountId
The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.
List<E> copyJobs
An array of structures containing metadata about your copy jobs returned in JSON format.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
Integer maxResults
The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
String nextToken
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
List<E> frameworks
A list of frameworks with details for each framework, including the framework name, Amazon Resource Name (ARN), description, number of controls, creation time, and deployment status.
String nextToken
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
Integer maxResults
The maximum number of items to be returned.
List<E> results
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.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
Backup vault name might not be available when a supported service creates the backup.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
Integer maxResults
The maximum number of items to be returned.
String byResourceArn
Returns only recovery points that match the specified resource Amazon Resource Name (ARN).
String byResourceType
Returns only recovery points that match the specified resource type.
String byBackupPlanId
Returns only recovery points that match the specified backup plan ID.
Date byCreatedBefore
Returns only recovery points that were created before the specified timestamp.
Date byCreatedAfter
Returns only recovery points that were created after the specified timestamp.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
List<E> recoveryPoints
An array of objects that contain detailed information about recovery points saved in a backup vault.
String resourceArn
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
Integer maxResults
The maximum number of items to be returned.
Amazon RDS requires a value of at least 20.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
List<E> recoveryPoints
An array of objects that contain detailed information about recovery points of the specified resource type.
Only Amazon EFS and Amazon EC2 recovery points return BackupVaultName.
String byReportPlanName
Returns only report jobs with the specified report plan name.
Date byCreationBefore
Returns only report jobs that were created before the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.
Date byCreationAfter
Returns only report jobs that were created after the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.
String byStatus
Returns only report jobs that are in the specified status. The statuses are:
CREATED | RUNNING | COMPLETED | FAILED
Integer maxResults
The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
String nextToken
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Integer maxResults
The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
String nextToken
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
List<E> reportPlans
A list of your report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.
String nextToken
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
Integer maxResults
The maximum number of items to be returned.
String byAccountId
The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.
Date byCreatedBefore
Returns only restore jobs that were created before the specified date.
Date byCreatedAfter
Returns only restore jobs that were created after the specified date.
String byStatus
Returns only restore jobs associated with the specified job status.
List<E> restoreJobs
An array of objects that contain detailed information about jobs to restore saved resources.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
String resourceArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of
resource. Valid targets for ListTags are recovery points, backup plans, and backup vaults.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
Integer maxResults
The maximum number of items to be returned.
String nextToken
The next item following a partial list of returned items. For example, if a request is made to return
maxResults number of items, NextToken allows you to return more items in your list
starting at the location pointed to by the next token.
Map<K,V> tags
To help organize your resources, you can assign your own metadata to the resources you create. Each tag is a key-value pair.
String resourceArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
String resourceType
The type of Amazon Web Services resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
Date lastBackupTime
The date and time a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value
of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents
Friday, January 26, 2018 12:11:30.087 AM.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String policy
The backup vault access policy document in JSON format.
String backupVaultName
The Backup Vault Lock configuration that specifies the name of the backup vault it protects.
Long minRetentionDays
The Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years (2555 days).
If this parameter is not specified, Vault Lock will not enforce a minimum retention period.
If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already saved in the vault prior to Vault Lock are not affected.
Long maxRetentionDays
The Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years (1460 days).
If this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period.
If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already saved in the vault prior to Vault Lock are not affected.
Long changeableForDays
The Backup Vault Lock configuration that specifies the number of days before the lock date. For example, setting
ChangeableForDays to 30 on Jan. 1, 2022 at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm
UTC.
Backup enforces a 72-hour cooling-off period before Vault Lock takes effect and becomes immutable. Therefore, you
must set ChangeableForDays to 3 or greater.
Before the lock date, you can delete Vault Lock from the vault using
DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using
PutBackupVaultLockConfiguration. On and after the lock date, the Vault Lock becomes immutable and
cannot be changed or deleted.
If this parameter is not specified, you can delete Vault Lock from the vault using
DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using
PutBackupVaultLockConfiguration at any time.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String sNSTopicArn
The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example,
arn:aws:sns:us-west-2:111122223333:MyVaultTopic.
List<E> backupVaultEvents
An array of events that indicate the status of jobs to back up resources to the backup vault.
For common use cases and code samples, see Using Amazon SNS to track Backup events.
The following events are supported:
BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED
COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED
RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED
Ignore the list below because it includes deprecated events. Refer to the list above.
String recoveryPointArn
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String backupVaultArn
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String sourceBackupVaultArn
The backup vault where the recovery point was originally copied from. If the recovery point is restored to the
same account this value will be null.
String resourceArn
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
String resourceType
The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
RecoveryPointCreator createdBy
Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan
that is used to create it.
String iamRoleArn
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
String status
A status code specifying the state of the recovery point.
String statusMessage
A message explaining the reason of the recovery point deletion failure.
Date creationDate
The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
Date completionDate
The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time
(UTC). The value of CompletionDate is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Long backupSizeInBytes
The size, in bytes, of a backup.
CalculatedLifecycle calculatedLifecycle
A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt
timestamps.
Lifecycle lifecycle
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 “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.
Only Amazon EFS file system backups can be transitioned to cold storage.
String encryptionKeyArn
The server-side encryption key that is used to protect your backups; for example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Boolean isEncrypted
A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or
FALSE if the recovery point is not encrypted.
Date lastRestoreTime
The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The
value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
String recoveryPointArn
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Date creationDate
The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
String status
A status code specifying the state of the recovery point.
String statusMessage
A message explaining the reason of the recovery point deletion failure.
String encryptionKeyArn
The server-side encryption key that is used to protect your backups; for example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Long backupSizeBytes
The size, in bytes, of a backup.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String backupPlanId
Uniquely identifies a backup plan.
String backupPlanArn
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
String backupPlanVersion
Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
String backupRuleId
Uniquely identifies a rule used to schedule the backup of a selection of resources.
String s3BucketName
The unique name of the S3 bucket that receives your reports.
String s3KeyPrefix
The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the
following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not
specified, there is no prefix.
List<E> formats
A list of the format of your reports: CSV, JSON, or both. If not specified, the default
format is CSV.
String reportJobId
The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.
String reportPlanArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
String reportTemplate
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
Date creationTime
The date and time that a report job is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
Date completionTime
The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value
of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents
Friday, January 26, 2018 12:11:30.087 AM.
String status
The status of a report job. The statuses are:
CREATED | RUNNING | COMPLETED | FAILED
COMPLETED means that the report is available for your review at your designated destination. If the
status is FAILED, review the StatusMessage for the reason.
String statusMessage
A message explaining the status of the report job.
ReportDestination reportDestination
The S3 bucket name and S3 keys for the destination where the report job publishes the report.
String reportPlanArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
String reportPlanName
The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
String reportPlanDescription
An optional description of the report plan with a maximum 1,024 characters.
ReportSetting reportSetting
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this
API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
ReportDeliveryChannel reportDeliveryChannel
Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
String deploymentStatus
The deployment status of a report plan. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
Date creationTime
The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value
of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents
Friday, January 26, 2018 12:11:30.087 AM.
Date lastAttemptedExecutionTime
The date and time that a report job associated with this report plan last attempted to run, in Unix format and
Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to
milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Date lastSuccessfulExecutionTime
The date and time that a report job associated with this report plan last successfully ran, in Unix format and
Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to
milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
String reportTemplate
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
List<E> frameworkArns
The Amazon Resource Names (ARNs) of the frameworks a report covers.
Integer numberOfFrameworks
The number of frameworks a report covers.
String accountId
The account ID that owns the restore job.
String restoreJobId
Uniquely identifies the job that restores a recovery point.
String recoveryPointArn
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Date creationDate
The date and time a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
Date completionDate
The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time
(UTC). The value of CompletionDate is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
String status
A status code specifying the state of the job initiated by Backup to restore a recovery point.
String statusMessage
A detailed message explaining the status of the job to restore a recovery point.
String percentDone
Contains an estimated percentage complete of a job at the time the job status was queried.
Long backupSizeInBytes
The size, in bytes, of the restored resource.
String iamRoleArn
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
Long expectedCompletionTimeMinutes
The amount of time in minutes that a job restoring a recovery point is expected to take.
String createdResourceArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
String resourceType
The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String resourceArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
String iamRoleArn
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
String idempotencyToken
A customer-chosen string that you can use to distinguish between otherwise identical calls to
StartBackupJob. Retrying a successful request with the same idempotency token results in a success
message with no action taken.
Long startWindowMinutes
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours.
Long completeWindowMinutes
A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the
job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add
additional time for StartWindowMinutes, or if the backup started later than scheduled.
Lifecycle lifecycle
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire 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.
Only Amazon EFS file system backups can be transitioned to cold storage.
Map<K,V> recoveryPointTags
To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
Map<K,V> backupOptions
Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and
create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The
WindowsVSS option is not enabled by default.
String backupJobId
Uniquely identifies a request to Backup to back up a resource.
String recoveryPointArn
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Date creationDate
The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
String recoveryPointArn
An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
String sourceBackupVaultName
The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String destinationBackupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String iamRoleArn
Specifies the IAM role ARN used to copy the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
String idempotencyToken
A customer-chosen string that you can use to distinguish between otherwise identical calls to
StartCopyJob. Retrying a successful request with the same idempotency token results in a success
message with no action taken.
Lifecycle lifecycle
String copyJobId
Uniquely identifies a copy job.
Date creationDate
The date and time that a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
String reportPlanName
The unique name of a report plan.
String idempotencyToken
A customer-chosen string that you can use to distinguish between otherwise identical calls to
StartReportJobInput. Retrying a successful request with the same idempotency token results in a
success message with no action taken.
String reportJobId
The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.
String recoveryPointArn
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Map<K,V> metadata
A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.
You can get configuration metadata about a resource at the time it was backed up by calling
GetRecoveryPointRestoreMetadata. However, values in addition to those provided by
GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need
to provide a new resource name if the original already exists.
You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:
file-system-id: The ID of the Amazon EFS file system that is backed up by Backup. Returned in
GetRecoveryPointRestoreMetadata.
Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If
KmsKeyId is specified, Encrypted must be set to true.
KmsKeyId: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file
system. You can specify a key from another Amazon Web Services account provided that key it is properly shared
with your account via Amazon Web Services KMS.
PerformanceMode: Specifies the throughput mode of the file system.
CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.
newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new
Amazon EFS file system.
ItemsToRestore: An array of one to five strings where each string is a file path. Use
ItemsToRestore to restore specific files or directories rather than the entire file system. This
parameter is optional. For example, "itemsToRestore":"[\"/my.test\"]".
String iamRoleArn
The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
String idempotencyToken
A customer-chosen string that you can use to distinguish between otherwise identical calls to
StartRestoreJob. Retrying a successful request with the same idempotency token results in a success
message with no action taken.
String resourceType
Starts a job to restore a recovery point for one of the following resources:
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
RDS for Amazon Relational Database Service
Aurora for Amazon Aurora
Storage Gateway for Storage Gateway
String restoreJobId
Uniquely identifies the job that restores a recovery point.
String backupJobId
Uniquely identifies a request to Backup to back up a resource.
String resourceArn
An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
Map<K,V> tags
Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources
you create. For clarity, this is the structure to assign tags: [{"Key":"string","Value":"string"}].
String backupPlanId
Uniquely identifies a backup plan.
BackupPlanInput backupPlan
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of
Rules.
String backupPlanId
Uniquely identifies a backup plan.
String backupPlanArn
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
Date creationDate
The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
String versionId
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.
List<E> advancedBackupSettings
Contains a list of BackupOptions for each resource type.
String frameworkName
The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
String frameworkDescription
An optional description of the framework with a maximum 1,024 characters.
List<E> frameworkControls
A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
String idempotencyToken
A customer-chosen string that you can use to distinguish between otherwise identical calls to
UpdateFrameworkInput. Retrying a successful request with the same idempotency token results in a
success message with no action taken.
String frameworkName
The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
String frameworkArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Date creationTime
The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String recoveryPointArn
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Lifecycle lifecycle
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 “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.
String backupVaultArn
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String recoveryPointArn
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Lifecycle lifecycle
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 “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.
Only Amazon EFS file system backups can be transitioned to cold storage.
CalculatedLifecycle calculatedLifecycle
A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt
timestamps.
String reportPlanName
The unique name of the report plan. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
String reportPlanDescription
An optional description of the report plan with a maximum 1,024 characters.
ReportDeliveryChannel reportDeliveryChannel
A structure that contains information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
ReportSetting reportSetting
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this
API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
String idempotencyToken
A customer-chosen string that you can use to distinguish between otherwise identical calls to
UpdateReportPlanInput. Retrying a successful request with the same idempotency token results in a
success message with no action taken.
String reportPlanName
The unique name of the report plan.
String reportPlanArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Date creationTime
The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value
of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents
Friday, January 26, 2018 12:11:30.087 AM.
Copyright © 2022. All rights reserved.