@aws-sdk/client-backup 3.933.0 → 3.935.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 (76) hide show
  1. package/README.md +72 -0
  2. package/dist-cjs/index.js +854 -197
  3. package/dist-es/Backup.js +18 -0
  4. package/dist-es/commands/CreateTieringConfigurationCommand.js +16 -0
  5. package/dist-es/commands/DeleteTieringConfigurationCommand.js +16 -0
  6. package/dist-es/commands/DescribeScanJobCommand.js +16 -0
  7. package/dist-es/commands/GetTieringConfigurationCommand.js +16 -0
  8. package/dist-es/commands/ListScanJobSummariesCommand.js +16 -0
  9. package/dist-es/commands/ListScanJobsCommand.js +16 -0
  10. package/dist-es/commands/ListTieringConfigurationsCommand.js +16 -0
  11. package/dist-es/commands/StartScanJobCommand.js +16 -0
  12. package/dist-es/commands/UpdateTieringConfigurationCommand.js +16 -0
  13. package/dist-es/commands/index.js +9 -0
  14. package/dist-es/index.js +2 -1
  15. package/dist-es/models/enums.js +215 -0
  16. package/dist-es/models/errors.js +205 -0
  17. package/dist-es/models/models_0.js +1 -377
  18. package/dist-es/pagination/ListScanJobSummariesPaginator.js +4 -0
  19. package/dist-es/pagination/ListScanJobsPaginator.js +4 -0
  20. package/dist-es/pagination/ListTieringConfigurationsPaginator.js +4 -0
  21. package/dist-es/pagination/index.js +3 -0
  22. package/dist-es/schemas/schemas_0.js +490 -19
  23. package/dist-types/Backup.d.ts +66 -0
  24. package/dist-types/BackupClient.d.ts +11 -2
  25. package/dist-types/commands/CreateBackupPlanCommand.d.ts +15 -0
  26. package/dist-types/commands/CreateTieringConfigurationCommand.d.ts +115 -0
  27. package/dist-types/commands/DeleteTieringConfigurationCommand.d.ts +85 -0
  28. package/dist-types/commands/DescribeRecoveryPointCommand.d.ts +10 -0
  29. package/dist-types/commands/DescribeScanJobCommand.d.ts +113 -0
  30. package/dist-types/commands/GetBackupPlanCommand.d.ts +15 -0
  31. package/dist-types/commands/GetBackupPlanFromJSONCommand.d.ts +15 -0
  32. package/dist-types/commands/GetBackupPlanFromTemplateCommand.d.ts +15 -0
  33. package/dist-types/commands/GetTieringConfigurationCommand.d.ts +105 -0
  34. package/dist-types/commands/ListRecoveryPointsByBackupVaultCommand.d.ts +7 -0
  35. package/dist-types/commands/ListRecoveryPointsByResourceCommand.d.ts +7 -0
  36. package/dist-types/commands/ListScanJobSummariesCommand.d.ts +102 -0
  37. package/dist-types/commands/ListScanJobsCommand.d.ts +123 -0
  38. package/dist-types/commands/ListTieringConfigurationsCommand.d.ts +91 -0
  39. package/dist-types/commands/StartScanJobCommand.d.ts +103 -0
  40. package/dist-types/commands/UpdateBackupPlanCommand.d.ts +24 -0
  41. package/dist-types/commands/UpdateTieringConfigurationCommand.d.ts +134 -0
  42. package/dist-types/commands/index.d.ts +9 -0
  43. package/dist-types/index.d.ts +3 -1
  44. package/dist-types/models/enums.d.ts +479 -0
  45. package/dist-types/models/errors.d.ts +257 -0
  46. package/dist-types/models/models_0.d.ts +1231 -723
  47. package/dist-types/pagination/ListScanJobSummariesPaginator.d.ts +7 -0
  48. package/dist-types/pagination/ListScanJobsPaginator.d.ts +7 -0
  49. package/dist-types/pagination/ListTieringConfigurationsPaginator.d.ts +7 -0
  50. package/dist-types/pagination/index.d.ts +3 -0
  51. package/dist-types/schemas/schemas_0.d.ts +48 -0
  52. package/dist-types/ts3.4/Backup.d.ts +156 -0
  53. package/dist-types/ts3.4/BackupClient.d.ts +56 -2
  54. package/dist-types/ts3.4/commands/CreateTieringConfigurationCommand.d.ts +51 -0
  55. package/dist-types/ts3.4/commands/DeleteTieringConfigurationCommand.d.ts +51 -0
  56. package/dist-types/ts3.4/commands/DescribeScanJobCommand.d.ts +50 -0
  57. package/dist-types/ts3.4/commands/GetTieringConfigurationCommand.d.ts +51 -0
  58. package/dist-types/ts3.4/commands/ListScanJobSummariesCommand.d.ts +51 -0
  59. package/dist-types/ts3.4/commands/ListScanJobsCommand.d.ts +47 -0
  60. package/dist-types/ts3.4/commands/ListTieringConfigurationsCommand.d.ts +51 -0
  61. package/dist-types/ts3.4/commands/StartScanJobCommand.d.ts +47 -0
  62. package/dist-types/ts3.4/commands/UpdateTieringConfigurationCommand.d.ts +51 -0
  63. package/dist-types/ts3.4/commands/index.d.ts +9 -0
  64. package/dist-types/ts3.4/index.d.ts +3 -1
  65. package/dist-types/ts3.4/models/enums.d.ts +268 -0
  66. package/dist-types/ts3.4/models/errors.d.ts +112 -0
  67. package/dist-types/ts3.4/models/models_0.d.ts +243 -324
  68. package/dist-types/ts3.4/pagination/ListScanJobSummariesPaginator.d.ts +11 -0
  69. package/dist-types/ts3.4/pagination/ListScanJobsPaginator.d.ts +11 -0
  70. package/dist-types/ts3.4/pagination/ListTieringConfigurationsPaginator.d.ts +11 -0
  71. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  72. package/dist-types/ts3.4/schemas/schemas_0.d.ts +48 -0
  73. package/package.json +12 -12
  74. package/dist-es/models/index.js +0 -1
  75. package/dist-types/models/index.d.ts +0 -1
  76. package/dist-types/ts3.4/models/index.d.ts +0 -1
@@ -77,6 +77,12 @@ declare const UpdateBackupPlanCommand_base: {
77
77
  * ],
78
78
  * },
79
79
  * ],
80
+ * ScanActions: [ // ScanActions
81
+ * { // ScanAction
82
+ * MalwareScanner: "GUARDDUTY",
83
+ * ScanMode: "FULL_SCAN" || "INCREMENTAL_SCAN",
84
+ * },
85
+ * ],
80
86
  * },
81
87
  * ],
82
88
  * AdvancedBackupSettings: [ // AdvancedBackupSettings
@@ -87,6 +93,15 @@ declare const UpdateBackupPlanCommand_base: {
87
93
  * },
88
94
  * },
89
95
  * ],
96
+ * ScanSettings: [ // ScanSettings
97
+ * { // ScanSetting
98
+ * MalwareScanner: "GUARDDUTY",
99
+ * ResourceTypes: [
100
+ * "STRING_VALUE",
101
+ * ],
102
+ * ScannerRoleArn: "STRING_VALUE",
103
+ * },
104
+ * ],
90
105
  * },
91
106
  * };
92
107
  * const command = new UpdateBackupPlanCommand(input);
@@ -104,6 +119,15 @@ declare const UpdateBackupPlanCommand_base: {
104
119
  * // },
105
120
  * // },
106
121
  * // ],
122
+ * // ScanSettings: [ // ScanSettings
123
+ * // { // ScanSetting
124
+ * // MalwareScanner: "GUARDDUTY",
125
+ * // ResourceTypes: [ // ResourceTypes
126
+ * // "STRING_VALUE",
127
+ * // ],
128
+ * // ScannerRoleArn: "STRING_VALUE",
129
+ * // },
130
+ * // ],
107
131
  * // };
108
132
  *
109
133
  * ```
@@ -0,0 +1,134 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupClient";
4
+ import { UpdateTieringConfigurationInput, UpdateTieringConfigurationOutput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UpdateTieringConfigurationCommand}.
14
+ */
15
+ export interface UpdateTieringConfigurationCommandInput extends UpdateTieringConfigurationInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateTieringConfigurationCommand}.
21
+ */
22
+ export interface UpdateTieringConfigurationCommandOutput extends UpdateTieringConfigurationOutput, __MetadataBearer {
23
+ }
24
+ declare const UpdateTieringConfigurationCommand_base: {
25
+ new (input: UpdateTieringConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateTieringConfigurationCommandInput, UpdateTieringConfigurationCommandOutput, BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: UpdateTieringConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateTieringConfigurationCommandInput, UpdateTieringConfigurationCommandOutput, BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>This request will send changes to your specified tiering
31
+ * configuration. <code>TieringConfigurationName</code>
32
+ * cannot be updated after it is created.</p>
33
+ * <p>
34
+ * <code>ResourceSelection</code> can contain:</p>
35
+ * <ul>
36
+ * <li>
37
+ * <p>
38
+ * <code>Resources</code>
39
+ * </p>
40
+ * </li>
41
+ * <li>
42
+ * <p>
43
+ * <code>TieringDownSettingsInDays</code>
44
+ * </p>
45
+ * </li>
46
+ * <li>
47
+ * <p>
48
+ * <code>ResourceType</code>
49
+ * </p>
50
+ * </li>
51
+ * </ul>
52
+ * @example
53
+ * Use a bare-bones client and the command you need to make an API call.
54
+ * ```javascript
55
+ * import { BackupClient, UpdateTieringConfigurationCommand } from "@aws-sdk/client-backup"; // ES Modules import
56
+ * // const { BackupClient, UpdateTieringConfigurationCommand } = require("@aws-sdk/client-backup"); // CommonJS import
57
+ * // import type { BackupClientConfig } from "@aws-sdk/client-backup";
58
+ * const config = {}; // type is BackupClientConfig
59
+ * const client = new BackupClient(config);
60
+ * const input = { // UpdateTieringConfigurationInput
61
+ * TieringConfigurationName: "STRING_VALUE", // required
62
+ * TieringConfiguration: { // TieringConfigurationInputForUpdate
63
+ * ResourceSelection: [ // ResourceSelections // required
64
+ * { // ResourceSelection
65
+ * Resources: [ // ResourceArns // required
66
+ * "STRING_VALUE",
67
+ * ],
68
+ * TieringDownSettingsInDays: Number("int"), // required
69
+ * ResourceType: "STRING_VALUE", // required
70
+ * },
71
+ * ],
72
+ * BackupVaultName: "STRING_VALUE", // required
73
+ * },
74
+ * };
75
+ * const command = new UpdateTieringConfigurationCommand(input);
76
+ * const response = await client.send(command);
77
+ * // { // UpdateTieringConfigurationOutput
78
+ * // TieringConfigurationArn: "STRING_VALUE",
79
+ * // TieringConfigurationName: "STRING_VALUE",
80
+ * // CreationTime: new Date("TIMESTAMP"),
81
+ * // LastUpdatedTime: new Date("TIMESTAMP"),
82
+ * // };
83
+ *
84
+ * ```
85
+ *
86
+ * @param UpdateTieringConfigurationCommandInput - {@link UpdateTieringConfigurationCommandInput}
87
+ * @returns {@link UpdateTieringConfigurationCommandOutput}
88
+ * @see {@link UpdateTieringConfigurationCommandInput} for command's `input` shape.
89
+ * @see {@link UpdateTieringConfigurationCommandOutput} for command's `response` shape.
90
+ * @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
91
+ *
92
+ * @throws {@link AlreadyExistsException} (client fault)
93
+ * <p>The required resource already exists.</p>
94
+ *
95
+ * @throws {@link ConflictException} (client fault)
96
+ * <p>Backup can't perform the action that you requested until it finishes
97
+ * performing a previous action. Try again later.</p>
98
+ *
99
+ * @throws {@link InvalidParameterValueException} (client fault)
100
+ * <p>Indicates that something is wrong with a parameter's value. For example, the value is
101
+ * out of range.</p>
102
+ *
103
+ * @throws {@link LimitExceededException} (client fault)
104
+ * <p>A limit in the request has been exceeded; for example, a maximum number of items allowed
105
+ * in a request.</p>
106
+ *
107
+ * @throws {@link MissingParameterValueException} (client fault)
108
+ * <p>Indicates that a required parameter is missing.</p>
109
+ *
110
+ * @throws {@link ResourceNotFoundException} (client fault)
111
+ * <p>A resource that is required for the action doesn't exist.</p>
112
+ *
113
+ * @throws {@link ServiceUnavailableException} (server fault)
114
+ * <p>The request failed due to a temporary failure of the server.</p>
115
+ *
116
+ * @throws {@link BackupServiceException}
117
+ * <p>Base exception class for all service exceptions from Backup service.</p>
118
+ *
119
+ *
120
+ * @public
121
+ */
122
+ export declare class UpdateTieringConfigurationCommand extends UpdateTieringConfigurationCommand_base {
123
+ /** @internal type navigation helper, not in runtime. */
124
+ protected static __types: {
125
+ api: {
126
+ input: UpdateTieringConfigurationInput;
127
+ output: UpdateTieringConfigurationOutput;
128
+ };
129
+ sdk: {
130
+ input: UpdateTieringConfigurationCommandInput;
131
+ output: UpdateTieringConfigurationCommandOutput;
132
+ };
133
+ };
134
+ }
@@ -10,6 +10,7 @@ export * from "./CreateReportPlanCommand";
10
10
  export * from "./CreateRestoreAccessBackupVaultCommand";
11
11
  export * from "./CreateRestoreTestingPlanCommand";
12
12
  export * from "./CreateRestoreTestingSelectionCommand";
13
+ export * from "./CreateTieringConfigurationCommand";
13
14
  export * from "./DeleteBackupPlanCommand";
14
15
  export * from "./DeleteBackupSelectionCommand";
15
16
  export * from "./DeleteBackupVaultAccessPolicyCommand";
@@ -21,6 +22,7 @@ export * from "./DeleteRecoveryPointCommand";
21
22
  export * from "./DeleteReportPlanCommand";
22
23
  export * from "./DeleteRestoreTestingPlanCommand";
23
24
  export * from "./DeleteRestoreTestingSelectionCommand";
25
+ export * from "./DeleteTieringConfigurationCommand";
24
26
  export * from "./DescribeBackupJobCommand";
25
27
  export * from "./DescribeBackupVaultCommand";
26
28
  export * from "./DescribeCopyJobCommand";
@@ -32,6 +34,7 @@ export * from "./DescribeRegionSettingsCommand";
32
34
  export * from "./DescribeReportJobCommand";
33
35
  export * from "./DescribeReportPlanCommand";
34
36
  export * from "./DescribeRestoreJobCommand";
37
+ export * from "./DescribeScanJobCommand";
35
38
  export * from "./DisassociateBackupVaultMpaApprovalTeamCommand";
36
39
  export * from "./DisassociateRecoveryPointCommand";
37
40
  export * from "./DisassociateRecoveryPointFromParentCommand";
@@ -50,6 +53,7 @@ export * from "./GetRestoreTestingInferredMetadataCommand";
50
53
  export * from "./GetRestoreTestingPlanCommand";
51
54
  export * from "./GetRestoreTestingSelectionCommand";
52
55
  export * from "./GetSupportedResourceTypesCommand";
56
+ export * from "./GetTieringConfigurationCommand";
53
57
  export * from "./ListBackupJobSummariesCommand";
54
58
  export * from "./ListBackupJobsCommand";
55
59
  export * from "./ListBackupPlanTemplatesCommand";
@@ -75,7 +79,10 @@ export * from "./ListRestoreJobsByProtectedResourceCommand";
75
79
  export * from "./ListRestoreJobsCommand";
76
80
  export * from "./ListRestoreTestingPlansCommand";
77
81
  export * from "./ListRestoreTestingSelectionsCommand";
82
+ export * from "./ListScanJobSummariesCommand";
83
+ export * from "./ListScanJobsCommand";
78
84
  export * from "./ListTagsCommand";
85
+ export * from "./ListTieringConfigurationsCommand";
79
86
  export * from "./PutBackupVaultAccessPolicyCommand";
80
87
  export * from "./PutBackupVaultLockConfigurationCommand";
81
88
  export * from "./PutBackupVaultNotificationsCommand";
@@ -85,6 +92,7 @@ export * from "./StartBackupJobCommand";
85
92
  export * from "./StartCopyJobCommand";
86
93
  export * from "./StartReportJobCommand";
87
94
  export * from "./StartRestoreJobCommand";
95
+ export * from "./StartScanJobCommand";
88
96
  export * from "./StopBackupJobCommand";
89
97
  export * from "./TagResourceCommand";
90
98
  export * from "./UntagResourceCommand";
@@ -97,3 +105,4 @@ export * from "./UpdateRegionSettingsCommand";
97
105
  export * from "./UpdateReportPlanCommand";
98
106
  export * from "./UpdateRestoreTestingPlanCommand";
99
107
  export * from "./UpdateRestoreTestingSelectionCommand";
108
+ export * from "./UpdateTieringConfigurationCommand";
@@ -14,5 +14,7 @@ export type { RuntimeExtension } from "./runtimeExtensions";
14
14
  export type { BackupExtensionConfiguration } from "./extensionConfiguration";
15
15
  export * from "./commands";
16
16
  export * from "./pagination";
17
- export * from "./models";
17
+ export * from "./models/enums";
18
+ export * from "./models/errors";
19
+ export type * from "./models/models_0";
18
20
  export { BackupServiceException } from "./models/BackupServiceException";