@aws-sdk/client-backup 3.325.0 → 3.326.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 +3 -3
@@ -34,6 +34,8 @@ export interface CancelLegalHoldCommandOutput extends CancelLegalHoldOutput, __M
34
34
  * };
35
35
  * const command = new CancelLegalHoldCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param CancelLegalHoldCommandInput - {@link CancelLegalHoldCommandInput}
@@ -59,6 +61,8 @@ export interface CancelLegalHoldCommandOutput extends CancelLegalHoldOutput, __M
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 CancelLegalHoldCommand extends $Command<CancelLegalHoldCommandInput, CancelLegalHoldCommandOutput, BackupClientResolvedConfig> {
@@ -75,6 +75,21 @@ export interface CreateBackupPlanCommandOutput extends CreateBackupPlanOutput, _
75
75
  * };
76
76
  * const command = new CreateBackupPlanCommand(input);
77
77
  * const response = await client.send(command);
78
+ * // { // CreateBackupPlanOutput
79
+ * // BackupPlanId: "STRING_VALUE",
80
+ * // BackupPlanArn: "STRING_VALUE",
81
+ * // CreationDate: new Date("TIMESTAMP"),
82
+ * // VersionId: "STRING_VALUE",
83
+ * // AdvancedBackupSettings: [ // AdvancedBackupSettings
84
+ * // { // AdvancedBackupSetting
85
+ * // ResourceType: "STRING_VALUE",
86
+ * // BackupOptions: { // BackupOptions
87
+ * // "<keys>": "STRING_VALUE",
88
+ * // },
89
+ * // },
90
+ * // ],
91
+ * // };
92
+ *
78
93
  * ```
79
94
  *
80
95
  * @param CreateBackupPlanCommandInput - {@link CreateBackupPlanCommandInput}
@@ -100,6 +115,8 @@ export interface CreateBackupPlanCommandOutput extends CreateBackupPlanOutput, _
100
115
  * @throws {@link ServiceUnavailableException} (server fault)
101
116
  * <p>The request failed due to a temporary failure of the server.</p>
102
117
  *
118
+ * @throws {@link BackupServiceException}
119
+ * <p>Base exception class for all service exceptions from Backup service.</p>
103
120
  *
104
121
  */
105
122
  export declare class CreateBackupPlanCommand extends $Command<CreateBackupPlanCommandInput, CreateBackupPlanCommandOutput, BackupClientResolvedConfig> {
@@ -76,6 +76,12 @@ export interface CreateBackupSelectionCommandOutput extends CreateBackupSelectio
76
76
  * };
77
77
  * const command = new CreateBackupSelectionCommand(input);
78
78
  * const response = await client.send(command);
79
+ * // { // CreateBackupSelectionOutput
80
+ * // SelectionId: "STRING_VALUE",
81
+ * // BackupPlanId: "STRING_VALUE",
82
+ * // CreationDate: new Date("TIMESTAMP"),
83
+ * // };
84
+ *
79
85
  * ```
80
86
  *
81
87
  * @param CreateBackupSelectionCommandInput - {@link CreateBackupSelectionCommandInput}
@@ -101,6 +107,8 @@ export interface CreateBackupSelectionCommandOutput extends CreateBackupSelectio
101
107
  * @throws {@link ServiceUnavailableException} (server fault)
102
108
  * <p>The request failed due to a temporary failure of the server.</p>
103
109
  *
110
+ * @throws {@link BackupServiceException}
111
+ * <p>Base exception class for all service exceptions from Backup service.</p>
104
112
  *
105
113
  */
106
114
  export declare class CreateBackupSelectionCommand extends $Command<CreateBackupSelectionCommandInput, CreateBackupSelectionCommandOutput, BackupClientResolvedConfig> {
@@ -42,6 +42,12 @@ export interface CreateBackupVaultCommandOutput extends CreateBackupVaultOutput,
42
42
  * };
43
43
  * const command = new CreateBackupVaultCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // CreateBackupVaultOutput
46
+ * // BackupVaultName: "STRING_VALUE",
47
+ * // BackupVaultArn: "STRING_VALUE",
48
+ * // CreationDate: new Date("TIMESTAMP"),
49
+ * // };
50
+ *
45
51
  * ```
46
52
  *
47
53
  * @param CreateBackupVaultCommandInput - {@link CreateBackupVaultCommandInput}
@@ -67,6 +73,8 @@ export interface CreateBackupVaultCommandOutput extends CreateBackupVaultOutput,
67
73
  * @throws {@link ServiceUnavailableException} (server fault)
68
74
  * <p>The request failed due to a temporary failure of the server.</p>
69
75
  *
76
+ * @throws {@link BackupServiceException}
77
+ * <p>Base exception class for all service exceptions from Backup service.</p>
70
78
  *
71
79
  */
72
80
  export declare class CreateBackupVaultCommand extends $Command<CreateBackupVaultCommandInput, CreateBackupVaultCommandOutput, BackupClientResolvedConfig> {
@@ -61,6 +61,11 @@ export interface CreateFrameworkCommandOutput extends CreateFrameworkOutput, __M
61
61
  * };
62
62
  * const command = new CreateFrameworkCommand(input);
63
63
  * const response = await client.send(command);
64
+ * // { // CreateFrameworkOutput
65
+ * // FrameworkName: "STRING_VALUE",
66
+ * // FrameworkArn: "STRING_VALUE",
67
+ * // };
68
+ *
64
69
  * ```
65
70
  *
66
71
  * @param CreateFrameworkCommandInput - {@link CreateFrameworkCommandInput}
@@ -86,6 +91,8 @@ export interface CreateFrameworkCommandOutput extends CreateFrameworkOutput, __M
86
91
  * @throws {@link ServiceUnavailableException} (server fault)
87
92
  * <p>The request failed due to a temporary failure of the server.</p>
88
93
  *
94
+ * @throws {@link BackupServiceException}
95
+ * <p>Base exception class for all service exceptions from Backup service.</p>
89
96
  *
90
97
  */
91
98
  export declare class CreateFrameworkCommand extends $Command<CreateFrameworkCommandInput, CreateFrameworkCommandOutput, BackupClientResolvedConfig> {
@@ -51,6 +51,27 @@ export interface CreateLegalHoldCommandOutput extends CreateLegalHoldOutput, __M
51
51
  * };
52
52
  * const command = new CreateLegalHoldCommand(input);
53
53
  * const response = await client.send(command);
54
+ * // { // CreateLegalHoldOutput
55
+ * // Title: "STRING_VALUE",
56
+ * // Status: "CREATING" || "ACTIVE" || "CANCELING" || "CANCELED",
57
+ * // Description: "STRING_VALUE",
58
+ * // LegalHoldId: "STRING_VALUE",
59
+ * // LegalHoldArn: "STRING_VALUE",
60
+ * // CreationDate: new Date("TIMESTAMP"),
61
+ * // RecoveryPointSelection: { // RecoveryPointSelection
62
+ * // VaultNames: [ // VaultNames
63
+ * // "STRING_VALUE",
64
+ * // ],
65
+ * // ResourceIdentifiers: [ // ResourceIdentifiers
66
+ * // "STRING_VALUE",
67
+ * // ],
68
+ * // DateRange: { // DateRange
69
+ * // FromDate: new Date("TIMESTAMP"), // required
70
+ * // ToDate: new Date("TIMESTAMP"), // required
71
+ * // },
72
+ * // },
73
+ * // };
74
+ *
54
75
  * ```
55
76
  *
56
77
  * @param CreateLegalHoldCommandInput - {@link CreateLegalHoldCommandInput}
@@ -73,6 +94,8 @@ export interface CreateLegalHoldCommandOutput extends CreateLegalHoldOutput, __M
73
94
  * @throws {@link ServiceUnavailableException} (server fault)
74
95
  * <p>The request failed due to a temporary failure of the server.</p>
75
96
  *
97
+ * @throws {@link BackupServiceException}
98
+ * <p>Base exception class for all service exceptions from Backup service.</p>
76
99
  *
77
100
  */
78
101
  export declare class CreateLegalHoldCommand extends $Command<CreateLegalHoldCommandInput, CreateLegalHoldCommandOutput, BackupClientResolvedConfig> {
@@ -62,6 +62,12 @@ export interface CreateReportPlanCommandOutput extends CreateReportPlanOutput, _
62
62
  * };
63
63
  * const command = new CreateReportPlanCommand(input);
64
64
  * const response = await client.send(command);
65
+ * // { // CreateReportPlanOutput
66
+ * // ReportPlanName: "STRING_VALUE",
67
+ * // ReportPlanArn: "STRING_VALUE",
68
+ * // CreationTime: new Date("TIMESTAMP"),
69
+ * // };
70
+ *
65
71
  * ```
66
72
  *
67
73
  * @param CreateReportPlanCommandInput - {@link CreateReportPlanCommandInput}
@@ -87,6 +93,8 @@ export interface CreateReportPlanCommandOutput extends CreateReportPlanOutput, _
87
93
  * @throws {@link ServiceUnavailableException} (server fault)
88
94
  * <p>The request failed due to a temporary failure of the server.</p>
89
95
  *
96
+ * @throws {@link BackupServiceException}
97
+ * <p>Base exception class for all service exceptions from Backup service.</p>
90
98
  *
91
99
  */
92
100
  export declare class CreateReportPlanCommand extends $Command<CreateReportPlanCommandInput, CreateReportPlanCommandOutput, BackupClientResolvedConfig> {
@@ -33,6 +33,13 @@ export interface DeleteBackupPlanCommandOutput extends DeleteBackupPlanOutput, _
33
33
  * };
34
34
  * const command = new DeleteBackupPlanCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DeleteBackupPlanOutput
37
+ * // BackupPlanId: "STRING_VALUE",
38
+ * // BackupPlanArn: "STRING_VALUE",
39
+ * // DeletionDate: new Date("TIMESTAMP"),
40
+ * // VersionId: "STRING_VALUE",
41
+ * // };
42
+ *
36
43
  * ```
37
44
  *
38
45
  * @param DeleteBackupPlanCommandInput - {@link DeleteBackupPlanCommandInput}
@@ -58,6 +65,8 @@ export interface DeleteBackupPlanCommandOutput extends DeleteBackupPlanOutput, _
58
65
  * @throws {@link ServiceUnavailableException} (server fault)
59
66
  * <p>The request failed due to a temporary failure of the server.</p>
60
67
  *
68
+ * @throws {@link BackupServiceException}
69
+ * <p>Base exception class for all service exceptions from Backup service.</p>
61
70
  *
62
71
  */
63
72
  export declare class DeleteBackupPlanCommand extends $Command<DeleteBackupPlanCommandInput, DeleteBackupPlanCommandOutput, BackupClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeleteBackupSelectionCommandOutput extends __MetadataBearer {
33
33
  * };
34
34
  * const command = new DeleteBackupSelectionCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteBackupSelectionCommandInput - {@link DeleteBackupSelectionCommandInput}
@@ -54,6 +56,8 @@ export interface DeleteBackupSelectionCommandOutput extends __MetadataBearer {
54
56
  * @throws {@link ServiceUnavailableException} (server fault)
55
57
  * <p>The request failed due to a temporary failure of the server.</p>
56
58
  *
59
+ * @throws {@link BackupServiceException}
60
+ * <p>Base exception class for all service exceptions from Backup service.</p>
57
61
  *
58
62
  */
59
63
  export declare class DeleteBackupSelectionCommand extends $Command<DeleteBackupSelectionCommandInput, DeleteBackupSelectionCommandOutput, BackupClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteBackupVaultAccessPolicyCommandOutput extends __MetadataBe
31
31
  * };
32
32
  * const command = new DeleteBackupVaultAccessPolicyCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteBackupVaultAccessPolicyCommandInput - {@link DeleteBackupVaultAccessPolicyCommandInput}
@@ -52,6 +54,8 @@ export interface DeleteBackupVaultAccessPolicyCommandOutput extends __MetadataBe
52
54
  * @throws {@link ServiceUnavailableException} (server fault)
53
55
  * <p>The request failed due to a temporary failure of the server.</p>
54
56
  *
57
+ * @throws {@link BackupServiceException}
58
+ * <p>Base exception class for all service exceptions from Backup service.</p>
55
59
  *
56
60
  */
57
61
  export declare class DeleteBackupVaultAccessPolicyCommand extends $Command<DeleteBackupVaultAccessPolicyCommandInput, DeleteBackupVaultAccessPolicyCommandOutput, BackupClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteBackupVaultCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteBackupVaultCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteBackupVaultCommandInput - {@link DeleteBackupVaultCommandInput}
@@ -57,6 +59,8 @@ export interface DeleteBackupVaultCommandOutput 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 DeleteBackupVaultCommand extends $Command<DeleteBackupVaultCommandInput, DeleteBackupVaultCommandOutput, BackupClientResolvedConfig> {
@@ -36,6 +36,8 @@ export interface DeleteBackupVaultLockConfigurationCommandOutput extends __Metad
36
36
  * };
37
37
  * const command = new DeleteBackupVaultLockConfigurationCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // {};
40
+ *
39
41
  * ```
40
42
  *
41
43
  * @param DeleteBackupVaultLockConfigurationCommandInput - {@link DeleteBackupVaultLockConfigurationCommandInput}
@@ -61,6 +63,8 @@ export interface DeleteBackupVaultLockConfigurationCommandOutput extends __Metad
61
63
  * @throws {@link ServiceUnavailableException} (server fault)
62
64
  * <p>The request failed due to a temporary failure of the server.</p>
63
65
  *
66
+ * @throws {@link BackupServiceException}
67
+ * <p>Base exception class for all service exceptions from Backup service.</p>
64
68
  *
65
69
  */
66
70
  export declare class DeleteBackupVaultLockConfigurationCommand extends $Command<DeleteBackupVaultLockConfigurationCommandInput, DeleteBackupVaultLockConfigurationCommandOutput, BackupClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteBackupVaultNotificationsCommandOutput extends __MetadataB
31
31
  * };
32
32
  * const command = new DeleteBackupVaultNotificationsCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteBackupVaultNotificationsCommandInput - {@link DeleteBackupVaultNotificationsCommandInput}
@@ -52,6 +54,8 @@ export interface DeleteBackupVaultNotificationsCommandOutput extends __MetadataB
52
54
  * @throws {@link ServiceUnavailableException} (server fault)
53
55
  * <p>The request failed due to a temporary failure of the server.</p>
54
56
  *
57
+ * @throws {@link BackupServiceException}
58
+ * <p>Base exception class for all service exceptions from Backup service.</p>
55
59
  *
56
60
  */
57
61
  export declare class DeleteBackupVaultNotificationsCommand extends $Command<DeleteBackupVaultNotificationsCommandInput, DeleteBackupVaultNotificationsCommandOutput, BackupClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteFrameworkCommandOutput extends __MetadataBearer {
31
31
  * };
32
32
  * const command = new DeleteFrameworkCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteFrameworkCommandInput - {@link DeleteFrameworkCommandInput}
@@ -56,6 +58,8 @@ export interface DeleteFrameworkCommandOutput 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 DeleteFrameworkCommand extends $Command<DeleteFrameworkCommandInput, DeleteFrameworkCommandOutput, BackupClientResolvedConfig> {
@@ -44,6 +44,8 @@ export interface DeleteRecoveryPointCommandOutput extends __MetadataBearer {
44
44
  * };
45
45
  * const command = new DeleteRecoveryPointCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // {};
48
+ *
47
49
  * ```
48
50
  *
49
51
  * @param DeleteRecoveryPointCommandInput - {@link DeleteRecoveryPointCommandInput}
@@ -73,6 +75,8 @@ export interface DeleteRecoveryPointCommandOutput extends __MetadataBearer {
73
75
  * @throws {@link ServiceUnavailableException} (server fault)
74
76
  * <p>The request failed due to a temporary failure of the server.</p>
75
77
  *
78
+ * @throws {@link BackupServiceException}
79
+ * <p>Base exception class for all service exceptions from Backup service.</p>
76
80
  *
77
81
  */
78
82
  export declare class DeleteRecoveryPointCommand extends $Command<DeleteRecoveryPointCommandInput, DeleteRecoveryPointCommandOutput, BackupClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteReportPlanCommandOutput extends __MetadataBearer {
31
31
  * };
32
32
  * const command = new DeleteReportPlanCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteReportPlanCommandInput - {@link DeleteReportPlanCommandInput}
@@ -56,6 +58,8 @@ export interface DeleteReportPlanCommandOutput 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 DeleteReportPlanCommand extends $Command<DeleteReportPlanCommandInput, DeleteReportPlanCommandOutput, BackupClientResolvedConfig> {
@@ -31,6 +31,43 @@ export interface DescribeBackupJobCommandOutput extends DescribeBackupJobOutput,
31
31
  * };
32
32
  * const command = new DescribeBackupJobCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeBackupJobOutput
35
+ * // AccountId: "STRING_VALUE",
36
+ * // BackupJobId: "STRING_VALUE",
37
+ * // BackupVaultName: "STRING_VALUE",
38
+ * // BackupVaultArn: "STRING_VALUE",
39
+ * // RecoveryPointArn: "STRING_VALUE",
40
+ * // ResourceArn: "STRING_VALUE",
41
+ * // CreationDate: new Date("TIMESTAMP"),
42
+ * // CompletionDate: new Date("TIMESTAMP"),
43
+ * // State: "CREATED" || "PENDING" || "RUNNING" || "ABORTING" || "ABORTED" || "COMPLETED" || "FAILED" || "EXPIRED" || "PARTIAL",
44
+ * // StatusMessage: "STRING_VALUE",
45
+ * // PercentDone: "STRING_VALUE",
46
+ * // BackupSizeInBytes: Number("long"),
47
+ * // IamRoleArn: "STRING_VALUE",
48
+ * // CreatedBy: { // RecoveryPointCreator
49
+ * // BackupPlanId: "STRING_VALUE",
50
+ * // BackupPlanArn: "STRING_VALUE",
51
+ * // BackupPlanVersion: "STRING_VALUE",
52
+ * // BackupRuleId: "STRING_VALUE",
53
+ * // },
54
+ * // ResourceType: "STRING_VALUE",
55
+ * // BytesTransferred: Number("long"),
56
+ * // ExpectedCompletionDate: new Date("TIMESTAMP"),
57
+ * // StartBy: new Date("TIMESTAMP"),
58
+ * // BackupOptions: { // BackupOptions
59
+ * // "<keys>": "STRING_VALUE",
60
+ * // },
61
+ * // BackupType: "STRING_VALUE",
62
+ * // ParentJobId: "STRING_VALUE",
63
+ * // IsParent: true || false,
64
+ * // NumberOfChildJobs: Number("long"),
65
+ * // ChildJobsInState: { // BackupJobChildJobsInState
66
+ * // "<keys>": Number("long"),
67
+ * // },
68
+ * // ResourceName: "STRING_VALUE",
69
+ * // };
70
+ *
34
71
  * ```
35
72
  *
36
73
  * @param DescribeBackupJobCommandInput - {@link DescribeBackupJobCommandInput}
@@ -55,6 +92,8 @@ export interface DescribeBackupJobCommandOutput extends DescribeBackupJobOutput,
55
92
  * @throws {@link ServiceUnavailableException} (server fault)
56
93
  * <p>The request failed due to a temporary failure of the server.</p>
57
94
  *
95
+ * @throws {@link BackupServiceException}
96
+ * <p>Base exception class for all service exceptions from Backup service.</p>
58
97
  *
59
98
  */
60
99
  export declare class DescribeBackupJobCommand extends $Command<DescribeBackupJobCommandInput, DescribeBackupJobCommandOutput, BackupClientResolvedConfig> {
@@ -31,6 +31,19 @@ export interface DescribeBackupVaultCommandOutput extends DescribeBackupVaultOut
31
31
  * };
32
32
  * const command = new DescribeBackupVaultCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeBackupVaultOutput
35
+ * // BackupVaultName: "STRING_VALUE",
36
+ * // BackupVaultArn: "STRING_VALUE",
37
+ * // EncryptionKeyArn: "STRING_VALUE",
38
+ * // CreationDate: new Date("TIMESTAMP"),
39
+ * // CreatorRequestId: "STRING_VALUE",
40
+ * // NumberOfRecoveryPoints: Number("long"),
41
+ * // Locked: true || false,
42
+ * // MinRetentionDays: Number("long"),
43
+ * // MaxRetentionDays: Number("long"),
44
+ * // LockDate: new Date("TIMESTAMP"),
45
+ * // };
46
+ *
34
47
  * ```
35
48
  *
36
49
  * @param DescribeBackupVaultCommandInput - {@link DescribeBackupVaultCommandInput}
@@ -52,6 +65,8 @@ export interface DescribeBackupVaultCommandOutput extends DescribeBackupVaultOut
52
65
  * @throws {@link ServiceUnavailableException} (server fault)
53
66
  * <p>The request failed due to a temporary failure of the server.</p>
54
67
  *
68
+ * @throws {@link BackupServiceException}
69
+ * <p>Base exception class for all service exceptions from Backup service.</p>
55
70
  *
56
71
  */
57
72
  export declare class DescribeBackupVaultCommand extends $Command<DescribeBackupVaultCommandInput, DescribeBackupVaultCommandOutput, BackupClientResolvedConfig> {
@@ -31,6 +31,39 @@ export interface DescribeCopyJobCommandOutput extends DescribeCopyJobOutput, __M
31
31
  * };
32
32
  * const command = new DescribeCopyJobCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeCopyJobOutput
35
+ * // CopyJob: { // CopyJob
36
+ * // AccountId: "STRING_VALUE",
37
+ * // CopyJobId: "STRING_VALUE",
38
+ * // SourceBackupVaultArn: "STRING_VALUE",
39
+ * // SourceRecoveryPointArn: "STRING_VALUE",
40
+ * // DestinationBackupVaultArn: "STRING_VALUE",
41
+ * // DestinationRecoveryPointArn: "STRING_VALUE",
42
+ * // ResourceArn: "STRING_VALUE",
43
+ * // CreationDate: new Date("TIMESTAMP"),
44
+ * // CompletionDate: new Date("TIMESTAMP"),
45
+ * // State: "CREATED" || "RUNNING" || "COMPLETED" || "FAILED" || "PARTIAL",
46
+ * // StatusMessage: "STRING_VALUE",
47
+ * // BackupSizeInBytes: Number("long"),
48
+ * // IamRoleArn: "STRING_VALUE",
49
+ * // CreatedBy: { // RecoveryPointCreator
50
+ * // BackupPlanId: "STRING_VALUE",
51
+ * // BackupPlanArn: "STRING_VALUE",
52
+ * // BackupPlanVersion: "STRING_VALUE",
53
+ * // BackupRuleId: "STRING_VALUE",
54
+ * // },
55
+ * // ResourceType: "STRING_VALUE",
56
+ * // ParentJobId: "STRING_VALUE",
57
+ * // IsParent: true || false,
58
+ * // CompositeMemberIdentifier: "STRING_VALUE",
59
+ * // NumberOfChildJobs: Number("long"),
60
+ * // ChildJobsInState: { // CopyJobChildJobsInState
61
+ * // "<keys>": Number("long"),
62
+ * // },
63
+ * // ResourceName: "STRING_VALUE",
64
+ * // },
65
+ * // };
66
+ *
34
67
  * ```
35
68
  *
36
69
  * @param DescribeCopyJobCommandInput - {@link DescribeCopyJobCommandInput}
@@ -52,6 +85,8 @@ export interface DescribeCopyJobCommandOutput extends DescribeCopyJobOutput, __M
52
85
  * @throws {@link ServiceUnavailableException} (server fault)
53
86
  * <p>The request failed due to a temporary failure of the server.</p>
54
87
  *
88
+ * @throws {@link BackupServiceException}
89
+ * <p>Base exception class for all service exceptions from Backup service.</p>
55
90
  *
56
91
  */
57
92
  export declare class DescribeCopyJobCommand extends $Command<DescribeCopyJobCommandInput, DescribeCopyJobCommandOutput, BackupClientResolvedConfig> {
@@ -31,6 +31,38 @@ export interface DescribeFrameworkCommandOutput extends DescribeFrameworkOutput,
31
31
  * };
32
32
  * const command = new DescribeFrameworkCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeFrameworkOutput
35
+ * // FrameworkName: "STRING_VALUE",
36
+ * // FrameworkArn: "STRING_VALUE",
37
+ * // FrameworkDescription: "STRING_VALUE",
38
+ * // FrameworkControls: [ // FrameworkControls
39
+ * // { // FrameworkControl
40
+ * // ControlName: "STRING_VALUE", // required
41
+ * // ControlInputParameters: [ // ControlInputParameters
42
+ * // { // ControlInputParameter
43
+ * // ParameterName: "STRING_VALUE",
44
+ * // ParameterValue: "STRING_VALUE",
45
+ * // },
46
+ * // ],
47
+ * // ControlScope: { // ControlScope
48
+ * // ComplianceResourceIds: [ // ComplianceResourceIdList
49
+ * // "STRING_VALUE",
50
+ * // ],
51
+ * // ComplianceResourceTypes: [ // ResourceTypeList
52
+ * // "STRING_VALUE",
53
+ * // ],
54
+ * // Tags: { // stringMap
55
+ * // "<keys>": "STRING_VALUE",
56
+ * // },
57
+ * // },
58
+ * // },
59
+ * // ],
60
+ * // CreationTime: new Date("TIMESTAMP"),
61
+ * // DeploymentStatus: "STRING_VALUE",
62
+ * // FrameworkStatus: "STRING_VALUE",
63
+ * // IdempotencyToken: "STRING_VALUE",
64
+ * // };
65
+ *
34
66
  * ```
35
67
  *
36
68
  * @param DescribeFrameworkCommandInput - {@link DescribeFrameworkCommandInput}
@@ -52,6 +84,8 @@ export interface DescribeFrameworkCommandOutput extends DescribeFrameworkOutput,
52
84
  * @throws {@link ServiceUnavailableException} (server fault)
53
85
  * <p>The request failed due to a temporary failure of the server.</p>
54
86
  *
87
+ * @throws {@link BackupServiceException}
88
+ * <p>Base exception class for all service exceptions from Backup service.</p>
55
89
  *
56
90
  */
57
91
  export declare class DescribeFrameworkCommand extends $Command<DescribeFrameworkCommandInput, DescribeFrameworkCommandOutput, BackupClientResolvedConfig> {
@@ -32,6 +32,13 @@ export interface DescribeGlobalSettingsCommandOutput extends DescribeGlobalSetti
32
32
  * const input = {};
33
33
  * const command = new DescribeGlobalSettingsCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeGlobalSettingsOutput
36
+ * // GlobalSettings: { // GlobalSettings
37
+ * // "<keys>": "STRING_VALUE",
38
+ * // },
39
+ * // LastUpdateTime: new Date("TIMESTAMP"),
40
+ * // };
41
+ *
35
42
  * ```
36
43
  *
37
44
  * @param DescribeGlobalSettingsCommandInput - {@link DescribeGlobalSettingsCommandInput}
@@ -47,6 +54,8 @@ export interface DescribeGlobalSettingsCommandOutput extends DescribeGlobalSetti
47
54
  * @throws {@link ServiceUnavailableException} (server fault)
48
55
  * <p>The request failed due to a temporary failure of the server.</p>
49
56
  *
57
+ * @throws {@link BackupServiceException}
58
+ * <p>Base exception class for all service exceptions from Backup service.</p>
50
59
  *
51
60
  */
52
61
  export declare class DescribeGlobalSettingsCommand extends $Command<DescribeGlobalSettingsCommandInput, DescribeGlobalSettingsCommandOutput, BackupClientResolvedConfig> {
@@ -33,6 +33,13 @@ export interface DescribeProtectedResourceCommandOutput extends DescribeProtecte
33
33
  * };
34
34
  * const command = new DescribeProtectedResourceCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeProtectedResourceOutput
37
+ * // ResourceArn: "STRING_VALUE",
38
+ * // ResourceType: "STRING_VALUE",
39
+ * // LastBackupTime: new Date("TIMESTAMP"),
40
+ * // ResourceName: "STRING_VALUE",
41
+ * // };
42
+ *
36
43
  * ```
37
44
  *
38
45
  * @param DescribeProtectedResourceCommandInput - {@link DescribeProtectedResourceCommandInput}
@@ -54,6 +61,8 @@ export interface DescribeProtectedResourceCommandOutput extends DescribeProtecte
54
61
  * @throws {@link ServiceUnavailableException} (server fault)
55
62
  * <p>The request failed due to a temporary failure of the server.</p>
56
63
  *
64
+ * @throws {@link BackupServiceException}
65
+ * <p>Base exception class for all service exceptions from Backup service.</p>
57
66
  *
58
67
  */
59
68
  export declare class DescribeProtectedResourceCommand extends $Command<DescribeProtectedResourceCommandInput, DescribeProtectedResourceCommandOutput, BackupClientResolvedConfig> {
@@ -33,6 +33,43 @@ export interface DescribeRecoveryPointCommandOutput extends DescribeRecoveryPoin
33
33
  * };
34
34
  * const command = new DescribeRecoveryPointCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeRecoveryPointOutput
37
+ * // RecoveryPointArn: "STRING_VALUE",
38
+ * // BackupVaultName: "STRING_VALUE",
39
+ * // BackupVaultArn: "STRING_VALUE",
40
+ * // SourceBackupVaultArn: "STRING_VALUE",
41
+ * // ResourceArn: "STRING_VALUE",
42
+ * // ResourceType: "STRING_VALUE",
43
+ * // CreatedBy: { // RecoveryPointCreator
44
+ * // BackupPlanId: "STRING_VALUE",
45
+ * // BackupPlanArn: "STRING_VALUE",
46
+ * // BackupPlanVersion: "STRING_VALUE",
47
+ * // BackupRuleId: "STRING_VALUE",
48
+ * // },
49
+ * // IamRoleArn: "STRING_VALUE",
50
+ * // Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED",
51
+ * // StatusMessage: "STRING_VALUE",
52
+ * // CreationDate: new Date("TIMESTAMP"),
53
+ * // CompletionDate: new Date("TIMESTAMP"),
54
+ * // BackupSizeInBytes: Number("long"),
55
+ * // CalculatedLifecycle: { // CalculatedLifecycle
56
+ * // MoveToColdStorageAt: new Date("TIMESTAMP"),
57
+ * // DeleteAt: new Date("TIMESTAMP"),
58
+ * // },
59
+ * // Lifecycle: { // Lifecycle
60
+ * // MoveToColdStorageAfterDays: Number("long"),
61
+ * // DeleteAfterDays: Number("long"),
62
+ * // },
63
+ * // EncryptionKeyArn: "STRING_VALUE",
64
+ * // IsEncrypted: true || false,
65
+ * // StorageClass: "WARM" || "COLD" || "DELETED",
66
+ * // LastRestoreTime: new Date("TIMESTAMP"),
67
+ * // ParentRecoveryPointArn: "STRING_VALUE",
68
+ * // CompositeMemberIdentifier: "STRING_VALUE",
69
+ * // IsParent: true || false,
70
+ * // ResourceName: "STRING_VALUE",
71
+ * // };
72
+ *
36
73
  * ```
37
74
  *
38
75
  * @param DescribeRecoveryPointCommandInput - {@link DescribeRecoveryPointCommandInput}
@@ -54,6 +91,8 @@ export interface DescribeRecoveryPointCommandOutput extends DescribeRecoveryPoin
54
91
  * @throws {@link ServiceUnavailableException} (server fault)
55
92
  * <p>The request failed due to a temporary failure of the server.</p>
56
93
  *
94
+ * @throws {@link BackupServiceException}
95
+ * <p>Base exception class for all service exceptions from Backup service.</p>
57
96
  *
58
97
  */
59
98
  export declare class DescribeRecoveryPointCommand extends $Command<DescribeRecoveryPointCommandInput, DescribeRecoveryPointCommandOutput, BackupClientResolvedConfig> {
@@ -33,6 +33,15 @@ export interface DescribeRegionSettingsCommandOutput extends DescribeRegionSetti
33
33
  * const input = {};
34
34
  * const command = new DescribeRegionSettingsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeRegionSettingsOutput
37
+ * // ResourceTypeOptInPreference: { // ResourceTypeOptInPreference
38
+ * // "<keys>": true || false,
39
+ * // },
40
+ * // ResourceTypeManagementPreference: { // ResourceTypeManagementPreference
41
+ * // "<keys>": true || false,
42
+ * // },
43
+ * // };
44
+ *
36
45
  * ```
37
46
  *
38
47
  * @param DescribeRegionSettingsCommandInput - {@link DescribeRegionSettingsCommandInput}
@@ -44,6 +53,8 @@ export interface DescribeRegionSettingsCommandOutput extends DescribeRegionSetti
44
53
  * @throws {@link ServiceUnavailableException} (server fault)
45
54
  * <p>The request failed due to a temporary failure of the server.</p>
46
55
  *
56
+ * @throws {@link BackupServiceException}
57
+ * <p>Base exception class for all service exceptions from Backup service.</p>
47
58
  *
48
59
  */
49
60
  export declare class DescribeRegionSettingsCommand extends $Command<DescribeRegionSettingsCommandInput, DescribeRegionSettingsCommandOutput, BackupClientResolvedConfig> {