@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.
- package/README.md +72 -0
- package/dist-cjs/index.js +854 -197
- package/dist-es/Backup.js +18 -0
- package/dist-es/commands/CreateTieringConfigurationCommand.js +16 -0
- package/dist-es/commands/DeleteTieringConfigurationCommand.js +16 -0
- package/dist-es/commands/DescribeScanJobCommand.js +16 -0
- package/dist-es/commands/GetTieringConfigurationCommand.js +16 -0
- package/dist-es/commands/ListScanJobSummariesCommand.js +16 -0
- package/dist-es/commands/ListScanJobsCommand.js +16 -0
- package/dist-es/commands/ListTieringConfigurationsCommand.js +16 -0
- package/dist-es/commands/StartScanJobCommand.js +16 -0
- package/dist-es/commands/UpdateTieringConfigurationCommand.js +16 -0
- package/dist-es/commands/index.js +9 -0
- package/dist-es/index.js +2 -1
- package/dist-es/models/enums.js +215 -0
- package/dist-es/models/errors.js +205 -0
- package/dist-es/models/models_0.js +1 -377
- package/dist-es/pagination/ListScanJobSummariesPaginator.js +4 -0
- package/dist-es/pagination/ListScanJobsPaginator.js +4 -0
- package/dist-es/pagination/ListTieringConfigurationsPaginator.js +4 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/schemas/schemas_0.js +490 -19
- package/dist-types/Backup.d.ts +66 -0
- package/dist-types/BackupClient.d.ts +11 -2
- package/dist-types/commands/CreateBackupPlanCommand.d.ts +15 -0
- package/dist-types/commands/CreateTieringConfigurationCommand.d.ts +115 -0
- package/dist-types/commands/DeleteTieringConfigurationCommand.d.ts +85 -0
- package/dist-types/commands/DescribeRecoveryPointCommand.d.ts +10 -0
- package/dist-types/commands/DescribeScanJobCommand.d.ts +113 -0
- package/dist-types/commands/GetBackupPlanCommand.d.ts +15 -0
- package/dist-types/commands/GetBackupPlanFromJSONCommand.d.ts +15 -0
- package/dist-types/commands/GetBackupPlanFromTemplateCommand.d.ts +15 -0
- package/dist-types/commands/GetTieringConfigurationCommand.d.ts +105 -0
- package/dist-types/commands/ListRecoveryPointsByBackupVaultCommand.d.ts +7 -0
- package/dist-types/commands/ListRecoveryPointsByResourceCommand.d.ts +7 -0
- package/dist-types/commands/ListScanJobSummariesCommand.d.ts +102 -0
- package/dist-types/commands/ListScanJobsCommand.d.ts +123 -0
- package/dist-types/commands/ListTieringConfigurationsCommand.d.ts +91 -0
- package/dist-types/commands/StartScanJobCommand.d.ts +103 -0
- package/dist-types/commands/UpdateBackupPlanCommand.d.ts +24 -0
- package/dist-types/commands/UpdateTieringConfigurationCommand.d.ts +134 -0
- package/dist-types/commands/index.d.ts +9 -0
- package/dist-types/index.d.ts +3 -1
- package/dist-types/models/enums.d.ts +479 -0
- package/dist-types/models/errors.d.ts +257 -0
- package/dist-types/models/models_0.d.ts +1231 -723
- package/dist-types/pagination/ListScanJobSummariesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListScanJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListTieringConfigurationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/schemas/schemas_0.d.ts +48 -0
- package/dist-types/ts3.4/Backup.d.ts +156 -0
- package/dist-types/ts3.4/BackupClient.d.ts +56 -2
- package/dist-types/ts3.4/commands/CreateTieringConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteTieringConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeScanJobCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetTieringConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListScanJobSummariesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListScanJobsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListTieringConfigurationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartScanJobCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateTieringConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +3 -1
- package/dist-types/ts3.4/models/enums.d.ts +268 -0
- package/dist-types/ts3.4/models/errors.d.ts +112 -0
- package/dist-types/ts3.4/models/models_0.d.ts +243 -324
- package/dist-types/ts3.4/pagination/ListScanJobSummariesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListScanJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListTieringConfigurationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +48 -0
- package/package.json +12 -12
- package/dist-es/models/index.js +0 -1
- package/dist-types/models/index.d.ts +0 -1
- package/dist-types/ts3.4/models/index.d.ts +0 -1
|
@@ -85,6 +85,12 @@ declare const GetBackupPlanCommand_base: {
|
|
|
85
85
|
* // ],
|
|
86
86
|
* // },
|
|
87
87
|
* // ],
|
|
88
|
+
* // ScanActions: [ // ScanActions
|
|
89
|
+
* // { // ScanAction
|
|
90
|
+
* // MalwareScanner: "GUARDDUTY",
|
|
91
|
+
* // ScanMode: "FULL_SCAN" || "INCREMENTAL_SCAN",
|
|
92
|
+
* // },
|
|
93
|
+
* // ],
|
|
88
94
|
* // },
|
|
89
95
|
* // ],
|
|
90
96
|
* // AdvancedBackupSettings: [ // AdvancedBackupSettings
|
|
@@ -95,6 +101,15 @@ declare const GetBackupPlanCommand_base: {
|
|
|
95
101
|
* // },
|
|
96
102
|
* // },
|
|
97
103
|
* // ],
|
|
104
|
+
* // ScanSettings: [ // ScanSettings
|
|
105
|
+
* // { // ScanSetting
|
|
106
|
+
* // MalwareScanner: "GUARDDUTY",
|
|
107
|
+
* // ResourceTypes: [
|
|
108
|
+
* // "STRING_VALUE",
|
|
109
|
+
* // ],
|
|
110
|
+
* // ScannerRoleArn: "STRING_VALUE",
|
|
111
|
+
* // },
|
|
112
|
+
* // ],
|
|
98
113
|
* // },
|
|
99
114
|
* // BackupPlanId: "STRING_VALUE",
|
|
100
115
|
* // BackupPlanArn: "STRING_VALUE",
|
|
@@ -82,6 +82,12 @@ declare const GetBackupPlanFromJSONCommand_base: {
|
|
|
82
82
|
* // ],
|
|
83
83
|
* // },
|
|
84
84
|
* // ],
|
|
85
|
+
* // ScanActions: [ // ScanActions
|
|
86
|
+
* // { // ScanAction
|
|
87
|
+
* // MalwareScanner: "GUARDDUTY",
|
|
88
|
+
* // ScanMode: "FULL_SCAN" || "INCREMENTAL_SCAN",
|
|
89
|
+
* // },
|
|
90
|
+
* // ],
|
|
85
91
|
* // },
|
|
86
92
|
* // ],
|
|
87
93
|
* // AdvancedBackupSettings: [ // AdvancedBackupSettings
|
|
@@ -92,6 +98,15 @@ declare const GetBackupPlanFromJSONCommand_base: {
|
|
|
92
98
|
* // },
|
|
93
99
|
* // },
|
|
94
100
|
* // ],
|
|
101
|
+
* // ScanSettings: [ // ScanSettings
|
|
102
|
+
* // { // ScanSetting
|
|
103
|
+
* // MalwareScanner: "GUARDDUTY",
|
|
104
|
+
* // ResourceTypes: [
|
|
105
|
+
* // "STRING_VALUE",
|
|
106
|
+
* // ],
|
|
107
|
+
* // ScannerRoleArn: "STRING_VALUE",
|
|
108
|
+
* // },
|
|
109
|
+
* // ],
|
|
95
110
|
* // },
|
|
96
111
|
* // };
|
|
97
112
|
*
|
|
@@ -82,6 +82,12 @@ declare const GetBackupPlanFromTemplateCommand_base: {
|
|
|
82
82
|
* // ],
|
|
83
83
|
* // },
|
|
84
84
|
* // ],
|
|
85
|
+
* // ScanActions: [ // ScanActions
|
|
86
|
+
* // { // ScanAction
|
|
87
|
+
* // MalwareScanner: "GUARDDUTY",
|
|
88
|
+
* // ScanMode: "FULL_SCAN" || "INCREMENTAL_SCAN",
|
|
89
|
+
* // },
|
|
90
|
+
* // ],
|
|
85
91
|
* // },
|
|
86
92
|
* // ],
|
|
87
93
|
* // AdvancedBackupSettings: [ // AdvancedBackupSettings
|
|
@@ -92,6 +98,15 @@ declare const GetBackupPlanFromTemplateCommand_base: {
|
|
|
92
98
|
* // },
|
|
93
99
|
* // },
|
|
94
100
|
* // ],
|
|
101
|
+
* // ScanSettings: [ // ScanSettings
|
|
102
|
+
* // { // ScanSetting
|
|
103
|
+
* // MalwareScanner: "GUARDDUTY",
|
|
104
|
+
* // ResourceTypes: [
|
|
105
|
+
* // "STRING_VALUE",
|
|
106
|
+
* // ],
|
|
107
|
+
* // ScannerRoleArn: "STRING_VALUE",
|
|
108
|
+
* // },
|
|
109
|
+
* // ],
|
|
95
110
|
* // },
|
|
96
111
|
* // };
|
|
97
112
|
*
|
|
@@ -0,0 +1,105 @@
|
|
|
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 { GetTieringConfigurationInput, GetTieringConfigurationOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetTieringConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetTieringConfigurationCommandInput extends GetTieringConfigurationInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetTieringConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetTieringConfigurationCommandOutput extends GetTieringConfigurationOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetTieringConfigurationCommand_base: {
|
|
25
|
+
new (input: GetTieringConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetTieringConfigurationCommandInput, GetTieringConfigurationCommandOutput, BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetTieringConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetTieringConfigurationCommandInput, GetTieringConfigurationCommandOutput, BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns <code>TieringConfiguration</code> details for the specified
|
|
31
|
+
* <code>TieringConfigurationName</code>. The details are the body of a tiering configuration
|
|
32
|
+
* in JSON format, in addition to configuration metadata.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { BackupClient, GetTieringConfigurationCommand } from "@aws-sdk/client-backup"; // ES Modules import
|
|
37
|
+
* // const { BackupClient, GetTieringConfigurationCommand } = require("@aws-sdk/client-backup"); // CommonJS import
|
|
38
|
+
* // import type { BackupClientConfig } from "@aws-sdk/client-backup";
|
|
39
|
+
* const config = {}; // type is BackupClientConfig
|
|
40
|
+
* const client = new BackupClient(config);
|
|
41
|
+
* const input = { // GetTieringConfigurationInput
|
|
42
|
+
* TieringConfigurationName: "STRING_VALUE", // required
|
|
43
|
+
* };
|
|
44
|
+
* const command = new GetTieringConfigurationCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // GetTieringConfigurationOutput
|
|
47
|
+
* // TieringConfiguration: { // TieringConfiguration
|
|
48
|
+
* // TieringConfigurationName: "STRING_VALUE", // required
|
|
49
|
+
* // TieringConfigurationArn: "STRING_VALUE",
|
|
50
|
+
* // BackupVaultName: "STRING_VALUE", // required
|
|
51
|
+
* // ResourceSelection: [ // ResourceSelections // required
|
|
52
|
+
* // { // ResourceSelection
|
|
53
|
+
* // Resources: [ // ResourceArns // required
|
|
54
|
+
* // "STRING_VALUE",
|
|
55
|
+
* // ],
|
|
56
|
+
* // TieringDownSettingsInDays: Number("int"), // required
|
|
57
|
+
* // ResourceType: "STRING_VALUE", // required
|
|
58
|
+
* // },
|
|
59
|
+
* // ],
|
|
60
|
+
* // CreatorRequestId: "STRING_VALUE",
|
|
61
|
+
* // CreationTime: new Date("TIMESTAMP"),
|
|
62
|
+
* // LastUpdatedTime: new Date("TIMESTAMP"),
|
|
63
|
+
* // },
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* @param GetTieringConfigurationCommandInput - {@link GetTieringConfigurationCommandInput}
|
|
69
|
+
* @returns {@link GetTieringConfigurationCommandOutput}
|
|
70
|
+
* @see {@link GetTieringConfigurationCommandInput} for command's `input` shape.
|
|
71
|
+
* @see {@link GetTieringConfigurationCommandOutput} for command's `response` shape.
|
|
72
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
75
|
+
* <p>Indicates that something is wrong with a parameter's value. For example, the value is
|
|
76
|
+
* out of range.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link MissingParameterValueException} (client fault)
|
|
79
|
+
* <p>Indicates that a required parameter is missing.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
82
|
+
* <p>A resource that is required for the action doesn't exist.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
85
|
+
* <p>The request failed due to a temporary failure of the server.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link BackupServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from Backup service.</p>
|
|
89
|
+
*
|
|
90
|
+
*
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
export declare class GetTieringConfigurationCommand extends GetTieringConfigurationCommand_base {
|
|
94
|
+
/** @internal type navigation helper, not in runtime. */
|
|
95
|
+
protected static __types: {
|
|
96
|
+
api: {
|
|
97
|
+
input: GetTieringConfigurationInput;
|
|
98
|
+
output: GetTieringConfigurationOutput;
|
|
99
|
+
};
|
|
100
|
+
sdk: {
|
|
101
|
+
input: GetTieringConfigurationCommandInput;
|
|
102
|
+
output: GetTieringConfigurationCommandOutput;
|
|
103
|
+
};
|
|
104
|
+
};
|
|
105
|
+
}
|
|
@@ -98,6 +98,13 @@ declare const ListRecoveryPointsByBackupVaultCommand_base: {
|
|
|
98
98
|
* // IndexStatus: "PENDING" || "ACTIVE" || "FAILED" || "DELETING",
|
|
99
99
|
* // IndexStatusMessage: "STRING_VALUE",
|
|
100
100
|
* // EncryptionKeyType: "AWS_OWNED_KMS_KEY" || "CUSTOMER_MANAGED_KMS_KEY",
|
|
101
|
+
* // AggregatedScanResult: { // AggregatedScanResult
|
|
102
|
+
* // FailedScan: true || false,
|
|
103
|
+
* // Findings: [ // ScanFindings
|
|
104
|
+
* // "MALWARE",
|
|
105
|
+
* // ],
|
|
106
|
+
* // LastComputed: new Date("TIMESTAMP"),
|
|
107
|
+
* // },
|
|
101
108
|
* // },
|
|
102
109
|
* // ],
|
|
103
110
|
* // };
|
|
@@ -67,6 +67,13 @@ declare const ListRecoveryPointsByResourceCommand_base: {
|
|
|
67
67
|
* // IndexStatus: "PENDING" || "ACTIVE" || "FAILED" || "DELETING",
|
|
68
68
|
* // IndexStatusMessage: "STRING_VALUE",
|
|
69
69
|
* // EncryptionKeyType: "AWS_OWNED_KMS_KEY" || "CUSTOMER_MANAGED_KMS_KEY",
|
|
70
|
+
* // AggregatedScanResult: { // AggregatedScanResult
|
|
71
|
+
* // FailedScan: true || false,
|
|
72
|
+
* // Findings: [ // ScanFindings
|
|
73
|
+
* // "MALWARE",
|
|
74
|
+
* // ],
|
|
75
|
+
* // LastComputed: new Date("TIMESTAMP"),
|
|
76
|
+
* // },
|
|
70
77
|
* // },
|
|
71
78
|
* // ],
|
|
72
79
|
* // };
|
|
@@ -0,0 +1,102 @@
|
|
|
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 { ListScanJobSummariesInput, ListScanJobSummariesOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListScanJobSummariesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListScanJobSummariesCommandInput extends ListScanJobSummariesInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListScanJobSummariesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListScanJobSummariesCommandOutput extends ListScanJobSummariesOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListScanJobSummariesCommand_base: {
|
|
25
|
+
new (input: ListScanJobSummariesCommandInput): import("@smithy/smithy-client").CommandImpl<ListScanJobSummariesCommandInput, ListScanJobSummariesCommandOutput, BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListScanJobSummariesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListScanJobSummariesCommandInput, ListScanJobSummariesCommandOutput, BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>This is a request for a summary of scan jobs created or running within the most recent 30 days.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BackupClient, ListScanJobSummariesCommand } from "@aws-sdk/client-backup"; // ES Modules import
|
|
35
|
+
* // const { BackupClient, ListScanJobSummariesCommand } = require("@aws-sdk/client-backup"); // CommonJS import
|
|
36
|
+
* // import type { BackupClientConfig } from "@aws-sdk/client-backup";
|
|
37
|
+
* const config = {}; // type is BackupClientConfig
|
|
38
|
+
* const client = new BackupClient(config);
|
|
39
|
+
* const input = { // ListScanJobSummariesInput
|
|
40
|
+
* AccountId: "STRING_VALUE",
|
|
41
|
+
* ResourceType: "STRING_VALUE",
|
|
42
|
+
* MalwareScanner: "GUARDDUTY",
|
|
43
|
+
* ScanResultStatus: "NO_THREATS_FOUND" || "THREATS_FOUND",
|
|
44
|
+
* State: "CREATED" || "COMPLETED" || "COMPLETED_WITH_ISSUES" || "RUNNING" || "FAILED" || "CANCELED" || "AGGREGATE_ALL" || "ANY",
|
|
45
|
+
* AggregationPeriod: "ONE_DAY" || "SEVEN_DAYS" || "FOURTEEN_DAYS",
|
|
46
|
+
* MaxResults: Number("int"),
|
|
47
|
+
* NextToken: "STRING_VALUE",
|
|
48
|
+
* };
|
|
49
|
+
* const command = new ListScanJobSummariesCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* // { // ListScanJobSummariesOutput
|
|
52
|
+
* // ScanJobSummaries: [ // ScanJobSummaryList
|
|
53
|
+
* // { // ScanJobSummary
|
|
54
|
+
* // Region: "STRING_VALUE",
|
|
55
|
+
* // AccountId: "STRING_VALUE",
|
|
56
|
+
* // State: "CREATED" || "COMPLETED" || "COMPLETED_WITH_ISSUES" || "RUNNING" || "FAILED" || "CANCELED" || "AGGREGATE_ALL" || "ANY",
|
|
57
|
+
* // ResourceType: "STRING_VALUE",
|
|
58
|
+
* // Count: Number("int"),
|
|
59
|
+
* // StartTime: new Date("TIMESTAMP"),
|
|
60
|
+
* // EndTime: new Date("TIMESTAMP"),
|
|
61
|
+
* // MalwareScanner: "GUARDDUTY",
|
|
62
|
+
* // ScanResultStatus: "NO_THREATS_FOUND" || "THREATS_FOUND",
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // AggregationPeriod: "STRING_VALUE",
|
|
66
|
+
* // NextToken: "STRING_VALUE",
|
|
67
|
+
* // };
|
|
68
|
+
*
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
71
|
+
* @param ListScanJobSummariesCommandInput - {@link ListScanJobSummariesCommandInput}
|
|
72
|
+
* @returns {@link ListScanJobSummariesCommandOutput}
|
|
73
|
+
* @see {@link ListScanJobSummariesCommandInput} for command's `input` shape.
|
|
74
|
+
* @see {@link ListScanJobSummariesCommandOutput} for command's `response` shape.
|
|
75
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
78
|
+
* <p>Indicates that something is wrong with a parameter's value. For example, the value is
|
|
79
|
+
* out of range.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
82
|
+
* <p>The request failed due to a temporary failure of the server.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link BackupServiceException}
|
|
85
|
+
* <p>Base exception class for all service exceptions from Backup service.</p>
|
|
86
|
+
*
|
|
87
|
+
*
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
export declare class ListScanJobSummariesCommand extends ListScanJobSummariesCommand_base {
|
|
91
|
+
/** @internal type navigation helper, not in runtime. */
|
|
92
|
+
protected static __types: {
|
|
93
|
+
api: {
|
|
94
|
+
input: ListScanJobSummariesInput;
|
|
95
|
+
output: ListScanJobSummariesOutput;
|
|
96
|
+
};
|
|
97
|
+
sdk: {
|
|
98
|
+
input: ListScanJobSummariesCommandInput;
|
|
99
|
+
output: ListScanJobSummariesCommandOutput;
|
|
100
|
+
};
|
|
101
|
+
};
|
|
102
|
+
}
|
|
@@ -0,0 +1,123 @@
|
|
|
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 { ListScanJobsInput, ListScanJobsOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListScanJobsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListScanJobsCommandInput extends ListScanJobsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListScanJobsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListScanJobsCommandOutput extends ListScanJobsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListScanJobsCommand_base: {
|
|
25
|
+
new (input: ListScanJobsCommandInput): import("@smithy/smithy-client").CommandImpl<ListScanJobsCommandInput, ListScanJobsCommandOutput, BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListScanJobsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListScanJobsCommandInput, ListScanJobsCommandOutput, BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns a list of existing scan jobs for an authenticated account for the last 30 days.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BackupClient, ListScanJobsCommand } from "@aws-sdk/client-backup"; // ES Modules import
|
|
35
|
+
* // const { BackupClient, ListScanJobsCommand } = require("@aws-sdk/client-backup"); // CommonJS import
|
|
36
|
+
* // import type { BackupClientConfig } from "@aws-sdk/client-backup";
|
|
37
|
+
* const config = {}; // type is BackupClientConfig
|
|
38
|
+
* const client = new BackupClient(config);
|
|
39
|
+
* const input = { // ListScanJobsInput
|
|
40
|
+
* ByAccountId: "STRING_VALUE",
|
|
41
|
+
* ByBackupVaultName: "STRING_VALUE",
|
|
42
|
+
* ByCompleteAfter: new Date("TIMESTAMP"),
|
|
43
|
+
* ByCompleteBefore: new Date("TIMESTAMP"),
|
|
44
|
+
* ByMalwareScanner: "GUARDDUTY",
|
|
45
|
+
* ByRecoveryPointArn: "STRING_VALUE",
|
|
46
|
+
* ByResourceArn: "STRING_VALUE",
|
|
47
|
+
* ByResourceType: "EBS" || "EC2" || "S3",
|
|
48
|
+
* ByScanResultStatus: "NO_THREATS_FOUND" || "THREATS_FOUND",
|
|
49
|
+
* ByState: "CANCELED" || "COMPLETED" || "COMPLETED_WITH_ISSUES" || "CREATED" || "FAILED" || "RUNNING",
|
|
50
|
+
* MaxResults: Number("int"),
|
|
51
|
+
* NextToken: "STRING_VALUE",
|
|
52
|
+
* };
|
|
53
|
+
* const command = new ListScanJobsCommand(input);
|
|
54
|
+
* const response = await client.send(command);
|
|
55
|
+
* // { // ListScanJobsOutput
|
|
56
|
+
* // NextToken: "STRING_VALUE",
|
|
57
|
+
* // ScanJobs: [ // ScanJobs // required
|
|
58
|
+
* // { // ScanJob
|
|
59
|
+
* // AccountId: "STRING_VALUE", // required
|
|
60
|
+
* // BackupVaultArn: "STRING_VALUE", // required
|
|
61
|
+
* // BackupVaultName: "STRING_VALUE", // required
|
|
62
|
+
* // CompletionDate: new Date("TIMESTAMP"),
|
|
63
|
+
* // CreatedBy: { // ScanJobCreator
|
|
64
|
+
* // BackupPlanArn: "STRING_VALUE", // required
|
|
65
|
+
* // BackupPlanId: "STRING_VALUE", // required
|
|
66
|
+
* // BackupPlanVersion: "STRING_VALUE", // required
|
|
67
|
+
* // BackupRuleId: "STRING_VALUE", // required
|
|
68
|
+
* // },
|
|
69
|
+
* // CreationDate: new Date("TIMESTAMP"), // required
|
|
70
|
+
* // IamRoleArn: "STRING_VALUE", // required
|
|
71
|
+
* // MalwareScanner: "GUARDDUTY", // required
|
|
72
|
+
* // RecoveryPointArn: "STRING_VALUE", // required
|
|
73
|
+
* // ResourceArn: "STRING_VALUE", // required
|
|
74
|
+
* // ResourceName: "STRING_VALUE", // required
|
|
75
|
+
* // ResourceType: "EBS" || "EC2" || "S3", // required
|
|
76
|
+
* // ScanBaseRecoveryPointArn: "STRING_VALUE",
|
|
77
|
+
* // ScanId: "STRING_VALUE",
|
|
78
|
+
* // ScanJobId: "STRING_VALUE", // required
|
|
79
|
+
* // ScanMode: "FULL_SCAN" || "INCREMENTAL_SCAN", // required
|
|
80
|
+
* // ScanResult: { // ScanResultInfo
|
|
81
|
+
* // ScanResultStatus: "NO_THREATS_FOUND" || "THREATS_FOUND", // required
|
|
82
|
+
* // },
|
|
83
|
+
* // ScannerRoleArn: "STRING_VALUE", // required
|
|
84
|
+
* // State: "CANCELED" || "COMPLETED" || "COMPLETED_WITH_ISSUES" || "CREATED" || "FAILED" || "RUNNING",
|
|
85
|
+
* // StatusMessage: "STRING_VALUE",
|
|
86
|
+
* // },
|
|
87
|
+
* // ],
|
|
88
|
+
* // };
|
|
89
|
+
*
|
|
90
|
+
* ```
|
|
91
|
+
*
|
|
92
|
+
* @param ListScanJobsCommandInput - {@link ListScanJobsCommandInput}
|
|
93
|
+
* @returns {@link ListScanJobsCommandOutput}
|
|
94
|
+
* @see {@link ListScanJobsCommandInput} for command's `input` shape.
|
|
95
|
+
* @see {@link ListScanJobsCommandOutput} for command's `response` shape.
|
|
96
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
99
|
+
* <p>Indicates that something is wrong with a parameter's value. For example, the value is
|
|
100
|
+
* out of range.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
103
|
+
* <p>The request failed due to a temporary failure of the server.</p>
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link BackupServiceException}
|
|
106
|
+
* <p>Base exception class for all service exceptions from Backup service.</p>
|
|
107
|
+
*
|
|
108
|
+
*
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
export declare class ListScanJobsCommand extends ListScanJobsCommand_base {
|
|
112
|
+
/** @internal type navigation helper, not in runtime. */
|
|
113
|
+
protected static __types: {
|
|
114
|
+
api: {
|
|
115
|
+
input: ListScanJobsInput;
|
|
116
|
+
output: ListScanJobsOutput;
|
|
117
|
+
};
|
|
118
|
+
sdk: {
|
|
119
|
+
input: ListScanJobsCommandInput;
|
|
120
|
+
output: ListScanJobsCommandOutput;
|
|
121
|
+
};
|
|
122
|
+
};
|
|
123
|
+
}
|
|
@@ -0,0 +1,91 @@
|
|
|
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 { ListTieringConfigurationsInput, ListTieringConfigurationsOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListTieringConfigurationsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListTieringConfigurationsCommandInput extends ListTieringConfigurationsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListTieringConfigurationsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListTieringConfigurationsCommandOutput extends ListTieringConfigurationsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListTieringConfigurationsCommand_base: {
|
|
25
|
+
new (input: ListTieringConfigurationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListTieringConfigurationsCommandInput, ListTieringConfigurationsCommandOutput, BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListTieringConfigurationsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListTieringConfigurationsCommandInput, ListTieringConfigurationsCommandOutput, BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns a list of tiering configurations.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BackupClient, ListTieringConfigurationsCommand } from "@aws-sdk/client-backup"; // ES Modules import
|
|
35
|
+
* // const { BackupClient, ListTieringConfigurationsCommand } = require("@aws-sdk/client-backup"); // CommonJS import
|
|
36
|
+
* // import type { BackupClientConfig } from "@aws-sdk/client-backup";
|
|
37
|
+
* const config = {}; // type is BackupClientConfig
|
|
38
|
+
* const client = new BackupClient(config);
|
|
39
|
+
* const input = { // ListTieringConfigurationsInput
|
|
40
|
+
* MaxResults: Number("int"),
|
|
41
|
+
* NextToken: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListTieringConfigurationsCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListTieringConfigurationsOutput
|
|
46
|
+
* // TieringConfigurations: [ // TieringConfigurationsList
|
|
47
|
+
* // { // TieringConfigurationsListMember
|
|
48
|
+
* // TieringConfigurationArn: "STRING_VALUE",
|
|
49
|
+
* // TieringConfigurationName: "STRING_VALUE",
|
|
50
|
+
* // BackupVaultName: "STRING_VALUE",
|
|
51
|
+
* // CreationTime: new Date("TIMESTAMP"),
|
|
52
|
+
* // LastUpdatedTime: new Date("TIMESTAMP"),
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // NextToken: "STRING_VALUE",
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @param ListTieringConfigurationsCommandInput - {@link ListTieringConfigurationsCommandInput}
|
|
61
|
+
* @returns {@link ListTieringConfigurationsCommandOutput}
|
|
62
|
+
* @see {@link ListTieringConfigurationsCommandInput} for command's `input` shape.
|
|
63
|
+
* @see {@link ListTieringConfigurationsCommandOutput} for command's `response` shape.
|
|
64
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
67
|
+
* <p>Indicates that something is wrong with a parameter's value. For example, the value is
|
|
68
|
+
* out of range.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
71
|
+
* <p>The request failed due to a temporary failure of the server.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link BackupServiceException}
|
|
74
|
+
* <p>Base exception class for all service exceptions from Backup service.</p>
|
|
75
|
+
*
|
|
76
|
+
*
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
export declare class ListTieringConfigurationsCommand extends ListTieringConfigurationsCommand_base {
|
|
80
|
+
/** @internal type navigation helper, not in runtime. */
|
|
81
|
+
protected static __types: {
|
|
82
|
+
api: {
|
|
83
|
+
input: ListTieringConfigurationsInput;
|
|
84
|
+
output: ListTieringConfigurationsOutput;
|
|
85
|
+
};
|
|
86
|
+
sdk: {
|
|
87
|
+
input: ListTieringConfigurationsCommandInput;
|
|
88
|
+
output: ListTieringConfigurationsCommandOutput;
|
|
89
|
+
};
|
|
90
|
+
};
|
|
91
|
+
}
|
|
@@ -0,0 +1,103 @@
|
|
|
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 { StartScanJobInput, StartScanJobOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link StartScanJobCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface StartScanJobCommandInput extends StartScanJobInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link StartScanJobCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface StartScanJobCommandOutput extends StartScanJobOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const StartScanJobCommand_base: {
|
|
25
|
+
new (input: StartScanJobCommandInput): import("@smithy/smithy-client").CommandImpl<StartScanJobCommandInput, StartScanJobCommandOutput, BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: StartScanJobCommandInput): import("@smithy/smithy-client").CommandImpl<StartScanJobCommandInput, StartScanJobCommandOutput, BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Starts scanning jobs for specific resources.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BackupClient, StartScanJobCommand } from "@aws-sdk/client-backup"; // ES Modules import
|
|
35
|
+
* // const { BackupClient, StartScanJobCommand } = require("@aws-sdk/client-backup"); // CommonJS import
|
|
36
|
+
* // import type { BackupClientConfig } from "@aws-sdk/client-backup";
|
|
37
|
+
* const config = {}; // type is BackupClientConfig
|
|
38
|
+
* const client = new BackupClient(config);
|
|
39
|
+
* const input = { // StartScanJobInput
|
|
40
|
+
* BackupVaultName: "STRING_VALUE", // required
|
|
41
|
+
* IamRoleArn: "STRING_VALUE", // required
|
|
42
|
+
* IdempotencyToken: "STRING_VALUE",
|
|
43
|
+
* MalwareScanner: "GUARDDUTY", // required
|
|
44
|
+
* RecoveryPointArn: "STRING_VALUE", // required
|
|
45
|
+
* ScanBaseRecoveryPointArn: "STRING_VALUE",
|
|
46
|
+
* ScanMode: "FULL_SCAN" || "INCREMENTAL_SCAN", // required
|
|
47
|
+
* ScannerRoleArn: "STRING_VALUE", // required
|
|
48
|
+
* };
|
|
49
|
+
* const command = new StartScanJobCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* // { // StartScanJobOutput
|
|
52
|
+
* // CreationDate: new Date("TIMESTAMP"), // required
|
|
53
|
+
* // ScanJobId: "STRING_VALUE", // required
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param StartScanJobCommandInput - {@link StartScanJobCommandInput}
|
|
59
|
+
* @returns {@link StartScanJobCommandOutput}
|
|
60
|
+
* @see {@link StartScanJobCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link StartScanJobCommandOutput} for command's `response` shape.
|
|
62
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
65
|
+
* <p>Indicates that something is wrong with a parameter's value. For example, the value is
|
|
66
|
+
* out of range.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
69
|
+
* <p>Indicates that something is wrong with the input to the request. For example, a
|
|
70
|
+
* parameter is of the wrong type.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
73
|
+
* <p>A limit in the request has been exceeded; for example, a maximum number of items allowed
|
|
74
|
+
* in a request.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link MissingParameterValueException} (client fault)
|
|
77
|
+
* <p>Indicates that a required parameter is missing.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
80
|
+
* <p>A resource that is required for the action doesn't exist.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
83
|
+
* <p>The request failed due to a temporary failure of the server.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link BackupServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from Backup service.</p>
|
|
87
|
+
*
|
|
88
|
+
*
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
export declare class StartScanJobCommand extends StartScanJobCommand_base {
|
|
92
|
+
/** @internal type navigation helper, not in runtime. */
|
|
93
|
+
protected static __types: {
|
|
94
|
+
api: {
|
|
95
|
+
input: StartScanJobInput;
|
|
96
|
+
output: StartScanJobOutput;
|
|
97
|
+
};
|
|
98
|
+
sdk: {
|
|
99
|
+
input: StartScanJobCommandInput;
|
|
100
|
+
output: StartScanJobCommandOutput;
|
|
101
|
+
};
|
|
102
|
+
};
|
|
103
|
+
}
|