@aws-sdk/client-backup 3.325.0 → 3.327.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 (73) hide show
  1. package/dist-types/commands/CancelLegalHoldCommand.d.ts +4 -0
  2. package/dist-types/commands/CreateBackupPlanCommand.d.ts +17 -0
  3. package/dist-types/commands/CreateBackupSelectionCommand.d.ts +8 -0
  4. package/dist-types/commands/CreateBackupVaultCommand.d.ts +8 -0
  5. package/dist-types/commands/CreateFrameworkCommand.d.ts +7 -0
  6. package/dist-types/commands/CreateLegalHoldCommand.d.ts +23 -0
  7. package/dist-types/commands/CreateReportPlanCommand.d.ts +8 -0
  8. package/dist-types/commands/DeleteBackupPlanCommand.d.ts +9 -0
  9. package/dist-types/commands/DeleteBackupSelectionCommand.d.ts +4 -0
  10. package/dist-types/commands/DeleteBackupVaultAccessPolicyCommand.d.ts +4 -0
  11. package/dist-types/commands/DeleteBackupVaultCommand.d.ts +4 -0
  12. package/dist-types/commands/DeleteBackupVaultLockConfigurationCommand.d.ts +4 -0
  13. package/dist-types/commands/DeleteBackupVaultNotificationsCommand.d.ts +4 -0
  14. package/dist-types/commands/DeleteFrameworkCommand.d.ts +4 -0
  15. package/dist-types/commands/DeleteRecoveryPointCommand.d.ts +4 -0
  16. package/dist-types/commands/DeleteReportPlanCommand.d.ts +4 -0
  17. package/dist-types/commands/DescribeBackupJobCommand.d.ts +39 -0
  18. package/dist-types/commands/DescribeBackupVaultCommand.d.ts +15 -0
  19. package/dist-types/commands/DescribeCopyJobCommand.d.ts +35 -0
  20. package/dist-types/commands/DescribeFrameworkCommand.d.ts +34 -0
  21. package/dist-types/commands/DescribeGlobalSettingsCommand.d.ts +9 -0
  22. package/dist-types/commands/DescribeProtectedResourceCommand.d.ts +9 -0
  23. package/dist-types/commands/DescribeRecoveryPointCommand.d.ts +39 -0
  24. package/dist-types/commands/DescribeRegionSettingsCommand.d.ts +11 -0
  25. package/dist-types/commands/DescribeReportJobCommand.d.ts +20 -0
  26. package/dist-types/commands/DescribeReportPlanCommand.d.ts +37 -0
  27. package/dist-types/commands/DescribeRestoreJobCommand.d.ts +18 -0
  28. package/dist-types/commands/DisassociateRecoveryPointCommand.d.ts +4 -0
  29. package/dist-types/commands/DisassociateRecoveryPointFromParentCommand.d.ts +4 -0
  30. package/dist-types/commands/ExportBackupPlanTemplateCommand.d.ts +6 -0
  31. package/dist-types/commands/GetBackupPlanCommand.d.ts +58 -0
  32. package/dist-types/commands/GetBackupPlanFromJSONCommand.d.ts +43 -0
  33. package/dist-types/commands/GetBackupPlanFromTemplateCommand.d.ts +43 -0
  34. package/dist-types/commands/GetBackupSelectionCommand.d.ts +52 -0
  35. package/dist-types/commands/GetBackupVaultAccessPolicyCommand.d.ts +8 -0
  36. package/dist-types/commands/GetBackupVaultNotificationsCommand.d.ts +11 -0
  37. package/dist-types/commands/GetLegalHoldCommand.d.ts +26 -0
  38. package/dist-types/commands/GetRecoveryPointRestoreMetadataCommand.d.ts +10 -0
  39. package/dist-types/commands/GetSupportedResourceTypesCommand.d.ts +8 -0
  40. package/dist-types/commands/ListBackupJobsCommand.d.ts +40 -0
  41. package/dist-types/commands/ListBackupPlanTemplatesCommand.d.ts +12 -0
  42. package/dist-types/commands/ListBackupPlanVersionsCommand.d.ts +26 -0
  43. package/dist-types/commands/ListBackupPlansCommand.d.ts +26 -0
  44. package/dist-types/commands/ListBackupSelectionsCommand.d.ts +16 -0
  45. package/dist-types/commands/ListBackupVaultsCommand.d.ts +20 -0
  46. package/dist-types/commands/ListCopyJobsCommand.d.ts +38 -0
  47. package/dist-types/commands/ListFrameworksCommand.d.ts +16 -0
  48. package/dist-types/commands/ListLegalHoldsCommand.d.ts +17 -0
  49. package/dist-types/commands/ListProtectedResourcesCommand.d.ts +14 -0
  50. package/dist-types/commands/ListRecoveryPointsByBackupVaultCommand.d.ts +43 -0
  51. package/dist-types/commands/ListRecoveryPointsByLegalHoldCommand.d.ts +11 -0
  52. package/dist-types/commands/ListRecoveryPointsByResourceCommand.d.ts +20 -0
  53. package/dist-types/commands/ListReportJobsCommand.d.ts +23 -0
  54. package/dist-types/commands/ListReportPlansCommand.d.ts +40 -0
  55. package/dist-types/commands/ListRestoreJobsCommand.d.ts +23 -0
  56. package/dist-types/commands/ListTagsCommand.d.ts +9 -0
  57. package/dist-types/commands/PutBackupVaultAccessPolicyCommand.d.ts +4 -0
  58. package/dist-types/commands/PutBackupVaultLockConfigurationCommand.d.ts +4 -0
  59. package/dist-types/commands/PutBackupVaultNotificationsCommand.d.ts +4 -0
  60. package/dist-types/commands/StartBackupJobCommand.d.ts +9 -0
  61. package/dist-types/commands/StartCopyJobCommand.d.ts +8 -0
  62. package/dist-types/commands/StartReportJobCommand.d.ts +6 -0
  63. package/dist-types/commands/StartRestoreJobCommand.d.ts +6 -0
  64. package/dist-types/commands/StopBackupJobCommand.d.ts +4 -0
  65. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  66. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  67. package/dist-types/commands/UpdateBackupPlanCommand.d.ts +17 -0
  68. package/dist-types/commands/UpdateFrameworkCommand.d.ts +8 -0
  69. package/dist-types/commands/UpdateGlobalSettingsCommand.d.ts +4 -0
  70. package/dist-types/commands/UpdateRecoveryPointLifecycleCommand.d.ts +15 -0
  71. package/dist-types/commands/UpdateRegionSettingsCommand.d.ts +4 -0
  72. package/dist-types/commands/UpdateReportPlanCommand.d.ts +8 -0
  73. package/package.json +7 -7
@@ -40,6 +40,12 @@ export interface StartCopyJobCommandOutput extends StartCopyJobOutput, __Metadat
40
40
  * };
41
41
  * const command = new StartCopyJobCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // StartCopyJobOutput
44
+ * // CopyJobId: "STRING_VALUE",
45
+ * // CreationDate: new Date("TIMESTAMP"),
46
+ * // IsParent: true || false,
47
+ * // };
48
+ *
43
49
  * ```
44
50
  *
45
51
  * @param StartCopyJobCommandInput - {@link StartCopyJobCommandInput}
@@ -69,6 +75,8 @@ export interface StartCopyJobCommandOutput extends StartCopyJobOutput, __Metadat
69
75
  * @throws {@link ServiceUnavailableException} (server fault)
70
76
  * <p>The request failed due to a temporary failure of the server.</p>
71
77
  *
78
+ * @throws {@link BackupServiceException}
79
+ * <p>Base exception class for all service exceptions from Backup service.</p>
72
80
  *
73
81
  */
74
82
  export declare class StartCopyJobCommand extends $Command<StartCopyJobCommandInput, StartCopyJobCommandOutput, BackupClientResolvedConfig> {
@@ -32,6 +32,10 @@ export interface StartReportJobCommandOutput extends StartReportJobOutput, __Met
32
32
  * };
33
33
  * const command = new StartReportJobCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // StartReportJobOutput
36
+ * // ReportJobId: "STRING_VALUE",
37
+ * // };
38
+ *
35
39
  * ```
36
40
  *
37
41
  * @param StartReportJobCommandInput - {@link StartReportJobCommandInput}
@@ -53,6 +57,8 @@ export interface StartReportJobCommandOutput extends StartReportJobOutput, __Met
53
57
  * @throws {@link ServiceUnavailableException} (server fault)
54
58
  * <p>The request failed due to a temporary failure of the server.</p>
55
59
  *
60
+ * @throws {@link BackupServiceException}
61
+ * <p>Base exception class for all service exceptions from Backup service.</p>
56
62
  *
57
63
  */
58
64
  export declare class StartReportJobCommand extends $Command<StartReportJobCommandInput, StartReportJobCommandOutput, BackupClientResolvedConfig> {
@@ -37,6 +37,10 @@ export interface StartRestoreJobCommandOutput extends StartRestoreJobOutput, __M
37
37
  * };
38
38
  * const command = new StartRestoreJobCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // StartRestoreJobOutput
41
+ * // RestoreJobId: "STRING_VALUE",
42
+ * // };
43
+ *
40
44
  * ```
41
45
  *
42
46
  * @param StartRestoreJobCommandInput - {@link StartRestoreJobCommandInput}
@@ -58,6 +62,8 @@ export interface StartRestoreJobCommandOutput extends StartRestoreJobOutput, __M
58
62
  * @throws {@link ServiceUnavailableException} (server fault)
59
63
  * <p>The request failed due to a temporary failure of the server.</p>
60
64
  *
65
+ * @throws {@link BackupServiceException}
66
+ * <p>Base exception class for all service exceptions from Backup service.</p>
61
67
  *
62
68
  */
63
69
  export declare class StartRestoreJobCommand extends $Command<StartRestoreJobCommandInput, StartRestoreJobCommandOutput, BackupClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface StopBackupJobCommandOutput extends __MetadataBearer {
35
35
  * };
36
36
  * const command = new StopBackupJobCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param StopBackupJobCommandInput - {@link StopBackupJobCommandInput}
@@ -60,6 +62,8 @@ export interface StopBackupJobCommandOutput extends __MetadataBearer {
60
62
  * @throws {@link ServiceUnavailableException} (server fault)
61
63
  * <p>The request failed due to a temporary failure of the server.</p>
62
64
  *
65
+ * @throws {@link BackupServiceException}
66
+ * <p>Base exception class for all service exceptions from Backup service.</p>
63
67
  *
64
68
  */
65
69
  export declare class StopBackupJobCommand extends $Command<StopBackupJobCommandInput, StopBackupJobCommandOutput, BackupClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
35
35
  * };
36
36
  * const command = new TagResourceCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -60,6 +62,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
60
62
  * @throws {@link ServiceUnavailableException} (server fault)
61
63
  * <p>The request failed due to a temporary failure of the server.</p>
62
64
  *
65
+ * @throws {@link BackupServiceException}
66
+ * <p>Base exception class for all service exceptions from Backup service.</p>
63
67
  *
64
68
  */
65
69
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, BackupClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
35
35
  * };
36
36
  * const command = new UntagResourceCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -56,6 +58,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
56
58
  * @throws {@link ServiceUnavailableException} (server fault)
57
59
  * <p>The request failed due to a temporary failure of the server.</p>
58
60
  *
61
+ * @throws {@link BackupServiceException}
62
+ * <p>Base exception class for all service exceptions from Backup service.</p>
59
63
  *
60
64
  */
61
65
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, BackupClientResolvedConfig> {
@@ -70,6 +70,21 @@ export interface UpdateBackupPlanCommandOutput extends UpdateBackupPlanOutput, _
70
70
  * };
71
71
  * const command = new UpdateBackupPlanCommand(input);
72
72
  * const response = await client.send(command);
73
+ * // { // UpdateBackupPlanOutput
74
+ * // BackupPlanId: "STRING_VALUE",
75
+ * // BackupPlanArn: "STRING_VALUE",
76
+ * // CreationDate: new Date("TIMESTAMP"),
77
+ * // VersionId: "STRING_VALUE",
78
+ * // AdvancedBackupSettings: [ // AdvancedBackupSettings
79
+ * // { // AdvancedBackupSetting
80
+ * // ResourceType: "STRING_VALUE",
81
+ * // BackupOptions: { // BackupOptions
82
+ * // "<keys>": "STRING_VALUE",
83
+ * // },
84
+ * // },
85
+ * // ],
86
+ * // };
87
+ *
73
88
  * ```
74
89
  *
75
90
  * @param UpdateBackupPlanCommandInput - {@link UpdateBackupPlanCommandInput}
@@ -91,6 +106,8 @@ export interface UpdateBackupPlanCommandOutput extends UpdateBackupPlanOutput, _
91
106
  * @throws {@link ServiceUnavailableException} (server fault)
92
107
  * <p>The request failed due to a temporary failure of the server.</p>
93
108
  *
109
+ * @throws {@link BackupServiceException}
110
+ * <p>Base exception class for all service exceptions from Backup service.</p>
94
111
  *
95
112
  */
96
113
  export declare class UpdateBackupPlanCommand extends $Command<UpdateBackupPlanCommandInput, UpdateBackupPlanCommandOutput, BackupClientResolvedConfig> {
@@ -56,6 +56,12 @@ export interface UpdateFrameworkCommandOutput extends UpdateFrameworkOutput, __M
56
56
  * };
57
57
  * const command = new UpdateFrameworkCommand(input);
58
58
  * const response = await client.send(command);
59
+ * // { // UpdateFrameworkOutput
60
+ * // FrameworkName: "STRING_VALUE",
61
+ * // FrameworkArn: "STRING_VALUE",
62
+ * // CreationTime: new Date("TIMESTAMP"),
63
+ * // };
64
+ *
59
65
  * ```
60
66
  *
61
67
  * @param UpdateFrameworkCommandInput - {@link UpdateFrameworkCommandInput}
@@ -88,6 +94,8 @@ export interface UpdateFrameworkCommandOutput extends UpdateFrameworkOutput, __M
88
94
  * @throws {@link ServiceUnavailableException} (server fault)
89
95
  * <p>The request failed due to a temporary failure of the server.</p>
90
96
  *
97
+ * @throws {@link BackupServiceException}
98
+ * <p>Base exception class for all service exceptions from Backup service.</p>
91
99
  *
92
100
  */
93
101
  export declare class UpdateFrameworkCommand extends $Command<UpdateFrameworkCommandInput, UpdateFrameworkCommandOutput, BackupClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface UpdateGlobalSettingsCommandOutput extends __MetadataBearer {
35
35
  * };
36
36
  * const command = new UpdateGlobalSettingsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param UpdateGlobalSettingsCommandInput - {@link UpdateGlobalSettingsCommandInput}
@@ -57,6 +59,8 @@ export interface UpdateGlobalSettingsCommandOutput extends __MetadataBearer {
57
59
  * @throws {@link ServiceUnavailableException} (server fault)
58
60
  * <p>The request failed due to a temporary failure of the server.</p>
59
61
  *
62
+ * @throws {@link BackupServiceException}
63
+ * <p>Base exception class for all service exceptions from Backup service.</p>
60
64
  *
61
65
  */
62
66
  export declare class UpdateGlobalSettingsCommand extends $Command<UpdateGlobalSettingsCommandInput, UpdateGlobalSettingsCommandOutput, BackupClientResolvedConfig> {
@@ -48,6 +48,19 @@ export interface UpdateRecoveryPointLifecycleCommandOutput extends UpdateRecover
48
48
  * };
49
49
  * const command = new UpdateRecoveryPointLifecycleCommand(input);
50
50
  * const response = await client.send(command);
51
+ * // { // UpdateRecoveryPointLifecycleOutput
52
+ * // BackupVaultArn: "STRING_VALUE",
53
+ * // RecoveryPointArn: "STRING_VALUE",
54
+ * // Lifecycle: { // Lifecycle
55
+ * // MoveToColdStorageAfterDays: Number("long"),
56
+ * // DeleteAfterDays: Number("long"),
57
+ * // },
58
+ * // CalculatedLifecycle: { // CalculatedLifecycle
59
+ * // MoveToColdStorageAt: new Date("TIMESTAMP"),
60
+ * // DeleteAt: new Date("TIMESTAMP"),
61
+ * // },
62
+ * // };
63
+ *
51
64
  * ```
52
65
  *
53
66
  * @param UpdateRecoveryPointLifecycleCommandInput - {@link UpdateRecoveryPointLifecycleCommandInput}
@@ -73,6 +86,8 @@ export interface UpdateRecoveryPointLifecycleCommandOutput extends UpdateRecover
73
86
  * @throws {@link ServiceUnavailableException} (server fault)
74
87
  * <p>The request failed due to a temporary failure of the server.</p>
75
88
  *
89
+ * @throws {@link BackupServiceException}
90
+ * <p>Base exception class for all service exceptions from Backup service.</p>
76
91
  *
77
92
  */
78
93
  export declare class UpdateRecoveryPointLifecycleCommand extends $Command<UpdateRecoveryPointLifecycleCommandInput, UpdateRecoveryPointLifecycleCommandOutput, BackupClientResolvedConfig> {
@@ -41,6 +41,8 @@ export interface UpdateRegionSettingsCommandOutput extends __MetadataBearer {
41
41
  * };
42
42
  * const command = new UpdateRegionSettingsCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // {};
45
+ *
44
46
  * ```
45
47
  *
46
48
  * @param UpdateRegionSettingsCommandInput - {@link UpdateRegionSettingsCommandInput}
@@ -59,6 +61,8 @@ export interface UpdateRegionSettingsCommandOutput extends __MetadataBearer {
59
61
  * @throws {@link ServiceUnavailableException} (server fault)
60
62
  * <p>The request failed due to a temporary failure of the server.</p>
61
63
  *
64
+ * @throws {@link BackupServiceException}
65
+ * <p>Base exception class for all service exceptions from Backup service.</p>
62
66
  *
63
67
  */
64
68
  export declare class UpdateRegionSettingsCommand extends $Command<UpdateRegionSettingsCommandInput, UpdateRegionSettingsCommandOutput, BackupClientResolvedConfig> {
@@ -57,6 +57,12 @@ export interface UpdateReportPlanCommandOutput extends UpdateReportPlanOutput, _
57
57
  * };
58
58
  * const command = new UpdateReportPlanCommand(input);
59
59
  * const response = await client.send(command);
60
+ * // { // UpdateReportPlanOutput
61
+ * // ReportPlanName: "STRING_VALUE",
62
+ * // ReportPlanArn: "STRING_VALUE",
63
+ * // CreationTime: new Date("TIMESTAMP"),
64
+ * // };
65
+ *
60
66
  * ```
61
67
  *
62
68
  * @param UpdateReportPlanCommandInput - {@link UpdateReportPlanCommandInput}
@@ -82,6 +88,8 @@ export interface UpdateReportPlanCommandOutput extends UpdateReportPlanOutput, _
82
88
  * @throws {@link ServiceUnavailableException} (server fault)
83
89
  * <p>The request failed due to a temporary failure of the server.</p>
84
90
  *
91
+ * @throws {@link BackupServiceException}
92
+ * <p>Base exception class for all service exceptions from Backup service.</p>
85
93
  *
86
94
  */
87
95
  export declare class UpdateReportPlanCommand extends $Command<UpdateReportPlanCommandInput, UpdateReportPlanCommandOutput, BackupClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-backup",
3
3
  "description": "AWS SDK for JavaScript Backup Client for Node.js, Browser and React Native",
4
- "version": "3.325.0",
4
+ "version": "3.327.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.325.0",
24
+ "@aws-sdk/client-sts": "3.327.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.325.0",
26
+ "@aws-sdk/credential-provider-node": "3.327.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -32,11 +32,11 @@
32
32
  "@aws-sdk/middleware-host-header": "3.325.0",
33
33
  "@aws-sdk/middleware-logger": "3.325.0",
34
34
  "@aws-sdk/middleware-recursion-detection": "3.325.0",
35
- "@aws-sdk/middleware-retry": "3.325.0",
35
+ "@aws-sdk/middleware-retry": "3.327.0",
36
36
  "@aws-sdk/middleware-serde": "3.325.0",
37
37
  "@aws-sdk/middleware-signing": "3.325.0",
38
38
  "@aws-sdk/middleware-stack": "3.325.0",
39
- "@aws-sdk/middleware-user-agent": "3.325.0",
39
+ "@aws-sdk/middleware-user-agent": "3.327.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.321.1",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
@@ -48,8 +48,8 @@
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
49
  "@aws-sdk/util-defaults-mode-browser": "3.325.0",
50
50
  "@aws-sdk/util-defaults-mode-node": "3.325.0",
51
- "@aws-sdk/util-endpoints": "3.319.0",
52
- "@aws-sdk/util-retry": "3.310.0",
51
+ "@aws-sdk/util-endpoints": "3.327.0",
52
+ "@aws-sdk/util-retry": "3.327.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",
54
54
  "@aws-sdk/util-user-agent-node": "3.310.0",
55
55
  "@aws-sdk/util-utf8": "3.310.0",