@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
@@ -32,6 +32,24 @@ export interface DescribeReportJobCommandOutput extends DescribeReportJobOutput,
32
32
  * };
33
33
  * const command = new DescribeReportJobCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeReportJobOutput
36
+ * // ReportJob: { // ReportJob
37
+ * // ReportJobId: "STRING_VALUE",
38
+ * // ReportPlanArn: "STRING_VALUE",
39
+ * // ReportTemplate: "STRING_VALUE",
40
+ * // CreationTime: new Date("TIMESTAMP"),
41
+ * // CompletionTime: new Date("TIMESTAMP"),
42
+ * // Status: "STRING_VALUE",
43
+ * // StatusMessage: "STRING_VALUE",
44
+ * // ReportDestination: { // ReportDestination
45
+ * // S3BucketName: "STRING_VALUE",
46
+ * // S3Keys: [ // stringList
47
+ * // "STRING_VALUE",
48
+ * // ],
49
+ * // },
50
+ * // },
51
+ * // };
52
+ *
35
53
  * ```
36
54
  *
37
55
  * @param DescribeReportJobCommandInput - {@link DescribeReportJobCommandInput}
@@ -49,6 +67,8 @@ export interface DescribeReportJobCommandOutput extends DescribeReportJobOutput,
49
67
  * @throws {@link ServiceUnavailableException} (server fault)
50
68
  * <p>The request failed due to a temporary failure of the server.</p>
51
69
  *
70
+ * @throws {@link BackupServiceException}
71
+ * <p>Base exception class for all service exceptions from Backup service.</p>
52
72
  *
53
73
  */
54
74
  export declare class DescribeReportJobCommand extends $Command<DescribeReportJobCommandInput, DescribeReportJobCommandOutput, BackupClientResolvedConfig> {
@@ -31,6 +31,41 @@ export interface DescribeReportPlanCommandOutput extends DescribeReportPlanOutpu
31
31
  * };
32
32
  * const command = new DescribeReportPlanCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeReportPlanOutput
35
+ * // ReportPlan: { // ReportPlan
36
+ * // ReportPlanArn: "STRING_VALUE",
37
+ * // ReportPlanName: "STRING_VALUE",
38
+ * // ReportPlanDescription: "STRING_VALUE",
39
+ * // ReportSetting: { // ReportSetting
40
+ * // ReportTemplate: "STRING_VALUE", // required
41
+ * // FrameworkArns: [ // stringList
42
+ * // "STRING_VALUE",
43
+ * // ],
44
+ * // NumberOfFrameworks: Number("int"),
45
+ * // Accounts: [
46
+ * // "STRING_VALUE",
47
+ * // ],
48
+ * // OrganizationUnits: [
49
+ * // "STRING_VALUE",
50
+ * // ],
51
+ * // Regions: [
52
+ * // "STRING_VALUE",
53
+ * // ],
54
+ * // },
55
+ * // ReportDeliveryChannel: { // ReportDeliveryChannel
56
+ * // S3BucketName: "STRING_VALUE", // required
57
+ * // S3KeyPrefix: "STRING_VALUE",
58
+ * // Formats: [ // FormatList
59
+ * // "STRING_VALUE",
60
+ * // ],
61
+ * // },
62
+ * // DeploymentStatus: "STRING_VALUE",
63
+ * // CreationTime: new Date("TIMESTAMP"),
64
+ * // LastAttemptedExecutionTime: new Date("TIMESTAMP"),
65
+ * // LastSuccessfulExecutionTime: new Date("TIMESTAMP"),
66
+ * // },
67
+ * // };
68
+ *
34
69
  * ```
35
70
  *
36
71
  * @param DescribeReportPlanCommandInput - {@link DescribeReportPlanCommandInput}
@@ -52,6 +87,8 @@ export interface DescribeReportPlanCommandOutput extends DescribeReportPlanOutpu
52
87
  * @throws {@link ServiceUnavailableException} (server fault)
53
88
  * <p>The request failed due to a temporary failure of the server.</p>
54
89
  *
90
+ * @throws {@link BackupServiceException}
91
+ * <p>Base exception class for all service exceptions from Backup service.</p>
55
92
  *
56
93
  */
57
94
  export declare class DescribeReportPlanCommand extends $Command<DescribeReportPlanCommandInput, DescribeReportPlanCommandOutput, BackupClientResolvedConfig> {
@@ -31,6 +31,22 @@ export interface DescribeRestoreJobCommandOutput extends DescribeRestoreJobOutpu
31
31
  * };
32
32
  * const command = new DescribeRestoreJobCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeRestoreJobOutput
35
+ * // AccountId: "STRING_VALUE",
36
+ * // RestoreJobId: "STRING_VALUE",
37
+ * // RecoveryPointArn: "STRING_VALUE",
38
+ * // CreationDate: new Date("TIMESTAMP"),
39
+ * // CompletionDate: new Date("TIMESTAMP"),
40
+ * // Status: "PENDING" || "RUNNING" || "COMPLETED" || "ABORTED" || "FAILED",
41
+ * // StatusMessage: "STRING_VALUE",
42
+ * // PercentDone: "STRING_VALUE",
43
+ * // BackupSizeInBytes: Number("long"),
44
+ * // IamRoleArn: "STRING_VALUE",
45
+ * // ExpectedCompletionTimeMinutes: Number("long"),
46
+ * // CreatedResourceArn: "STRING_VALUE",
47
+ * // ResourceType: "STRING_VALUE",
48
+ * // };
49
+ *
34
50
  * ```
35
51
  *
36
52
  * @param DescribeRestoreJobCommandInput - {@link DescribeRestoreJobCommandInput}
@@ -55,6 +71,8 @@ export interface DescribeRestoreJobCommandOutput extends DescribeRestoreJobOutpu
55
71
  * @throws {@link ServiceUnavailableException} (server fault)
56
72
  * <p>The request failed due to a temporary failure of the server.</p>
57
73
  *
74
+ * @throws {@link BackupServiceException}
75
+ * <p>Base exception class for all service exceptions from Backup service.</p>
58
76
  *
59
77
  */
60
78
  export declare class DescribeRestoreJobCommand extends $Command<DescribeRestoreJobCommandInput, DescribeRestoreJobCommandOutput, BackupClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface DisassociateRecoveryPointCommandOutput extends __MetadataBearer
35
35
  * };
36
36
  * const command = new DisassociateRecoveryPointCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param DisassociateRecoveryPointCommandInput - {@link DisassociateRecoveryPointCommandInput}
@@ -64,6 +66,8 @@ export interface DisassociateRecoveryPointCommandOutput extends __MetadataBearer
64
66
  * @throws {@link ServiceUnavailableException} (server fault)
65
67
  * <p>The request failed due to a temporary failure of the server.</p>
66
68
  *
69
+ * @throws {@link BackupServiceException}
70
+ * <p>Base exception class for all service exceptions from Backup service.</p>
67
71
  *
68
72
  */
69
73
  export declare class DisassociateRecoveryPointCommand extends $Command<DisassociateRecoveryPointCommandInput, DisassociateRecoveryPointCommandOutput, BackupClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DisassociateRecoveryPointFromParentCommandOutput extends __Meta
33
33
  * };
34
34
  * const command = new DisassociateRecoveryPointFromParentCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DisassociateRecoveryPointFromParentCommandInput - {@link DisassociateRecoveryPointFromParentCommandInput}
@@ -58,6 +60,8 @@ export interface DisassociateRecoveryPointFromParentCommandOutput extends __Meta
58
60
  * @throws {@link ServiceUnavailableException} (server fault)
59
61
  * <p>The request failed due to a temporary failure of the server.</p>
60
62
  *
63
+ * @throws {@link BackupServiceException}
64
+ * <p>Base exception class for all service exceptions from Backup service.</p>
61
65
  *
62
66
  */
63
67
  export declare class DisassociateRecoveryPointFromParentCommand extends $Command<DisassociateRecoveryPointFromParentCommandInput, DisassociateRecoveryPointFromParentCommandOutput, BackupClientResolvedConfig> {
@@ -31,6 +31,10 @@ export interface ExportBackupPlanTemplateCommandOutput extends ExportBackupPlanT
31
31
  * };
32
32
  * const command = new ExportBackupPlanTemplateCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ExportBackupPlanTemplateOutput
35
+ * // BackupPlanTemplateJson: "STRING_VALUE",
36
+ * // };
37
+ *
34
38
  * ```
35
39
  *
36
40
  * @param ExportBackupPlanTemplateCommandInput - {@link ExportBackupPlanTemplateCommandInput}
@@ -52,6 +56,8 @@ export interface ExportBackupPlanTemplateCommandOutput extends ExportBackupPlanT
52
56
  * @throws {@link ServiceUnavailableException} (server fault)
53
57
  * <p>The request failed due to a temporary failure of the server.</p>
54
58
  *
59
+ * @throws {@link BackupServiceException}
60
+ * <p>Base exception class for all service exceptions from Backup service.</p>
55
61
  *
56
62
  */
57
63
  export declare class ExportBackupPlanTemplateCommand extends $Command<ExportBackupPlanTemplateCommandInput, ExportBackupPlanTemplateCommandOutput, BackupClientResolvedConfig> {
@@ -33,6 +33,62 @@ export interface GetBackupPlanCommandOutput extends GetBackupPlanOutput, __Metad
33
33
  * };
34
34
  * const command = new GetBackupPlanCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // GetBackupPlanOutput
37
+ * // BackupPlan: { // BackupPlan
38
+ * // BackupPlanName: "STRING_VALUE", // required
39
+ * // Rules: [ // BackupRules // required
40
+ * // { // BackupRule
41
+ * // RuleName: "STRING_VALUE", // required
42
+ * // TargetBackupVaultName: "STRING_VALUE", // required
43
+ * // ScheduleExpression: "STRING_VALUE",
44
+ * // StartWindowMinutes: Number("long"),
45
+ * // CompletionWindowMinutes: Number("long"),
46
+ * // Lifecycle: { // Lifecycle
47
+ * // MoveToColdStorageAfterDays: Number("long"),
48
+ * // DeleteAfterDays: Number("long"),
49
+ * // },
50
+ * // RecoveryPointTags: { // Tags
51
+ * // "<keys>": "STRING_VALUE",
52
+ * // },
53
+ * // RuleId: "STRING_VALUE",
54
+ * // CopyActions: [ // CopyActions
55
+ * // { // CopyAction
56
+ * // Lifecycle: {
57
+ * // MoveToColdStorageAfterDays: Number("long"),
58
+ * // DeleteAfterDays: Number("long"),
59
+ * // },
60
+ * // DestinationBackupVaultArn: "STRING_VALUE", // required
61
+ * // },
62
+ * // ],
63
+ * // EnableContinuousBackup: true || false,
64
+ * // },
65
+ * // ],
66
+ * // AdvancedBackupSettings: [ // AdvancedBackupSettings
67
+ * // { // AdvancedBackupSetting
68
+ * // ResourceType: "STRING_VALUE",
69
+ * // BackupOptions: { // BackupOptions
70
+ * // "<keys>": "STRING_VALUE",
71
+ * // },
72
+ * // },
73
+ * // ],
74
+ * // },
75
+ * // BackupPlanId: "STRING_VALUE",
76
+ * // BackupPlanArn: "STRING_VALUE",
77
+ * // VersionId: "STRING_VALUE",
78
+ * // CreatorRequestId: "STRING_VALUE",
79
+ * // CreationDate: new Date("TIMESTAMP"),
80
+ * // DeletionDate: new Date("TIMESTAMP"),
81
+ * // LastExecutionDate: new Date("TIMESTAMP"),
82
+ * // AdvancedBackupSettings: [
83
+ * // {
84
+ * // ResourceType: "STRING_VALUE",
85
+ * // BackupOptions: {
86
+ * // "<keys>": "STRING_VALUE",
87
+ * // },
88
+ * // },
89
+ * // ],
90
+ * // };
91
+ *
36
92
  * ```
37
93
  *
38
94
  * @param GetBackupPlanCommandInput - {@link GetBackupPlanCommandInput}
@@ -54,6 +110,8 @@ export interface GetBackupPlanCommandOutput extends GetBackupPlanOutput, __Metad
54
110
  * @throws {@link ServiceUnavailableException} (server fault)
55
111
  * <p>The request failed due to a temporary failure of the server.</p>
56
112
  *
113
+ * @throws {@link BackupServiceException}
114
+ * <p>Base exception class for all service exceptions from Backup service.</p>
57
115
  *
58
116
  */
59
117
  export declare class GetBackupPlanCommand extends $Command<GetBackupPlanCommandInput, GetBackupPlanCommandOutput, BackupClientResolvedConfig> {
@@ -31,6 +31,47 @@ export interface GetBackupPlanFromJSONCommandOutput extends GetBackupPlanFromJSO
31
31
  * };
32
32
  * const command = new GetBackupPlanFromJSONCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetBackupPlanFromJSONOutput
35
+ * // BackupPlan: { // BackupPlan
36
+ * // BackupPlanName: "STRING_VALUE", // required
37
+ * // Rules: [ // BackupRules // required
38
+ * // { // BackupRule
39
+ * // RuleName: "STRING_VALUE", // required
40
+ * // TargetBackupVaultName: "STRING_VALUE", // required
41
+ * // ScheduleExpression: "STRING_VALUE",
42
+ * // StartWindowMinutes: Number("long"),
43
+ * // CompletionWindowMinutes: Number("long"),
44
+ * // Lifecycle: { // Lifecycle
45
+ * // MoveToColdStorageAfterDays: Number("long"),
46
+ * // DeleteAfterDays: Number("long"),
47
+ * // },
48
+ * // RecoveryPointTags: { // Tags
49
+ * // "<keys>": "STRING_VALUE",
50
+ * // },
51
+ * // RuleId: "STRING_VALUE",
52
+ * // CopyActions: [ // CopyActions
53
+ * // { // CopyAction
54
+ * // Lifecycle: {
55
+ * // MoveToColdStorageAfterDays: Number("long"),
56
+ * // DeleteAfterDays: Number("long"),
57
+ * // },
58
+ * // DestinationBackupVaultArn: "STRING_VALUE", // required
59
+ * // },
60
+ * // ],
61
+ * // EnableContinuousBackup: true || false,
62
+ * // },
63
+ * // ],
64
+ * // AdvancedBackupSettings: [ // AdvancedBackupSettings
65
+ * // { // AdvancedBackupSetting
66
+ * // ResourceType: "STRING_VALUE",
67
+ * // BackupOptions: { // BackupOptions
68
+ * // "<keys>": "STRING_VALUE",
69
+ * // },
70
+ * // },
71
+ * // ],
72
+ * // },
73
+ * // };
74
+ *
34
75
  * ```
35
76
  *
36
77
  * @param GetBackupPlanFromJSONCommandInput - {@link GetBackupPlanFromJSONCommandInput}
@@ -57,6 +98,8 @@ export interface GetBackupPlanFromJSONCommandOutput extends GetBackupPlanFromJSO
57
98
  * @throws {@link ServiceUnavailableException} (server fault)
58
99
  * <p>The request failed due to a temporary failure of the server.</p>
59
100
  *
101
+ * @throws {@link BackupServiceException}
102
+ * <p>Base exception class for all service exceptions from Backup service.</p>
60
103
  *
61
104
  */
62
105
  export declare class GetBackupPlanFromJSONCommand extends $Command<GetBackupPlanFromJSONCommandInput, GetBackupPlanFromJSONCommandOutput, BackupClientResolvedConfig> {
@@ -31,6 +31,47 @@ export interface GetBackupPlanFromTemplateCommandOutput extends GetBackupPlanFro
31
31
  * };
32
32
  * const command = new GetBackupPlanFromTemplateCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetBackupPlanFromTemplateOutput
35
+ * // BackupPlanDocument: { // BackupPlan
36
+ * // BackupPlanName: "STRING_VALUE", // required
37
+ * // Rules: [ // BackupRules // required
38
+ * // { // BackupRule
39
+ * // RuleName: "STRING_VALUE", // required
40
+ * // TargetBackupVaultName: "STRING_VALUE", // required
41
+ * // ScheduleExpression: "STRING_VALUE",
42
+ * // StartWindowMinutes: Number("long"),
43
+ * // CompletionWindowMinutes: Number("long"),
44
+ * // Lifecycle: { // Lifecycle
45
+ * // MoveToColdStorageAfterDays: Number("long"),
46
+ * // DeleteAfterDays: Number("long"),
47
+ * // },
48
+ * // RecoveryPointTags: { // Tags
49
+ * // "<keys>": "STRING_VALUE",
50
+ * // },
51
+ * // RuleId: "STRING_VALUE",
52
+ * // CopyActions: [ // CopyActions
53
+ * // { // CopyAction
54
+ * // Lifecycle: {
55
+ * // MoveToColdStorageAfterDays: Number("long"),
56
+ * // DeleteAfterDays: Number("long"),
57
+ * // },
58
+ * // DestinationBackupVaultArn: "STRING_VALUE", // required
59
+ * // },
60
+ * // ],
61
+ * // EnableContinuousBackup: true || false,
62
+ * // },
63
+ * // ],
64
+ * // AdvancedBackupSettings: [ // AdvancedBackupSettings
65
+ * // { // AdvancedBackupSetting
66
+ * // ResourceType: "STRING_VALUE",
67
+ * // BackupOptions: { // BackupOptions
68
+ * // "<keys>": "STRING_VALUE",
69
+ * // },
70
+ * // },
71
+ * // ],
72
+ * // },
73
+ * // };
74
+ *
34
75
  * ```
35
76
  *
36
77
  * @param GetBackupPlanFromTemplateCommandInput - {@link GetBackupPlanFromTemplateCommandInput}
@@ -52,6 +93,8 @@ export interface GetBackupPlanFromTemplateCommandOutput extends GetBackupPlanFro
52
93
  * @throws {@link ServiceUnavailableException} (server fault)
53
94
  * <p>The request failed due to a temporary failure of the server.</p>
54
95
  *
96
+ * @throws {@link BackupServiceException}
97
+ * <p>Base exception class for all service exceptions from Backup service.</p>
55
98
  *
56
99
  */
57
100
  export declare class GetBackupPlanFromTemplateCommand extends $Command<GetBackupPlanFromTemplateCommandInput, GetBackupPlanFromTemplateCommandOutput, BackupClientResolvedConfig> {
@@ -33,6 +33,56 @@ export interface GetBackupSelectionCommandOutput extends GetBackupSelectionOutpu
33
33
  * };
34
34
  * const command = new GetBackupSelectionCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // GetBackupSelectionOutput
37
+ * // BackupSelection: { // BackupSelection
38
+ * // SelectionName: "STRING_VALUE", // required
39
+ * // IamRoleArn: "STRING_VALUE", // required
40
+ * // Resources: [ // ResourceArns
41
+ * // "STRING_VALUE",
42
+ * // ],
43
+ * // ListOfTags: [ // ListOfTags
44
+ * // { // Condition
45
+ * // ConditionType: "STRINGEQUALS", // required
46
+ * // ConditionKey: "STRING_VALUE", // required
47
+ * // ConditionValue: "STRING_VALUE", // required
48
+ * // },
49
+ * // ],
50
+ * // NotResources: [
51
+ * // "STRING_VALUE",
52
+ * // ],
53
+ * // Conditions: { // Conditions
54
+ * // StringEquals: [ // ConditionParameters
55
+ * // { // ConditionParameter
56
+ * // ConditionKey: "STRING_VALUE",
57
+ * // ConditionValue: "STRING_VALUE",
58
+ * // },
59
+ * // ],
60
+ * // StringNotEquals: [
61
+ * // {
62
+ * // ConditionKey: "STRING_VALUE",
63
+ * // ConditionValue: "STRING_VALUE",
64
+ * // },
65
+ * // ],
66
+ * // StringLike: [
67
+ * // {
68
+ * // ConditionKey: "STRING_VALUE",
69
+ * // ConditionValue: "STRING_VALUE",
70
+ * // },
71
+ * // ],
72
+ * // StringNotLike: [
73
+ * // {
74
+ * // ConditionKey: "STRING_VALUE",
75
+ * // ConditionValue: "STRING_VALUE",
76
+ * // },
77
+ * // ],
78
+ * // },
79
+ * // },
80
+ * // SelectionId: "STRING_VALUE",
81
+ * // BackupPlanId: "STRING_VALUE",
82
+ * // CreationDate: new Date("TIMESTAMP"),
83
+ * // CreatorRequestId: "STRING_VALUE",
84
+ * // };
85
+ *
36
86
  * ```
37
87
  *
38
88
  * @param GetBackupSelectionCommandInput - {@link GetBackupSelectionCommandInput}
@@ -54,6 +104,8 @@ export interface GetBackupSelectionCommandOutput extends GetBackupSelectionOutpu
54
104
  * @throws {@link ServiceUnavailableException} (server fault)
55
105
  * <p>The request failed due to a temporary failure of the server.</p>
56
106
  *
107
+ * @throws {@link BackupServiceException}
108
+ * <p>Base exception class for all service exceptions from Backup service.</p>
57
109
  *
58
110
  */
59
111
  export declare class GetBackupSelectionCommand extends $Command<GetBackupSelectionCommandInput, GetBackupSelectionCommandOutput, BackupClientResolvedConfig> {
@@ -32,6 +32,12 @@ export interface GetBackupVaultAccessPolicyCommandOutput extends GetBackupVaultA
32
32
  * };
33
33
  * const command = new GetBackupVaultAccessPolicyCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetBackupVaultAccessPolicyOutput
36
+ * // BackupVaultName: "STRING_VALUE",
37
+ * // BackupVaultArn: "STRING_VALUE",
38
+ * // Policy: "STRING_VALUE",
39
+ * // };
40
+ *
35
41
  * ```
36
42
  *
37
43
  * @param GetBackupVaultAccessPolicyCommandInput - {@link GetBackupVaultAccessPolicyCommandInput}
@@ -53,6 +59,8 @@ export interface GetBackupVaultAccessPolicyCommandOutput extends GetBackupVaultA
53
59
  * @throws {@link ServiceUnavailableException} (server fault)
54
60
  * <p>The request failed due to a temporary failure of the server.</p>
55
61
  *
62
+ * @throws {@link BackupServiceException}
63
+ * <p>Base exception class for all service exceptions from Backup service.</p>
56
64
  *
57
65
  */
58
66
  export declare class GetBackupVaultAccessPolicyCommand extends $Command<GetBackupVaultAccessPolicyCommandInput, GetBackupVaultAccessPolicyCommandOutput, BackupClientResolvedConfig> {
@@ -31,6 +31,15 @@ export interface GetBackupVaultNotificationsCommandOutput extends GetBackupVault
31
31
  * };
32
32
  * const command = new GetBackupVaultNotificationsCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetBackupVaultNotificationsOutput
35
+ * // BackupVaultName: "STRING_VALUE",
36
+ * // BackupVaultArn: "STRING_VALUE",
37
+ * // SNSTopicArn: "STRING_VALUE",
38
+ * // BackupVaultEvents: [ // BackupVaultEvents
39
+ * // "BACKUP_JOB_STARTED" || "BACKUP_JOB_COMPLETED" || "BACKUP_JOB_SUCCESSFUL" || "BACKUP_JOB_FAILED" || "BACKUP_JOB_EXPIRED" || "RESTORE_JOB_STARTED" || "RESTORE_JOB_COMPLETED" || "RESTORE_JOB_SUCCESSFUL" || "RESTORE_JOB_FAILED" || "COPY_JOB_STARTED" || "COPY_JOB_SUCCESSFUL" || "COPY_JOB_FAILED" || "RECOVERY_POINT_MODIFIED" || "BACKUP_PLAN_CREATED" || "BACKUP_PLAN_MODIFIED" || "S3_BACKUP_OBJECT_FAILED" || "S3_RESTORE_OBJECT_FAILED",
40
+ * // ],
41
+ * // };
42
+ *
34
43
  * ```
35
44
  *
36
45
  * @param GetBackupVaultNotificationsCommandInput - {@link GetBackupVaultNotificationsCommandInput}
@@ -52,6 +61,8 @@ export interface GetBackupVaultNotificationsCommandOutput extends GetBackupVault
52
61
  * @throws {@link ServiceUnavailableException} (server fault)
53
62
  * <p>The request failed due to a temporary failure of the server.</p>
54
63
  *
64
+ * @throws {@link BackupServiceException}
65
+ * <p>Base exception class for all service exceptions from Backup service.</p>
55
66
  *
56
67
  */
57
68
  export declare class GetBackupVaultNotificationsCommand extends $Command<GetBackupVaultNotificationsCommandInput, GetBackupVaultNotificationsCommandOutput, BackupClientResolvedConfig> {
@@ -32,6 +32,30 @@ export interface GetLegalHoldCommandOutput extends GetLegalHoldOutput, __Metadat
32
32
  * };
33
33
  * const command = new GetLegalHoldCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetLegalHoldOutput
36
+ * // Title: "STRING_VALUE",
37
+ * // Status: "CREATING" || "ACTIVE" || "CANCELING" || "CANCELED",
38
+ * // Description: "STRING_VALUE",
39
+ * // CancelDescription: "STRING_VALUE",
40
+ * // LegalHoldId: "STRING_VALUE",
41
+ * // LegalHoldArn: "STRING_VALUE",
42
+ * // CreationDate: new Date("TIMESTAMP"),
43
+ * // CancellationDate: new Date("TIMESTAMP"),
44
+ * // RetainRecordUntil: new Date("TIMESTAMP"),
45
+ * // RecoveryPointSelection: { // RecoveryPointSelection
46
+ * // VaultNames: [ // VaultNames
47
+ * // "STRING_VALUE",
48
+ * // ],
49
+ * // ResourceIdentifiers: [ // ResourceIdentifiers
50
+ * // "STRING_VALUE",
51
+ * // ],
52
+ * // DateRange: { // DateRange
53
+ * // FromDate: new Date("TIMESTAMP"), // required
54
+ * // ToDate: new Date("TIMESTAMP"), // required
55
+ * // },
56
+ * // },
57
+ * // };
58
+ *
35
59
  * ```
36
60
  *
37
61
  * @param GetLegalHoldCommandInput - {@link GetLegalHoldCommandInput}
@@ -53,6 +77,8 @@ export interface GetLegalHoldCommandOutput extends GetLegalHoldOutput, __Metadat
53
77
  * @throws {@link ServiceUnavailableException} (server fault)
54
78
  * <p>The request failed due to a temporary failure of the server.</p>
55
79
  *
80
+ * @throws {@link BackupServiceException}
81
+ * <p>Base exception class for all service exceptions from Backup service.</p>
56
82
  *
57
83
  */
58
84
  export declare class GetLegalHoldCommand extends $Command<GetLegalHoldCommandInput, GetLegalHoldCommandOutput, BackupClientResolvedConfig> {
@@ -32,6 +32,14 @@ export interface GetRecoveryPointRestoreMetadataCommandOutput extends GetRecover
32
32
  * };
33
33
  * const command = new GetRecoveryPointRestoreMetadataCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetRecoveryPointRestoreMetadataOutput
36
+ * // BackupVaultArn: "STRING_VALUE",
37
+ * // RecoveryPointArn: "STRING_VALUE",
38
+ * // RestoreMetadata: { // Metadata
39
+ * // "<keys>": "STRING_VALUE",
40
+ * // },
41
+ * // };
42
+ *
35
43
  * ```
36
44
  *
37
45
  * @param GetRecoveryPointRestoreMetadataCommandInput - {@link GetRecoveryPointRestoreMetadataCommandInput}
@@ -53,6 +61,8 @@ export interface GetRecoveryPointRestoreMetadataCommandOutput extends GetRecover
53
61
  * @throws {@link ServiceUnavailableException} (server fault)
54
62
  * <p>The request failed due to a temporary failure of the server.</p>
55
63
  *
64
+ * @throws {@link BackupServiceException}
65
+ * <p>Base exception class for all service exceptions from Backup service.</p>
56
66
  *
57
67
  */
58
68
  export declare class GetRecoveryPointRestoreMetadataCommand extends $Command<GetRecoveryPointRestoreMetadataCommandInput, GetRecoveryPointRestoreMetadataCommandOutput, BackupClientResolvedConfig> {
@@ -29,6 +29,12 @@ export interface GetSupportedResourceTypesCommandOutput extends GetSupportedReso
29
29
  * const input = {};
30
30
  * const command = new GetSupportedResourceTypesCommand(input);
31
31
  * const response = await client.send(command);
32
+ * // { // GetSupportedResourceTypesOutput
33
+ * // ResourceTypes: [ // ResourceTypes
34
+ * // "STRING_VALUE",
35
+ * // ],
36
+ * // };
37
+ *
32
38
  * ```
33
39
  *
34
40
  * @param GetSupportedResourceTypesCommandInput - {@link GetSupportedResourceTypesCommandInput}
@@ -40,6 +46,8 @@ export interface GetSupportedResourceTypesCommandOutput extends GetSupportedReso
40
46
  * @throws {@link ServiceUnavailableException} (server fault)
41
47
  * <p>The request failed due to a temporary failure of the server.</p>
42
48
  *
49
+ * @throws {@link BackupServiceException}
50
+ * <p>Base exception class for all service exceptions from Backup service.</p>
43
51
  *
44
52
  */
45
53
  export declare class GetSupportedResourceTypesCommand extends $Command<GetSupportedResourceTypesCommandInput, GetSupportedResourceTypesCommandOutput, BackupClientResolvedConfig> {
@@ -43,6 +43,44 @@ export interface ListBackupJobsCommandOutput extends ListBackupJobsOutput, __Met
43
43
  * };
44
44
  * const command = new ListBackupJobsCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // ListBackupJobsOutput
47
+ * // BackupJobs: [ // BackupJobsList
48
+ * // { // BackupJob
49
+ * // AccountId: "STRING_VALUE",
50
+ * // BackupJobId: "STRING_VALUE",
51
+ * // BackupVaultName: "STRING_VALUE",
52
+ * // BackupVaultArn: "STRING_VALUE",
53
+ * // RecoveryPointArn: "STRING_VALUE",
54
+ * // ResourceArn: "STRING_VALUE",
55
+ * // CreationDate: new Date("TIMESTAMP"),
56
+ * // CompletionDate: new Date("TIMESTAMP"),
57
+ * // State: "CREATED" || "PENDING" || "RUNNING" || "ABORTING" || "ABORTED" || "COMPLETED" || "FAILED" || "EXPIRED" || "PARTIAL",
58
+ * // StatusMessage: "STRING_VALUE",
59
+ * // PercentDone: "STRING_VALUE",
60
+ * // BackupSizeInBytes: Number("long"),
61
+ * // IamRoleArn: "STRING_VALUE",
62
+ * // CreatedBy: { // RecoveryPointCreator
63
+ * // BackupPlanId: "STRING_VALUE",
64
+ * // BackupPlanArn: "STRING_VALUE",
65
+ * // BackupPlanVersion: "STRING_VALUE",
66
+ * // BackupRuleId: "STRING_VALUE",
67
+ * // },
68
+ * // ExpectedCompletionDate: new Date("TIMESTAMP"),
69
+ * // StartBy: new Date("TIMESTAMP"),
70
+ * // ResourceType: "STRING_VALUE",
71
+ * // BytesTransferred: Number("long"),
72
+ * // BackupOptions: { // BackupOptions
73
+ * // "<keys>": "STRING_VALUE",
74
+ * // },
75
+ * // BackupType: "STRING_VALUE",
76
+ * // ParentJobId: "STRING_VALUE",
77
+ * // IsParent: true || false,
78
+ * // ResourceName: "STRING_VALUE",
79
+ * // },
80
+ * // ],
81
+ * // NextToken: "STRING_VALUE",
82
+ * // };
83
+ *
46
84
  * ```
47
85
  *
48
86
  * @param ListBackupJobsCommandInput - {@link ListBackupJobsCommandInput}
@@ -58,6 +96,8 @@ export interface ListBackupJobsCommandOutput extends ListBackupJobsOutput, __Met
58
96
  * @throws {@link ServiceUnavailableException} (server fault)
59
97
  * <p>The request failed due to a temporary failure of the server.</p>
60
98
  *
99
+ * @throws {@link BackupServiceException}
100
+ * <p>Base exception class for all service exceptions from Backup service.</p>
61
101
  *
62
102
  */
63
103
  export declare class ListBackupJobsCommand extends $Command<ListBackupJobsCommandInput, ListBackupJobsCommandOutput, BackupClientResolvedConfig> {
@@ -33,6 +33,16 @@ export interface ListBackupPlanTemplatesCommandOutput extends ListBackupPlanTemp
33
33
  * };
34
34
  * const command = new ListBackupPlanTemplatesCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListBackupPlanTemplatesOutput
37
+ * // NextToken: "STRING_VALUE",
38
+ * // BackupPlanTemplatesList: [ // BackupPlanTemplatesList
39
+ * // { // BackupPlanTemplatesListMember
40
+ * // BackupPlanTemplateId: "STRING_VALUE",
41
+ * // BackupPlanTemplateName: "STRING_VALUE",
42
+ * // },
43
+ * // ],
44
+ * // };
45
+ *
36
46
  * ```
37
47
  *
38
48
  * @param ListBackupPlanTemplatesCommandInput - {@link ListBackupPlanTemplatesCommandInput}
@@ -54,6 +64,8 @@ export interface ListBackupPlanTemplatesCommandOutput extends ListBackupPlanTemp
54
64
  * @throws {@link ServiceUnavailableException} (server fault)
55
65
  * <p>The request failed due to a temporary failure of the server.</p>
56
66
  *
67
+ * @throws {@link BackupServiceException}
68
+ * <p>Base exception class for all service exceptions from Backup service.</p>
57
69
  *
58
70
  */
59
71
  export declare class ListBackupPlanTemplatesCommand extends $Command<ListBackupPlanTemplatesCommandInput, ListBackupPlanTemplatesCommandOutput, BackupClientResolvedConfig> {