@aws-sdk/client-backup 3.50.0 → 3.53.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (113) hide show
  1. package/CHANGELOG.md +30 -0
  2. package/dist-cjs/index.js +3 -0
  3. package/dist-cjs/models/BackupServiceException.js +11 -0
  4. package/dist-cjs/models/models_0.js +179 -4
  5. package/dist-cjs/protocols/Aws_restJson1.js +653 -2416
  6. package/dist-es/index.js +1 -0
  7. package/dist-es/models/BackupServiceException.js +12 -0
  8. package/dist-es/models/models_0.js +166 -1
  9. package/dist-es/protocols/Aws_restJson1.js +1433 -2691
  10. package/dist-types/Backup.d.ts +14 -12
  11. package/dist-types/commands/CreateBackupSelectionCommand.d.ts +1 -2
  12. package/dist-types/commands/ListTagsCommand.d.ts +4 -5
  13. package/dist-types/commands/UpdateRecoveryPointLifecycleCommand.d.ts +9 -5
  14. package/dist-types/index.d.ts +1 -0
  15. package/dist-types/models/BackupServiceException.d.ts +10 -0
  16. package/dist-types/models/models_0.d.ts +270 -99
  17. package/dist-types/ts3.4/Backup.d.ts +335 -0
  18. package/dist-types/ts3.4/BackupClient.d.ts +139 -0
  19. package/dist-types/ts3.4/commands/CreateBackupPlanCommand.d.ts +17 -0
  20. package/dist-types/ts3.4/commands/CreateBackupSelectionCommand.d.ts +17 -0
  21. package/dist-types/ts3.4/commands/CreateBackupVaultCommand.d.ts +17 -0
  22. package/dist-types/ts3.4/commands/CreateFrameworkCommand.d.ts +17 -0
  23. package/dist-types/ts3.4/commands/CreateReportPlanCommand.d.ts +17 -0
  24. package/dist-types/ts3.4/commands/DeleteBackupPlanCommand.d.ts +17 -0
  25. package/dist-types/ts3.4/commands/DeleteBackupSelectionCommand.d.ts +17 -0
  26. package/dist-types/ts3.4/commands/DeleteBackupVaultAccessPolicyCommand.d.ts +17 -0
  27. package/dist-types/ts3.4/commands/DeleteBackupVaultCommand.d.ts +17 -0
  28. package/dist-types/ts3.4/commands/DeleteBackupVaultLockConfigurationCommand.d.ts +17 -0
  29. package/dist-types/ts3.4/commands/DeleteBackupVaultNotificationsCommand.d.ts +17 -0
  30. package/dist-types/ts3.4/commands/DeleteFrameworkCommand.d.ts +17 -0
  31. package/dist-types/ts3.4/commands/DeleteRecoveryPointCommand.d.ts +17 -0
  32. package/dist-types/ts3.4/commands/DeleteReportPlanCommand.d.ts +17 -0
  33. package/dist-types/ts3.4/commands/DescribeBackupJobCommand.d.ts +17 -0
  34. package/dist-types/ts3.4/commands/DescribeBackupVaultCommand.d.ts +17 -0
  35. package/dist-types/ts3.4/commands/DescribeCopyJobCommand.d.ts +17 -0
  36. package/dist-types/ts3.4/commands/DescribeFrameworkCommand.d.ts +17 -0
  37. package/dist-types/ts3.4/commands/DescribeGlobalSettingsCommand.d.ts +17 -0
  38. package/dist-types/ts3.4/commands/DescribeProtectedResourceCommand.d.ts +17 -0
  39. package/dist-types/ts3.4/commands/DescribeRecoveryPointCommand.d.ts +17 -0
  40. package/dist-types/ts3.4/commands/DescribeRegionSettingsCommand.d.ts +17 -0
  41. package/dist-types/ts3.4/commands/DescribeReportJobCommand.d.ts +17 -0
  42. package/dist-types/ts3.4/commands/DescribeReportPlanCommand.d.ts +17 -0
  43. package/dist-types/ts3.4/commands/DescribeRestoreJobCommand.d.ts +17 -0
  44. package/dist-types/ts3.4/commands/DisassociateRecoveryPointCommand.d.ts +17 -0
  45. package/dist-types/ts3.4/commands/ExportBackupPlanTemplateCommand.d.ts +17 -0
  46. package/dist-types/ts3.4/commands/GetBackupPlanCommand.d.ts +17 -0
  47. package/dist-types/ts3.4/commands/GetBackupPlanFromJSONCommand.d.ts +17 -0
  48. package/dist-types/ts3.4/commands/GetBackupPlanFromTemplateCommand.d.ts +17 -0
  49. package/dist-types/ts3.4/commands/GetBackupSelectionCommand.d.ts +17 -0
  50. package/dist-types/ts3.4/commands/GetBackupVaultAccessPolicyCommand.d.ts +17 -0
  51. package/dist-types/ts3.4/commands/GetBackupVaultNotificationsCommand.d.ts +17 -0
  52. package/dist-types/ts3.4/commands/GetRecoveryPointRestoreMetadataCommand.d.ts +17 -0
  53. package/dist-types/ts3.4/commands/GetSupportedResourceTypesCommand.d.ts +17 -0
  54. package/dist-types/ts3.4/commands/ListBackupJobsCommand.d.ts +17 -0
  55. package/dist-types/ts3.4/commands/ListBackupPlanTemplatesCommand.d.ts +17 -0
  56. package/dist-types/ts3.4/commands/ListBackupPlanVersionsCommand.d.ts +17 -0
  57. package/dist-types/ts3.4/commands/ListBackupPlansCommand.d.ts +17 -0
  58. package/dist-types/ts3.4/commands/ListBackupSelectionsCommand.d.ts +17 -0
  59. package/dist-types/ts3.4/commands/ListBackupVaultsCommand.d.ts +17 -0
  60. package/dist-types/ts3.4/commands/ListCopyJobsCommand.d.ts +17 -0
  61. package/dist-types/ts3.4/commands/ListFrameworksCommand.d.ts +17 -0
  62. package/dist-types/ts3.4/commands/ListProtectedResourcesCommand.d.ts +17 -0
  63. package/dist-types/ts3.4/commands/ListRecoveryPointsByBackupVaultCommand.d.ts +17 -0
  64. package/dist-types/ts3.4/commands/ListRecoveryPointsByResourceCommand.d.ts +17 -0
  65. package/dist-types/ts3.4/commands/ListReportJobsCommand.d.ts +17 -0
  66. package/dist-types/ts3.4/commands/ListReportPlansCommand.d.ts +17 -0
  67. package/dist-types/ts3.4/commands/ListRestoreJobsCommand.d.ts +17 -0
  68. package/dist-types/ts3.4/commands/ListTagsCommand.d.ts +17 -0
  69. package/dist-types/ts3.4/commands/PutBackupVaultAccessPolicyCommand.d.ts +17 -0
  70. package/dist-types/ts3.4/commands/PutBackupVaultLockConfigurationCommand.d.ts +17 -0
  71. package/dist-types/ts3.4/commands/PutBackupVaultNotificationsCommand.d.ts +17 -0
  72. package/dist-types/ts3.4/commands/StartBackupJobCommand.d.ts +17 -0
  73. package/dist-types/ts3.4/commands/StartCopyJobCommand.d.ts +17 -0
  74. package/dist-types/ts3.4/commands/StartReportJobCommand.d.ts +17 -0
  75. package/dist-types/ts3.4/commands/StartRestoreJobCommand.d.ts +17 -0
  76. package/dist-types/ts3.4/commands/StopBackupJobCommand.d.ts +17 -0
  77. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +17 -0
  78. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +17 -0
  79. package/dist-types/ts3.4/commands/UpdateBackupPlanCommand.d.ts +17 -0
  80. package/dist-types/ts3.4/commands/UpdateFrameworkCommand.d.ts +17 -0
  81. package/dist-types/ts3.4/commands/UpdateGlobalSettingsCommand.d.ts +17 -0
  82. package/dist-types/ts3.4/commands/UpdateRecoveryPointLifecycleCommand.d.ts +17 -0
  83. package/dist-types/ts3.4/commands/UpdateRegionSettingsCommand.d.ts +17 -0
  84. package/dist-types/ts3.4/commands/UpdateReportPlanCommand.d.ts +17 -0
  85. package/dist-types/ts3.4/commands/index.d.ts +66 -0
  86. package/dist-types/ts3.4/endpoints.d.ts +2 -0
  87. package/dist-types/ts3.4/index.d.ts +6 -0
  88. package/dist-types/ts3.4/models/BackupServiceException.d.ts +6 -0
  89. package/dist-types/ts3.4/models/index.d.ts +1 -0
  90. package/dist-types/ts3.4/models/models_0.d.ts +2234 -0
  91. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  92. package/dist-types/ts3.4/pagination/ListBackupJobsPaginator.d.ts +4 -0
  93. package/dist-types/ts3.4/pagination/ListBackupPlanTemplatesPaginator.d.ts +4 -0
  94. package/dist-types/ts3.4/pagination/ListBackupPlanVersionsPaginator.d.ts +4 -0
  95. package/dist-types/ts3.4/pagination/ListBackupPlansPaginator.d.ts +4 -0
  96. package/dist-types/ts3.4/pagination/ListBackupSelectionsPaginator.d.ts +4 -0
  97. package/dist-types/ts3.4/pagination/ListBackupVaultsPaginator.d.ts +4 -0
  98. package/dist-types/ts3.4/pagination/ListCopyJobsPaginator.d.ts +4 -0
  99. package/dist-types/ts3.4/pagination/ListFrameworksPaginator.d.ts +4 -0
  100. package/dist-types/ts3.4/pagination/ListProtectedResourcesPaginator.d.ts +4 -0
  101. package/dist-types/ts3.4/pagination/ListRecoveryPointsByBackupVaultPaginator.d.ts +4 -0
  102. package/dist-types/ts3.4/pagination/ListRecoveryPointsByResourcePaginator.d.ts +4 -0
  103. package/dist-types/ts3.4/pagination/ListReportJobsPaginator.d.ts +4 -0
  104. package/dist-types/ts3.4/pagination/ListReportPlansPaginator.d.ts +4 -0
  105. package/dist-types/ts3.4/pagination/ListRestoreJobsPaginator.d.ts +4 -0
  106. package/dist-types/ts3.4/pagination/ListTagsPaginator.d.ts +4 -0
  107. package/dist-types/ts3.4/pagination/index.d.ts +16 -0
  108. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +200 -0
  109. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +38 -0
  110. package/dist-types/ts3.4/runtimeConfig.d.ts +38 -0
  111. package/dist-types/ts3.4/runtimeConfig.native.d.ts +37 -0
  112. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +11 -0
  113. package/package.json +33 -33
@@ -86,8 +86,7 @@ export declare class Backup extends BackupClient {
86
86
  createBackupPlan(args: CreateBackupPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackupPlanCommandOutput) => void): void;
87
87
  /**
88
88
  * <p>Creates a JSON document that specifies a set of resources to assign to a backup plan.
89
- * For examples, see <a href="https://docs.aws.amazon.com/assigning-resources.html#assigning-resources-json">Assigning resources
90
- * programmatically</a>. </p>
89
+ * For examples, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json">Assigning resources programmatically</a>. </p>
91
90
  */
92
91
  createBackupSelection(args: CreateBackupSelectionCommandInput, options?: __HttpHandlerOptions): Promise<CreateBackupSelectionCommandOutput>;
93
92
  createBackupSelection(args: CreateBackupSelectionCommandInput, cb: (err: any, data?: CreateBackupSelectionCommandOutput) => void): void;
@@ -433,11 +432,10 @@ export declare class Backup extends BackupClient {
433
432
  /**
434
433
  * <p>Returns a list of key-value pairs assigned to a target recovery point, backup plan, or
435
434
  * backup vault.</p>
436
- * <note>
437
- * <p>
438
- * <code>ListTags</code> are currently only supported with Amazon EFS
439
- * backups.</p>
440
- * </note>
435
+ * <p>
436
+ * <code>ListTags</code> only works for resource types that support full Backup
437
+ * management of their backups. Those resource types are listed in the "Full Backup management" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature
438
+ * availability by resource</a> table.</p>
441
439
  */
442
440
  listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsCommandOutput>;
443
441
  listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void;
@@ -544,11 +542,15 @@ export declare class Backup extends BackupClient {
544
542
  * it expires. Backup transitions and expires backups automatically according to
545
543
  * the lifecycle that you define.</p>
546
544
  * <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90
547
- * days. Therefore, the “expire after days” setting must be 90 days greater than the
548
- * “transition to cold after days” setting. The “transition to cold after days” setting cannot
549
- * be changed after a backup has been transitioned to cold.</p>
550
- * <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>
551
- * <p>Does not support continuous backups.</p>
545
+ * days. Therefore, the “retention” setting must be 90 days greater than the “transition to
546
+ * cold after days” setting. The “transition to cold after days” setting cannot be changed
547
+ * after a backup has been transitioned to cold.</p>
548
+ * <p>Only resource types that support full Backup management can transition their
549
+ * backups to cold storage. Those resource types are listed in the "Full Backup
550
+ * management" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature
551
+ * availability by resource</a> table. Backup ignores this expression for
552
+ * other resource types.</p>
553
+ * <p>This operation does not support continuous backups.</p>
552
554
  */
553
555
  updateRecoveryPointLifecycle(args: UpdateRecoveryPointLifecycleCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRecoveryPointLifecycleCommandOutput>;
554
556
  updateRecoveryPointLifecycle(args: UpdateRecoveryPointLifecycleCommandInput, cb: (err: any, data?: UpdateRecoveryPointLifecycleCommandOutput) => void): void;
@@ -8,8 +8,7 @@ export interface CreateBackupSelectionCommandOutput extends CreateBackupSelectio
8
8
  }
9
9
  /**
10
10
  * <p>Creates a JSON document that specifies a set of resources to assign to a backup plan.
11
- * For examples, see <a href="https://docs.aws.amazon.com/assigning-resources.html#assigning-resources-json">Assigning resources
12
- * programmatically</a>. </p>
11
+ * For examples, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json">Assigning resources programmatically</a>. </p>
13
12
  * @example
14
13
  * Use a bare-bones client and the command you need to make an API call.
15
14
  * ```javascript
@@ -9,11 +9,10 @@ export interface ListTagsCommandOutput extends ListTagsOutput, __MetadataBearer
9
9
  /**
10
10
  * <p>Returns a list of key-value pairs assigned to a target recovery point, backup plan, or
11
11
  * backup vault.</p>
12
- * <note>
13
- * <p>
14
- * <code>ListTags</code> are currently only supported with Amazon EFS
15
- * backups.</p>
16
- * </note>
12
+ * <p>
13
+ * <code>ListTags</code> only works for resource types that support full Backup
14
+ * management of their backups. Those resource types are listed in the "Full Backup management" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature
15
+ * availability by resource</a> table.</p>
17
16
  * @example
18
17
  * Use a bare-bones client and the command you need to make an API call.
19
18
  * ```javascript
@@ -12,11 +12,15 @@ export interface UpdateRecoveryPointLifecycleCommandOutput extends UpdateRecover
12
12
  * it expires. Backup transitions and expires backups automatically according to
13
13
  * the lifecycle that you define.</p>
14
14
  * <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90
15
- * days. Therefore, the “expire after days” setting must be 90 days greater than the
16
- * “transition to cold after days” setting. The “transition to cold after days” setting cannot
17
- * be changed after a backup has been transitioned to cold.</p>
18
- * <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>
19
- * <p>Does not support continuous backups.</p>
15
+ * days. Therefore, the “retention” setting must be 90 days greater than the “transition to
16
+ * cold after days” setting. The “transition to cold after days” setting cannot be changed
17
+ * after a backup has been transitioned to cold.</p>
18
+ * <p>Only resource types that support full Backup management can transition their
19
+ * backups to cold storage. Those resource types are listed in the "Full Backup
20
+ * management" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature
21
+ * availability by resource</a> table. Backup ignores this expression for
22
+ * other resource types.</p>
23
+ * <p>This operation does not support continuous backups.</p>
20
24
  * @example
21
25
  * Use a bare-bones client and the command you need to make an API call.
22
26
  * ```javascript
@@ -3,3 +3,4 @@ export * from "./BackupClient";
3
3
  export * from "./commands";
4
4
  export * from "./models";
5
5
  export * from "./pagination";
6
+ export { BackupServiceException } from "./models/BackupServiceException";
@@ -0,0 +1,10 @@
1
+ import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
+ /**
3
+ * Base exception class for all service exceptions from Backup service.
4
+ */
5
+ export declare class BackupServiceException extends __ServiceException {
6
+ /**
7
+ * @internal
8
+ */
9
+ constructor(options: __ServiceExceptionOptions);
10
+ }