@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,30 @@ export interface ListBackupPlanVersionsCommandOutput extends ListBackupPlanVersi
34
34
  * };
35
35
  * const command = new ListBackupPlanVersionsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListBackupPlanVersionsOutput
38
+ * // NextToken: "STRING_VALUE",
39
+ * // BackupPlanVersionsList: [ // BackupPlanVersionsList
40
+ * // { // BackupPlansListMember
41
+ * // BackupPlanArn: "STRING_VALUE",
42
+ * // BackupPlanId: "STRING_VALUE",
43
+ * // CreationDate: new Date("TIMESTAMP"),
44
+ * // DeletionDate: new Date("TIMESTAMP"),
45
+ * // VersionId: "STRING_VALUE",
46
+ * // BackupPlanName: "STRING_VALUE",
47
+ * // CreatorRequestId: "STRING_VALUE",
48
+ * // LastExecutionDate: new Date("TIMESTAMP"),
49
+ * // AdvancedBackupSettings: [ // AdvancedBackupSettings
50
+ * // { // AdvancedBackupSetting
51
+ * // ResourceType: "STRING_VALUE",
52
+ * // BackupOptions: { // BackupOptions
53
+ * // "<keys>": "STRING_VALUE",
54
+ * // },
55
+ * // },
56
+ * // ],
57
+ * // },
58
+ * // ],
59
+ * // };
60
+ *
37
61
  * ```
38
62
  *
39
63
  * @param ListBackupPlanVersionsCommandInput - {@link ListBackupPlanVersionsCommandInput}
@@ -55,6 +79,8 @@ export interface ListBackupPlanVersionsCommandOutput extends ListBackupPlanVersi
55
79
  * @throws {@link ServiceUnavailableException} (server fault)
56
80
  * <p>The request failed due to a temporary failure of the server.</p>
57
81
  *
82
+ * @throws {@link BackupServiceException}
83
+ * <p>Base exception class for all service exceptions from Backup service.</p>
58
84
  *
59
85
  */
60
86
  export declare class ListBackupPlanVersionsCommand extends $Command<ListBackupPlanVersionsCommandInput, ListBackupPlanVersionsCommandOutput, BackupClientResolvedConfig> {
@@ -35,6 +35,30 @@ export interface ListBackupPlansCommandOutput extends ListBackupPlansOutput, __M
35
35
  * };
36
36
  * const command = new ListBackupPlansCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ListBackupPlansOutput
39
+ * // NextToken: "STRING_VALUE",
40
+ * // BackupPlansList: [ // BackupPlansList
41
+ * // { // BackupPlansListMember
42
+ * // BackupPlanArn: "STRING_VALUE",
43
+ * // BackupPlanId: "STRING_VALUE",
44
+ * // CreationDate: new Date("TIMESTAMP"),
45
+ * // DeletionDate: new Date("TIMESTAMP"),
46
+ * // VersionId: "STRING_VALUE",
47
+ * // BackupPlanName: "STRING_VALUE",
48
+ * // CreatorRequestId: "STRING_VALUE",
49
+ * // LastExecutionDate: new Date("TIMESTAMP"),
50
+ * // AdvancedBackupSettings: [ // AdvancedBackupSettings
51
+ * // { // AdvancedBackupSetting
52
+ * // ResourceType: "STRING_VALUE",
53
+ * // BackupOptions: { // BackupOptions
54
+ * // "<keys>": "STRING_VALUE",
55
+ * // },
56
+ * // },
57
+ * // ],
58
+ * // },
59
+ * // ],
60
+ * // };
61
+ *
38
62
  * ```
39
63
  *
40
64
  * @param ListBackupPlansCommandInput - {@link ListBackupPlansCommandInput}
@@ -56,6 +80,8 @@ export interface ListBackupPlansCommandOutput extends ListBackupPlansOutput, __M
56
80
  * @throws {@link ServiceUnavailableException} (server fault)
57
81
  * <p>The request failed due to a temporary failure of the server.</p>
58
82
  *
83
+ * @throws {@link BackupServiceException}
84
+ * <p>Base exception class for all service exceptions from Backup service.</p>
59
85
  *
60
86
  */
61
87
  export declare class ListBackupPlansCommand extends $Command<ListBackupPlansCommandInput, ListBackupPlansCommandOutput, BackupClientResolvedConfig> {
@@ -34,6 +34,20 @@ export interface ListBackupSelectionsCommandOutput extends ListBackupSelectionsO
34
34
  * };
35
35
  * const command = new ListBackupSelectionsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListBackupSelectionsOutput
38
+ * // NextToken: "STRING_VALUE",
39
+ * // BackupSelectionsList: [ // BackupSelectionsList
40
+ * // { // BackupSelectionsListMember
41
+ * // SelectionId: "STRING_VALUE",
42
+ * // SelectionName: "STRING_VALUE",
43
+ * // BackupPlanId: "STRING_VALUE",
44
+ * // CreationDate: new Date("TIMESTAMP"),
45
+ * // CreatorRequestId: "STRING_VALUE",
46
+ * // IamRoleArn: "STRING_VALUE",
47
+ * // },
48
+ * // ],
49
+ * // };
50
+ *
37
51
  * ```
38
52
  *
39
53
  * @param ListBackupSelectionsCommandInput - {@link ListBackupSelectionsCommandInput}
@@ -55,6 +69,8 @@ export interface ListBackupSelectionsCommandOutput extends ListBackupSelectionsO
55
69
  * @throws {@link ServiceUnavailableException} (server fault)
56
70
  * <p>The request failed due to a temporary failure of the server.</p>
57
71
  *
72
+ * @throws {@link BackupServiceException}
73
+ * <p>Base exception class for all service exceptions from Backup service.</p>
58
74
  *
59
75
  */
60
76
  export declare class ListBackupSelectionsCommand extends $Command<ListBackupSelectionsCommandInput, ListBackupSelectionsCommandOutput, BackupClientResolvedConfig> {
@@ -33,6 +33,24 @@ export interface ListBackupVaultsCommandOutput extends ListBackupVaultsOutput, _
33
33
  * };
34
34
  * const command = new ListBackupVaultsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListBackupVaultsOutput
37
+ * // BackupVaultList: [ // BackupVaultList
38
+ * // { // BackupVaultListMember
39
+ * // BackupVaultName: "STRING_VALUE",
40
+ * // BackupVaultArn: "STRING_VALUE",
41
+ * // CreationDate: new Date("TIMESTAMP"),
42
+ * // EncryptionKeyArn: "STRING_VALUE",
43
+ * // CreatorRequestId: "STRING_VALUE",
44
+ * // NumberOfRecoveryPoints: Number("long"),
45
+ * // Locked: true || false,
46
+ * // MinRetentionDays: Number("long"),
47
+ * // MaxRetentionDays: Number("long"),
48
+ * // LockDate: new Date("TIMESTAMP"),
49
+ * // },
50
+ * // ],
51
+ * // NextToken: "STRING_VALUE",
52
+ * // };
53
+ *
36
54
  * ```
37
55
  *
38
56
  * @param ListBackupVaultsCommandInput - {@link ListBackupVaultsCommandInput}
@@ -54,6 +72,8 @@ export interface ListBackupVaultsCommandOutput extends ListBackupVaultsOutput, _
54
72
  * @throws {@link ServiceUnavailableException} (server fault)
55
73
  * <p>The request failed due to a temporary failure of the server.</p>
56
74
  *
75
+ * @throws {@link BackupServiceException}
76
+ * <p>Base exception class for all service exceptions from Backup service.</p>
57
77
  *
58
78
  */
59
79
  export declare class ListBackupVaultsCommand extends $Command<ListBackupVaultsCommandInput, ListBackupVaultsCommandOutput, BackupClientResolvedConfig> {
@@ -42,6 +42,42 @@ export interface ListCopyJobsCommandOutput extends ListCopyJobsOutput, __Metadat
42
42
  * };
43
43
  * const command = new ListCopyJobsCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // ListCopyJobsOutput
46
+ * // CopyJobs: [ // CopyJobsList
47
+ * // { // CopyJob
48
+ * // AccountId: "STRING_VALUE",
49
+ * // CopyJobId: "STRING_VALUE",
50
+ * // SourceBackupVaultArn: "STRING_VALUE",
51
+ * // SourceRecoveryPointArn: "STRING_VALUE",
52
+ * // DestinationBackupVaultArn: "STRING_VALUE",
53
+ * // DestinationRecoveryPointArn: "STRING_VALUE",
54
+ * // ResourceArn: "STRING_VALUE",
55
+ * // CreationDate: new Date("TIMESTAMP"),
56
+ * // CompletionDate: new Date("TIMESTAMP"),
57
+ * // State: "CREATED" || "RUNNING" || "COMPLETED" || "FAILED" || "PARTIAL",
58
+ * // StatusMessage: "STRING_VALUE",
59
+ * // BackupSizeInBytes: Number("long"),
60
+ * // IamRoleArn: "STRING_VALUE",
61
+ * // CreatedBy: { // RecoveryPointCreator
62
+ * // BackupPlanId: "STRING_VALUE",
63
+ * // BackupPlanArn: "STRING_VALUE",
64
+ * // BackupPlanVersion: "STRING_VALUE",
65
+ * // BackupRuleId: "STRING_VALUE",
66
+ * // },
67
+ * // ResourceType: "STRING_VALUE",
68
+ * // ParentJobId: "STRING_VALUE",
69
+ * // IsParent: true || false,
70
+ * // CompositeMemberIdentifier: "STRING_VALUE",
71
+ * // NumberOfChildJobs: Number("long"),
72
+ * // ChildJobsInState: { // CopyJobChildJobsInState
73
+ * // "<keys>": Number("long"),
74
+ * // },
75
+ * // ResourceName: "STRING_VALUE",
76
+ * // },
77
+ * // ],
78
+ * // NextToken: "STRING_VALUE",
79
+ * // };
80
+ *
45
81
  * ```
46
82
  *
47
83
  * @param ListCopyJobsCommandInput - {@link ListCopyJobsCommandInput}
@@ -57,6 +93,8 @@ export interface ListCopyJobsCommandOutput extends ListCopyJobsOutput, __Metadat
57
93
  * @throws {@link ServiceUnavailableException} (server fault)
58
94
  * <p>The request failed due to a temporary failure of the server.</p>
59
95
  *
96
+ * @throws {@link BackupServiceException}
97
+ * <p>Base exception class for all service exceptions from Backup service.</p>
60
98
  *
61
99
  */
62
100
  export declare class ListCopyJobsCommand extends $Command<ListCopyJobsCommandInput, ListCopyJobsCommandOutput, BackupClientResolvedConfig> {
@@ -32,6 +32,20 @@ export interface ListFrameworksCommandOutput extends ListFrameworksOutput, __Met
32
32
  * };
33
33
  * const command = new ListFrameworksCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListFrameworksOutput
36
+ * // Frameworks: [ // FrameworkList
37
+ * // { // Framework
38
+ * // FrameworkName: "STRING_VALUE",
39
+ * // FrameworkArn: "STRING_VALUE",
40
+ * // FrameworkDescription: "STRING_VALUE",
41
+ * // NumberOfControls: Number("int"),
42
+ * // CreationTime: new Date("TIMESTAMP"),
43
+ * // DeploymentStatus: "STRING_VALUE",
44
+ * // },
45
+ * // ],
46
+ * // NextToken: "STRING_VALUE",
47
+ * // };
48
+ *
35
49
  * ```
36
50
  *
37
51
  * @param ListFrameworksCommandInput - {@link ListFrameworksCommandInput}
@@ -47,6 +61,8 @@ export interface ListFrameworksCommandOutput extends ListFrameworksOutput, __Met
47
61
  * @throws {@link ServiceUnavailableException} (server fault)
48
62
  * <p>The request failed due to a temporary failure of the server.</p>
49
63
  *
64
+ * @throws {@link BackupServiceException}
65
+ * <p>Base exception class for all service exceptions from Backup service.</p>
50
66
  *
51
67
  */
52
68
  export declare class ListFrameworksCommand extends $Command<ListFrameworksCommandInput, ListFrameworksCommandOutput, BackupClientResolvedConfig> {
@@ -32,6 +32,21 @@ export interface ListLegalHoldsCommandOutput extends ListLegalHoldsOutput, __Met
32
32
  * };
33
33
  * const command = new ListLegalHoldsCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListLegalHoldsOutput
36
+ * // NextToken: "STRING_VALUE",
37
+ * // LegalHolds: [ // LegalHoldsList
38
+ * // { // LegalHold
39
+ * // Title: "STRING_VALUE",
40
+ * // Status: "CREATING" || "ACTIVE" || "CANCELING" || "CANCELED",
41
+ * // Description: "STRING_VALUE",
42
+ * // LegalHoldId: "STRING_VALUE",
43
+ * // LegalHoldArn: "STRING_VALUE",
44
+ * // CreationDate: new Date("TIMESTAMP"),
45
+ * // CancellationDate: new Date("TIMESTAMP"),
46
+ * // },
47
+ * // ],
48
+ * // };
49
+ *
35
50
  * ```
36
51
  *
37
52
  * @param ListLegalHoldsCommandInput - {@link ListLegalHoldsCommandInput}
@@ -47,6 +62,8 @@ export interface ListLegalHoldsCommandOutput extends ListLegalHoldsOutput, __Met
47
62
  * @throws {@link ServiceUnavailableException} (server fault)
48
63
  * <p>The request failed due to a temporary failure of the server.</p>
49
64
  *
65
+ * @throws {@link BackupServiceException}
66
+ * <p>Base exception class for all service exceptions from Backup service.</p>
50
67
  *
51
68
  */
52
69
  export declare class ListLegalHoldsCommand extends $Command<ListLegalHoldsCommandInput, ListLegalHoldsCommandOutput, BackupClientResolvedConfig> {
@@ -34,6 +34,18 @@ export interface ListProtectedResourcesCommandOutput extends ListProtectedResour
34
34
  * };
35
35
  * const command = new ListProtectedResourcesCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListProtectedResourcesOutput
38
+ * // Results: [ // ProtectedResourcesList
39
+ * // { // ProtectedResource
40
+ * // ResourceArn: "STRING_VALUE",
41
+ * // ResourceType: "STRING_VALUE",
42
+ * // LastBackupTime: new Date("TIMESTAMP"),
43
+ * // ResourceName: "STRING_VALUE",
44
+ * // },
45
+ * // ],
46
+ * // NextToken: "STRING_VALUE",
47
+ * // };
48
+ *
37
49
  * ```
38
50
  *
39
51
  * @param ListProtectedResourcesCommandInput - {@link ListProtectedResourcesCommandInput}
@@ -49,6 +61,8 @@ export interface ListProtectedResourcesCommandOutput extends ListProtectedResour
49
61
  * @throws {@link ServiceUnavailableException} (server fault)
50
62
  * <p>The request failed due to a temporary failure of the server.</p>
51
63
  *
64
+ * @throws {@link BackupServiceException}
65
+ * <p>Base exception class for all service exceptions from Backup service.</p>
52
66
  *
53
67
  */
54
68
  export declare class ListProtectedResourcesCommand extends $Command<ListProtectedResourcesCommandInput, ListProtectedResourcesCommandOutput, BackupClientResolvedConfig> {
@@ -39,6 +39,47 @@ export interface ListRecoveryPointsByBackupVaultCommandOutput extends ListRecove
39
39
  * };
40
40
  * const command = new ListRecoveryPointsByBackupVaultCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // ListRecoveryPointsByBackupVaultOutput
43
+ * // NextToken: "STRING_VALUE",
44
+ * // RecoveryPoints: [ // RecoveryPointByBackupVaultList
45
+ * // { // RecoveryPointByBackupVault
46
+ * // RecoveryPointArn: "STRING_VALUE",
47
+ * // BackupVaultName: "STRING_VALUE",
48
+ * // BackupVaultArn: "STRING_VALUE",
49
+ * // SourceBackupVaultArn: "STRING_VALUE",
50
+ * // ResourceArn: "STRING_VALUE",
51
+ * // ResourceType: "STRING_VALUE",
52
+ * // CreatedBy: { // RecoveryPointCreator
53
+ * // BackupPlanId: "STRING_VALUE",
54
+ * // BackupPlanArn: "STRING_VALUE",
55
+ * // BackupPlanVersion: "STRING_VALUE",
56
+ * // BackupRuleId: "STRING_VALUE",
57
+ * // },
58
+ * // IamRoleArn: "STRING_VALUE",
59
+ * // Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED",
60
+ * // StatusMessage: "STRING_VALUE",
61
+ * // CreationDate: new Date("TIMESTAMP"),
62
+ * // CompletionDate: new Date("TIMESTAMP"),
63
+ * // BackupSizeInBytes: Number("long"),
64
+ * // CalculatedLifecycle: { // CalculatedLifecycle
65
+ * // MoveToColdStorageAt: new Date("TIMESTAMP"),
66
+ * // DeleteAt: new Date("TIMESTAMP"),
67
+ * // },
68
+ * // Lifecycle: { // Lifecycle
69
+ * // MoveToColdStorageAfterDays: Number("long"),
70
+ * // DeleteAfterDays: Number("long"),
71
+ * // },
72
+ * // EncryptionKeyArn: "STRING_VALUE",
73
+ * // IsEncrypted: true || false,
74
+ * // LastRestoreTime: new Date("TIMESTAMP"),
75
+ * // ParentRecoveryPointArn: "STRING_VALUE",
76
+ * // CompositeMemberIdentifier: "STRING_VALUE",
77
+ * // IsParent: true || false,
78
+ * // ResourceName: "STRING_VALUE",
79
+ * // },
80
+ * // ],
81
+ * // };
82
+ *
42
83
  * ```
43
84
  *
44
85
  * @param ListRecoveryPointsByBackupVaultCommandInput - {@link ListRecoveryPointsByBackupVaultCommandInput}
@@ -60,6 +101,8 @@ export interface ListRecoveryPointsByBackupVaultCommandOutput extends ListRecove
60
101
  * @throws {@link ServiceUnavailableException} (server fault)
61
102
  * <p>The request failed due to a temporary failure of the server.</p>
62
103
  *
104
+ * @throws {@link BackupServiceException}
105
+ * <p>Base exception class for all service exceptions from Backup service.</p>
63
106
  *
64
107
  */
65
108
  export declare class ListRecoveryPointsByBackupVaultCommand extends $Command<ListRecoveryPointsByBackupVaultCommandInput, ListRecoveryPointsByBackupVaultCommandOutput, BackupClientResolvedConfig> {
@@ -34,6 +34,15 @@ export interface ListRecoveryPointsByLegalHoldCommandOutput extends ListRecovery
34
34
  * };
35
35
  * const command = new ListRecoveryPointsByLegalHoldCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListRecoveryPointsByLegalHoldOutput
38
+ * // RecoveryPoints: [ // RecoveryPointsList
39
+ * // { // RecoveryPointMember
40
+ * // RecoveryPointArn: "STRING_VALUE",
41
+ * // },
42
+ * // ],
43
+ * // NextToken: "STRING_VALUE",
44
+ * // };
45
+ *
37
46
  * ```
38
47
  *
39
48
  * @param ListRecoveryPointsByLegalHoldCommandInput - {@link ListRecoveryPointsByLegalHoldCommandInput}
@@ -52,6 +61,8 @@ export interface ListRecoveryPointsByLegalHoldCommandOutput extends ListRecovery
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 ListRecoveryPointsByLegalHoldCommand extends $Command<ListRecoveryPointsByLegalHoldCommandInput, ListRecoveryPointsByLegalHoldCommandOutput, BackupClientResolvedConfig> {
@@ -38,6 +38,24 @@ export interface ListRecoveryPointsByResourceCommandOutput extends ListRecoveryP
38
38
  * };
39
39
  * const command = new ListRecoveryPointsByResourceCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // ListRecoveryPointsByResourceOutput
42
+ * // NextToken: "STRING_VALUE",
43
+ * // RecoveryPoints: [ // RecoveryPointByResourceList
44
+ * // { // RecoveryPointByResource
45
+ * // RecoveryPointArn: "STRING_VALUE",
46
+ * // CreationDate: new Date("TIMESTAMP"),
47
+ * // Status: "COMPLETED" || "PARTIAL" || "DELETING" || "EXPIRED",
48
+ * // StatusMessage: "STRING_VALUE",
49
+ * // EncryptionKeyArn: "STRING_VALUE",
50
+ * // BackupSizeBytes: Number("long"),
51
+ * // BackupVaultName: "STRING_VALUE",
52
+ * // IsParent: true || false,
53
+ * // ParentRecoveryPointArn: "STRING_VALUE",
54
+ * // ResourceName: "STRING_VALUE",
55
+ * // },
56
+ * // ],
57
+ * // };
58
+ *
41
59
  * ```
42
60
  *
43
61
  * @param ListRecoveryPointsByResourceCommandInput - {@link ListRecoveryPointsByResourceCommandInput}
@@ -59,6 +77,8 @@ export interface ListRecoveryPointsByResourceCommandOutput extends ListRecoveryP
59
77
  * @throws {@link ServiceUnavailableException} (server fault)
60
78
  * <p>The request failed due to a temporary failure of the server.</p>
61
79
  *
80
+ * @throws {@link BackupServiceException}
81
+ * <p>Base exception class for all service exceptions from Backup service.</p>
62
82
  *
63
83
  */
64
84
  export declare class ListRecoveryPointsByResourceCommand extends $Command<ListRecoveryPointsByResourceCommandInput, ListRecoveryPointsByResourceCommandOutput, BackupClientResolvedConfig> {
@@ -36,6 +36,27 @@ export interface ListReportJobsCommandOutput extends ListReportJobsOutput, __Met
36
36
  * };
37
37
  * const command = new ListReportJobsCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // ListReportJobsOutput
40
+ * // ReportJobs: [ // ReportJobList
41
+ * // { // ReportJob
42
+ * // ReportJobId: "STRING_VALUE",
43
+ * // ReportPlanArn: "STRING_VALUE",
44
+ * // ReportTemplate: "STRING_VALUE",
45
+ * // CreationTime: new Date("TIMESTAMP"),
46
+ * // CompletionTime: new Date("TIMESTAMP"),
47
+ * // Status: "STRING_VALUE",
48
+ * // StatusMessage: "STRING_VALUE",
49
+ * // ReportDestination: { // ReportDestination
50
+ * // S3BucketName: "STRING_VALUE",
51
+ * // S3Keys: [ // stringList
52
+ * // "STRING_VALUE",
53
+ * // ],
54
+ * // },
55
+ * // },
56
+ * // ],
57
+ * // NextToken: "STRING_VALUE",
58
+ * // };
59
+ *
39
60
  * ```
40
61
  *
41
62
  * @param ListReportJobsCommandInput - {@link ListReportJobsCommandInput}
@@ -54,6 +75,8 @@ export interface ListReportJobsCommandOutput extends ListReportJobsOutput, __Met
54
75
  * @throws {@link ServiceUnavailableException} (server fault)
55
76
  * <p>The request failed due to a temporary failure of the server.</p>
56
77
  *
78
+ * @throws {@link BackupServiceException}
79
+ * <p>Base exception class for all service exceptions from Backup service.</p>
57
80
  *
58
81
  */
59
82
  export declare class ListReportJobsCommand extends $Command<ListReportJobsCommandInput, ListReportJobsCommandOutput, BackupClientResolvedConfig> {
@@ -33,6 +33,44 @@ export interface ListReportPlansCommandOutput extends ListReportPlansOutput, __M
33
33
  * };
34
34
  * const command = new ListReportPlansCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListReportPlansOutput
37
+ * // ReportPlans: [ // ReportPlanList
38
+ * // { // ReportPlan
39
+ * // ReportPlanArn: "STRING_VALUE",
40
+ * // ReportPlanName: "STRING_VALUE",
41
+ * // ReportPlanDescription: "STRING_VALUE",
42
+ * // ReportSetting: { // ReportSetting
43
+ * // ReportTemplate: "STRING_VALUE", // required
44
+ * // FrameworkArns: [ // stringList
45
+ * // "STRING_VALUE",
46
+ * // ],
47
+ * // NumberOfFrameworks: Number("int"),
48
+ * // Accounts: [
49
+ * // "STRING_VALUE",
50
+ * // ],
51
+ * // OrganizationUnits: [
52
+ * // "STRING_VALUE",
53
+ * // ],
54
+ * // Regions: [
55
+ * // "STRING_VALUE",
56
+ * // ],
57
+ * // },
58
+ * // ReportDeliveryChannel: { // ReportDeliveryChannel
59
+ * // S3BucketName: "STRING_VALUE", // required
60
+ * // S3KeyPrefix: "STRING_VALUE",
61
+ * // Formats: [ // FormatList
62
+ * // "STRING_VALUE",
63
+ * // ],
64
+ * // },
65
+ * // DeploymentStatus: "STRING_VALUE",
66
+ * // CreationTime: new Date("TIMESTAMP"),
67
+ * // LastAttemptedExecutionTime: new Date("TIMESTAMP"),
68
+ * // LastSuccessfulExecutionTime: new Date("TIMESTAMP"),
69
+ * // },
70
+ * // ],
71
+ * // NextToken: "STRING_VALUE",
72
+ * // };
73
+ *
36
74
  * ```
37
75
  *
38
76
  * @param ListReportPlansCommandInput - {@link ListReportPlansCommandInput}
@@ -48,6 +86,8 @@ export interface ListReportPlansCommandOutput extends ListReportPlansOutput, __M
48
86
  * @throws {@link ServiceUnavailableException} (server fault)
49
87
  * <p>The request failed due to a temporary failure of the server.</p>
50
88
  *
89
+ * @throws {@link BackupServiceException}
90
+ * <p>Base exception class for all service exceptions from Backup service.</p>
51
91
  *
52
92
  */
53
93
  export declare class ListReportPlansCommand extends $Command<ListReportPlansCommandInput, ListReportPlansCommandOutput, BackupClientResolvedConfig> {
@@ -39,6 +39,27 @@ export interface ListRestoreJobsCommandOutput extends ListRestoreJobsOutput, __M
39
39
  * };
40
40
  * const command = new ListRestoreJobsCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // ListRestoreJobsOutput
43
+ * // RestoreJobs: [ // RestoreJobsList
44
+ * // { // RestoreJobsListMember
45
+ * // AccountId: "STRING_VALUE",
46
+ * // RestoreJobId: "STRING_VALUE",
47
+ * // RecoveryPointArn: "STRING_VALUE",
48
+ * // CreationDate: new Date("TIMESTAMP"),
49
+ * // CompletionDate: new Date("TIMESTAMP"),
50
+ * // Status: "PENDING" || "RUNNING" || "COMPLETED" || "ABORTED" || "FAILED",
51
+ * // StatusMessage: "STRING_VALUE",
52
+ * // PercentDone: "STRING_VALUE",
53
+ * // BackupSizeInBytes: Number("long"),
54
+ * // IamRoleArn: "STRING_VALUE",
55
+ * // ExpectedCompletionTimeMinutes: Number("long"),
56
+ * // CreatedResourceArn: "STRING_VALUE",
57
+ * // ResourceType: "STRING_VALUE",
58
+ * // },
59
+ * // ],
60
+ * // NextToken: "STRING_VALUE",
61
+ * // };
62
+ *
42
63
  * ```
43
64
  *
44
65
  * @param ListRestoreJobsCommandInput - {@link ListRestoreJobsCommandInput}
@@ -60,6 +81,8 @@ export interface ListRestoreJobsCommandOutput extends ListRestoreJobsOutput, __M
60
81
  * @throws {@link ServiceUnavailableException} (server fault)
61
82
  * <p>The request failed due to a temporary failure of the server.</p>
62
83
  *
84
+ * @throws {@link BackupServiceException}
85
+ * <p>Base exception class for all service exceptions from Backup service.</p>
63
86
  *
64
87
  */
65
88
  export declare class ListRestoreJobsCommand extends $Command<ListRestoreJobsCommandInput, ListRestoreJobsCommandOutput, BackupClientResolvedConfig> {
@@ -38,6 +38,13 @@ export interface ListTagsCommandOutput extends ListTagsOutput, __MetadataBearer
38
38
  * };
39
39
  * const command = new ListTagsCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // ListTagsOutput
42
+ * // NextToken: "STRING_VALUE",
43
+ * // Tags: { // Tags
44
+ * // "<keys>": "STRING_VALUE",
45
+ * // },
46
+ * // };
47
+ *
41
48
  * ```
42
49
  *
43
50
  * @param ListTagsCommandInput - {@link ListTagsCommandInput}
@@ -59,6 +66,8 @@ export interface ListTagsCommandOutput extends ListTagsOutput, __MetadataBearer
59
66
  * @throws {@link ServiceUnavailableException} (server fault)
60
67
  * <p>The request failed due to a temporary failure of the server.</p>
61
68
  *
69
+ * @throws {@link BackupServiceException}
70
+ * <p>Base exception class for all service exceptions from Backup service.</p>
62
71
  *
63
72
  */
64
73
  export declare class ListTagsCommand extends $Command<ListTagsCommandInput, ListTagsCommandOutput, BackupClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface PutBackupVaultAccessPolicyCommandOutput extends __MetadataBeare
34
34
  * };
35
35
  * const command = new PutBackupVaultAccessPolicyCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param PutBackupVaultAccessPolicyCommandInput - {@link PutBackupVaultAccessPolicyCommandInput}
@@ -55,6 +57,8 @@ export interface PutBackupVaultAccessPolicyCommandOutput extends __MetadataBeare
55
57
  * @throws {@link ServiceUnavailableException} (server fault)
56
58
  * <p>The request failed due to a temporary failure of the server.</p>
57
59
  *
60
+ * @throws {@link BackupServiceException}
61
+ * <p>Base exception class for all service exceptions from Backup service.</p>
58
62
  *
59
63
  */
60
64
  export declare class PutBackupVaultAccessPolicyCommand extends $Command<PutBackupVaultAccessPolicyCommandInput, PutBackupVaultAccessPolicyCommandOutput, BackupClientResolvedConfig> {
@@ -46,6 +46,8 @@ export interface PutBackupVaultLockConfigurationCommandOutput extends __Metadata
46
46
  * };
47
47
  * const command = new PutBackupVaultLockConfigurationCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // {};
50
+ *
49
51
  * ```
50
52
  *
51
53
  * @param PutBackupVaultLockConfigurationCommandInput - {@link PutBackupVaultLockConfigurationCommandInput}
@@ -71,6 +73,8 @@ export interface PutBackupVaultLockConfigurationCommandOutput extends __Metadata
71
73
  * @throws {@link ServiceUnavailableException} (server fault)
72
74
  * <p>The request failed due to a temporary failure of the server.</p>
73
75
  *
76
+ * @throws {@link BackupServiceException}
77
+ * <p>Base exception class for all service exceptions from Backup service.</p>
74
78
  *
75
79
  */
76
80
  export declare class PutBackupVaultLockConfigurationCommand extends $Command<PutBackupVaultLockConfigurationCommandInput, PutBackupVaultLockConfigurationCommandOutput, BackupClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface PutBackupVaultNotificationsCommandOutput extends __MetadataBear
35
35
  * };
36
36
  * const command = new PutBackupVaultNotificationsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param PutBackupVaultNotificationsCommandInput - {@link PutBackupVaultNotificationsCommandInput}
@@ -56,6 +58,8 @@ export interface PutBackupVaultNotificationsCommandOutput extends __MetadataBear
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 PutBackupVaultNotificationsCommand extends $Command<PutBackupVaultNotificationsCommandInput, PutBackupVaultNotificationsCommandOutput, BackupClientResolvedConfig> {
@@ -46,6 +46,13 @@ export interface StartBackupJobCommandOutput extends StartBackupJobOutput, __Met
46
46
  * };
47
47
  * const command = new StartBackupJobCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // { // StartBackupJobOutput
50
+ * // BackupJobId: "STRING_VALUE",
51
+ * // RecoveryPointArn: "STRING_VALUE",
52
+ * // CreationDate: new Date("TIMESTAMP"),
53
+ * // IsParent: true || false,
54
+ * // };
55
+ *
49
56
  * ```
50
57
  *
51
58
  * @param StartBackupJobCommandInput - {@link StartBackupJobCommandInput}
@@ -75,6 +82,8 @@ export interface StartBackupJobCommandOutput extends StartBackupJobOutput, __Met
75
82
  * @throws {@link ServiceUnavailableException} (server fault)
76
83
  * <p>The request failed due to a temporary failure of the server.</p>
77
84
  *
85
+ * @throws {@link BackupServiceException}
86
+ * <p>Base exception class for all service exceptions from Backup service.</p>
78
87
  *
79
88
  */
80
89
  export declare class StartBackupJobCommand extends $Command<StartBackupJobCommandInput, StartBackupJobCommandOutput, BackupClientResolvedConfig> {