|
43 | 43 | "PutBackupVaultNotifications": "<p>Turns on notifications on a backup vault for the specified topic and events.</p>", |
44 | 44 | "StartBackupJob": "<p>Starts an on-demand backup job for the specified resource.</p>", |
45 | 45 | "StartCopyJob": "<p>Starts a job to create a one-time copy of the specified resource.</p>", |
46 | | - "StartRestoreJob": "<p>Recovers the saved resource identified by an Amazon Resource Name (ARN). </p> <p>If the resource ARN is included in the request, then the last complete backup of that resource is recovered. If the ARN of a recovery point is supplied, then that recovery point is restored.</p>", |
| 46 | + "StartRestoreJob": "<p>Recovers the saved resource identified by an Amazon Resource Name (ARN). </p>", |
47 | 47 | "StopBackupJob": "<p>Attempts to cancel a job to create a one-time backup of a resource.</p>", |
48 | 48 | "TagResource": "<p>Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).</p>", |
49 | 49 | "UntagResource": "<p>Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)</p>", |
|
193 | 193 | "BackupOptions": { |
194 | 194 | "base": null, |
195 | 195 | "refs": { |
196 | | - "AdvancedBackupSetting$BackupOptions": "<p>Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.</p> <p>Valid value: <code>\"WindowsVSS”:“enabled\"</code>. If enabled, creates a VSS Windows backup; otherwise, creates a regular backup.</p> <p>If you specify an invalid option, you get an <code>InvalidParameterValueException</code> exception.</p> <p>For more information about Windows VSS backups, see <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.html\">Creating a VSS-Enabled Windows Backup</a>.</p>", |
197 | | - "BackupJob$BackupOptions": "<p>Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.</p> <p>Valid value: <code>\"WindowsVSS”:“enabled\"</code>. If enabled, creates a VSS Windows backup; otherwise, creates a regular backup. If you specify an invalid option, you get an <code>InvalidParameterValueException</code> exception.</p>", |
| 196 | + "AdvancedBackupSetting$BackupOptions": "<p>Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.</p> <p>Valid values: Set to <code>\"WindowsVSS”:“enabled\"</code> to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. The WindowsVSS option is not enabled by default.</p> <p>If you specify an invalid option, you get an <code>InvalidParameterValueException</code> exception.</p> <p>For more information about Windows VSS backups, see <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.html\">Creating a VSS-Enabled Windows Backup</a>.</p>", |
| 197 | + "BackupJob$BackupOptions": "<p>Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.</p> <p>Valid values: Set to <code>\"WindowsVSS”:“enabled\"</code> to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. If you specify an invalid option, you get an <code>InvalidParameterValueException</code> exception.</p>", |
198 | 198 | "DescribeBackupJobOutput$BackupOptions": "<p>Represents the options specified as part of backup plan or on-demand backup job.</p>", |
199 | | - "StartBackupJobInput$BackupOptions": "<p>Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.</p> <p>Valid value: <code>\"WindowsVSS”:“enabled\"</code>. If enabled, creates a VSS Windows backup; otherwise, creates a regular backup.</p>" |
| 199 | + "StartBackupJobInput$BackupOptions": "<p>Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.</p> <p>Valid values: Set to <code>\"WindowsVSS”:“enabled\"</code> to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. The WindowsVSS option is not enabled by default.</p>" |
200 | 200 | } |
201 | 201 | }, |
202 | 202 | "BackupPlan": { |
|
470 | 470 | "CronExpression": { |
471 | 471 | "base": null, |
472 | 472 | "refs": { |
473 | | - "BackupRule$ScheduleExpression": "<p>A CRON expression specifying when AWS Backup initiates a backup job.</p>", |
| 473 | + "BackupRule$ScheduleExpression": "<p>A CRON expression specifying when AWS Backup initiates a backup job. For more information about cron expressions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html\">Schedule Expressions for Rules</a> in the <i>Amazon CloudWatch Events User Guide.</i>. Prior to specifying a value for this parameter, we recommend testing your cron expression using one of the many available cron generator and testing tools.</p>", |
474 | 474 | "BackupRuleInput$ScheduleExpression": "<p>A CRON expression specifying when AWS Backup initiates a backup job.</p>" |
475 | 475 | } |
476 | 476 | }, |
|
894 | 894 | "base": null, |
895 | 895 | "refs": { |
896 | 896 | "GetRecoveryPointRestoreMetadataOutput$RestoreMetadata": "<p>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.</p>", |
897 | | - "StartRestoreJobInput$Metadata": "<p>A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.</p> <p> You can get configuration metadata about a resource at the time it was backed up by calling <code>GetRecoveryPointRestoreMetadata</code>. However, values in addition to those provided by <code>GetRecoveryPointRestoreMetadata</code> might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.</p> <p>You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:</p> <ul> <li> <p> <code>file-system-id</code>: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in <code>GetRecoveryPointRestoreMetadata</code>.</p> </li> <li> <p> <code>Encrypted</code>: A Boolean value that, if true, specifies that the file system is encrypted. If <code>KmsKeyId</code> is specified, <code>Encrypted</code> must be set to <code>true</code>.</p> </li> <li> <p> <code>KmsKeyId</code>: Specifies the AWS KMS key that is used to encrypt the restored file system.</p> </li> <li> <p> <code>PerformanceMode</code>: Specifies the throughput mode of the file system.</p> </li> <li> <p> <code>CreationToken</code>: A user-supplied value that ensures the uniqueness (idempotency) of the request.</p> </li> <li> <p> <code>newFileSystem</code>: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.</p> </li> </ul>" |
| 897 | + "StartRestoreJobInput$Metadata": "<p>A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.</p> <p> You can get configuration metadata about a resource at the time it was backed up by calling <code>GetRecoveryPointRestoreMetadata</code>. However, values in addition to those provided by <code>GetRecoveryPointRestoreMetadata</code> might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.</p> <p>You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:</p> <ul> <li> <p> <code>file-system-id</code>: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in <code>GetRecoveryPointRestoreMetadata</code>.</p> </li> <li> <p> <code>Encrypted</code>: A Boolean value that, if true, specifies that the file system is encrypted. If <code>KmsKeyId</code> is specified, <code>Encrypted</code> must be set to <code>true</code>.</p> </li> <li> <p> <code>KmsKeyId</code>: Specifies the AWS KMS key that is used to encrypt the restored file system. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS KMS.</p> </li> <li> <p> <code>PerformanceMode</code>: Specifies the throughput mode of the file system.</p> </li> <li> <p> <code>CreationToken</code>: A user-supplied value that ensures the uniqueness (idempotency) of the request.</p> </li> <li> <p> <code>newFileSystem</code>: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.</p> </li> <li> <p> <code>ItemsToRestore </code>: A serialized list of up to five strings where each string is a file path. Use <code>ItemsToRestore</code> to restore specific files or directories rather than the entire file system. This parameter is optional.</p> </li> </ul>" |
898 | 898 | } |
899 | 899 | }, |
900 | 900 | "MetadataKey": { |
|
0 commit comments