|
14 | 14 | "DescribeBackupJob": "<p>Returns backup job details for the specified <code>BackupJobId</code>.</p>", |
15 | 15 | "DescribeBackupVault": "<p>Returns metadata about a backup vault specified by its name.</p>", |
16 | 16 | "DescribeCopyJob": "<p>Returns metadata associated with creating a copy of a resource.</p>", |
| 17 | + "DescribeGlobalSettings": "<p>The current feature settings for the AWS Account.</p>", |
17 | 18 | "DescribeProtectedResource": "<p>Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource.</p>", |
18 | 19 | "DescribeRecoveryPoint": "<p>Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.</p>", |
19 | | - "DescribeRegionSettings": "<p>Returns the current service opt-in settings for the Region. If the service has a value set to <code>true</code>, AWS Backup tries to protect that service's resources in this Region, when included in an on-demand backup or scheduled backup plan. If the value is set to <code>false</code> for a service, AWS Backup does not try to protect that service's resources in this Region.</p>", |
| 20 | + "DescribeRegionSettings": "<p>Returns the current service opt-in settings for the Region. If service-opt-in is enabled for a service, AWS Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, AWS Backup does not try to protect that service's resources in this Region, AWS Backup does not try to protect that service's resources in this Region.</p>", |
20 | 21 | "DescribeRestoreJob": "<p>Returns metadata associated with a restore job that is specified by a job ID.</p>", |
21 | 22 | "ExportBackupPlanTemplate": "<p>Returns the backup plan that is specified by the plan ID as a backup template.</p>", |
22 | 23 | "GetBackupPlan": "<p>Returns <code>BackupPlan</code> details for the specified <code>BackupPlanId</code>. Returns the body of a backup plan in JSON format, in addition to plan metadata.</p>", |
|
48 | 49 | "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 | 50 | "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>", |
50 | 51 | "UpdateBackupPlan": "<p>Updates an existing backup plan identified by its <code>backupPlanId</code> with the input document in JSON format. The new version is uniquely identified by a <code>VersionId</code>.</p>", |
| 52 | + "UpdateGlobalSettings": "<p>Updates the current global settings for the AWS Account. Use the <code>DescribeGlobalSettings</code> API to determine the current settings.</p>", |
51 | 53 | "UpdateRecoveryPointLifecycle": "<p>Sets the transition lifecycle of a recovery point.</p> <p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>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. </p>", |
52 | | - "UpdateRegionSettings": "<p>Updates the current service opt-in settings for the Region. If the service has a value set to <code>true</code>, AWS Backup tries to protect that service's resources in this Region, when included in an on-demand backup or scheduled backup plan. If the value is set to <code>false</code> for a service, AWS Backup does not try to protect that service's resources in this Region.</p>" |
| 54 | + "UpdateRegionSettings": "<p>Updates the current service opt-in settings for the Region. If service-opt-in is enabled for a service, AWS Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, AWS Backup does not try to protect that service's resources in this Region. Use the <code>DescribeRegionSettings</code> API to determine the resource types that are supported.</p>" |
53 | 55 | }, |
54 | 56 | "shapes": { |
55 | 57 | "ARN": { |
|
82 | 84 | "DescribeRecoveryPointInput$RecoveryPointArn": "<p>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>", |
83 | 85 | "DescribeRecoveryPointOutput$RecoveryPointArn": "<p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>", |
84 | 86 | "DescribeRecoveryPointOutput$BackupVaultArn": "<p>An ARN that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>", |
| 87 | + "DescribeRecoveryPointOutput$SourceBackupVaultArn": "<p>An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, <code>arn:aws:backup:us-east-1:123456789012:vault:BackupVault</code>. If the recovery is restored to the same AWS account or Region, this value will be <code>null</code>.</p>", |
85 | 88 | "DescribeRecoveryPointOutput$ResourceArn": "<p>An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.</p>", |
86 | 89 | "DescribeRecoveryPointOutput$EncryptionKeyArn": "<p>The server-side encryption key used to protect your backups; for example, <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>", |
87 | 90 | "DescribeRestoreJobOutput$RecoveryPointArn": "<p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>", |
|
102 | 105 | "PutBackupVaultNotificationsInput$SNSTopicArn": "<p>The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, <code>arn:aws:sns:us-west-2:111122223333:MyVaultTopic</code>.</p>", |
103 | 106 | "RecoveryPointByBackupVault$RecoveryPointArn": "<p>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>", |
104 | 107 | "RecoveryPointByBackupVault$BackupVaultArn": "<p>An ARN that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>", |
| 108 | + "RecoveryPointByBackupVault$SourceBackupVaultArn": "<p>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 <code>null</code>.</p>", |
105 | 109 | "RecoveryPointByBackupVault$ResourceArn": "<p>An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>", |
106 | 110 | "RecoveryPointByBackupVault$EncryptionKeyArn": "<p>The server-side encryption key that is used to protect your backups; for example, <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>", |
107 | 111 | "RecoveryPointByResource$RecoveryPointArn": "<p>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>", |
|
193 | 197 | "BackupOptions": { |
194 | 198 | "base": null, |
195 | 199 | "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 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>", |
| 200 | + "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: </p> <p>Set to <code>\"WindowsVSS\":\"enabled\"</code> to enable the WindowsVSS backup option and create a VSS Windows backup. </p> <p>Set to <code>\"WindowsVSS\":\"disabled\"</code> 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 | 201 | "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 | 202 | "DescribeBackupJobOutput$BackupOptions": "<p>Represents the options specified as part of backup plan or on-demand backup job.</p>", |
199 | 203 | "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>" |
|
544 | 548 | "refs": { |
545 | 549 | } |
546 | 550 | }, |
| 551 | + "DescribeGlobalSettingsInput": { |
| 552 | + "base": null, |
| 553 | + "refs": { |
| 554 | + } |
| 555 | + }, |
| 556 | + "DescribeGlobalSettingsOutput": { |
| 557 | + "base": null, |
| 558 | + "refs": { |
| 559 | + } |
| 560 | + }, |
547 | 561 | "DescribeProtectedResourceInput": { |
548 | 562 | "base": null, |
549 | 563 | "refs": { |
|
669 | 683 | "refs": { |
670 | 684 | } |
671 | 685 | }, |
| 686 | + "GlobalSettings": { |
| 687 | + "base": null, |
| 688 | + "refs": { |
| 689 | + "DescribeGlobalSettingsOutput$GlobalSettings": "<p>A list of resources along with the opt-in preferences for the account.</p>", |
| 690 | + "UpdateGlobalSettingsInput$GlobalSettings": "<p>A list of resources along with the opt-in preferences for the account.</p>" |
| 691 | + } |
| 692 | + }, |
| 693 | + "GlobalSettingsName": { |
| 694 | + "base": null, |
| 695 | + "refs": { |
| 696 | + "GlobalSettings$key": null |
| 697 | + } |
| 698 | + }, |
| 699 | + "GlobalSettingsValue": { |
| 700 | + "base": null, |
| 701 | + "refs": { |
| 702 | + "GlobalSettings$value": null |
| 703 | + } |
| 704 | + }, |
672 | 705 | "IAMPolicy": { |
673 | 706 | "base": null, |
674 | 707 | "refs": { |
|
1146 | 1179 | "refs": { |
1147 | 1180 | } |
1148 | 1181 | }, |
| 1182 | + "UpdateGlobalSettingsInput": { |
| 1183 | + "base": null, |
| 1184 | + "refs": { |
| 1185 | + } |
| 1186 | + }, |
1149 | 1187 | "UpdateRecoveryPointLifecycleInput": { |
1150 | 1188 | "base": null, |
1151 | 1189 | "refs": { |
|
1233 | 1271 | "DescribeBackupJobOutput$BackupJobId": "<p>Uniquely identifies a request to AWS Backup to back up a resource.</p>", |
1234 | 1272 | "DescribeBackupJobOutput$StatusMessage": "<p>A detailed message explaining the status of the job to back up a resource.</p>", |
1235 | 1273 | "DescribeBackupJobOutput$PercentDone": "<p>Contains an estimated percentage that is complete of a job at the time the job status was queried.</p>", |
1236 | | - "DescribeBackupJobOutput$BackupType": "<p>Represents the actual backup type selected for a backup job. For example, if a successful WindowsVSS backup was taken, <code>BackupType</code> returns “WindowsVSS”. If <code>BackupType</code> is empty, then it is a regular backup.</p>", |
| 1274 | + "DescribeBackupJobOutput$BackupType": "<p>Represents the actual backup type selected for a backup job. For example, if a successful WindowsVSS backup was taken, <code>BackupType</code> returns \"WindowsVSS\". If <code>BackupType</code> is empty, then the backup type that was is a regular backup.</p>", |
1237 | 1275 | "DescribeBackupVaultInput$BackupVaultName": "<p>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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>", |
1238 | 1276 | "DescribeBackupVaultOutput$BackupVaultName": "<p>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.</p>", |
1239 | 1277 | "DescribeBackupVaultOutput$CreatorRequestId": "<p>A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.</p>", |
|
1350 | 1388 | "DescribeBackupJobOutput$ExpectedCompletionDate": "<p>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 <code>ExpectedCompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>", |
1351 | 1389 | "DescribeBackupJobOutput$StartBy": "<p>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 <code>StartBy</code> time would be 8:00 PM on the date specified. The value of <code>StartBy</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>", |
1352 | 1390 | "DescribeBackupVaultOutput$CreationDate": "<p>The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>", |
| 1391 | + "DescribeGlobalSettingsOutput$LastUpdateTime": "<p>The date and time that the global settings was last updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of <code>LastUpdateTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>", |
1353 | 1392 | "DescribeProtectedResourceOutput$LastBackupTime": "<p>The date and time that a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of <code>LastBackupTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>", |
1354 | 1393 | "DescribeRecoveryPointOutput$CreationDate": "<p>The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>", |
1355 | 1394 | "DescribeRecoveryPointOutput$CompletionDate": "<p>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 <code>CompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>", |
|
0 commit comments