@aws-sdk/client-datasync 3.319.0 → 3.320.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 +113 -8
- package/dist-cjs/DataSync.js +26 -0
- package/dist-cjs/commands/AddStorageSystemCommand.js +46 -0
- package/dist-cjs/commands/DescribeDiscoveryJobCommand.js +45 -0
- package/dist-cjs/commands/DescribeStorageSystemCommand.js +45 -0
- package/dist-cjs/commands/DescribeStorageSystemResourceMetricsCommand.js +45 -0
- package/dist-cjs/commands/DescribeStorageSystemResourcesCommand.js +45 -0
- package/dist-cjs/commands/GenerateRecommendationsCommand.js +45 -0
- package/dist-cjs/commands/ListDiscoveryJobsCommand.js +45 -0
- package/dist-cjs/commands/ListStorageSystemsCommand.js +45 -0
- package/dist-cjs/commands/RemoveStorageSystemCommand.js +45 -0
- package/dist-cjs/commands/StartDiscoveryJobCommand.js +45 -0
- package/dist-cjs/commands/StopDiscoveryJobCommand.js +45 -0
- package/dist-cjs/commands/UpdateDiscoveryJobCommand.js +45 -0
- package/dist-cjs/commands/UpdateStorageSystemCommand.js +46 -0
- package/dist-cjs/commands/index.js +13 -0
- package/dist-cjs/models/models_0.js +56 -8
- package/dist-cjs/pagination/DescribeStorageSystemResourceMetricsPaginator.js +29 -0
- package/dist-cjs/pagination/DescribeStorageSystemResourcesPaginator.js +29 -0
- package/dist-cjs/pagination/ListDiscoveryJobsPaginator.js +29 -0
- package/dist-cjs/pagination/ListStorageSystemsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +4 -0
- package/dist-cjs/protocols/Aws_json1_1.js +948 -87
- package/dist-es/DataSync.js +26 -0
- package/dist-es/commands/AddStorageSystemCommand.js +42 -0
- package/dist-es/commands/DescribeDiscoveryJobCommand.js +41 -0
- package/dist-es/commands/DescribeStorageSystemCommand.js +41 -0
- package/dist-es/commands/DescribeStorageSystemResourceMetricsCommand.js +41 -0
- package/dist-es/commands/DescribeStorageSystemResourcesCommand.js +41 -0
- package/dist-es/commands/GenerateRecommendationsCommand.js +41 -0
- package/dist-es/commands/ListDiscoveryJobsCommand.js +41 -0
- package/dist-es/commands/ListStorageSystemsCommand.js +41 -0
- package/dist-es/commands/RemoveStorageSystemCommand.js +41 -0
- package/dist-es/commands/StartDiscoveryJobCommand.js +41 -0
- package/dist-es/commands/StopDiscoveryJobCommand.js +41 -0
- package/dist-es/commands/UpdateDiscoveryJobCommand.js +41 -0
- package/dist-es/commands/UpdateStorageSystemCommand.js +42 -0
- package/dist-es/commands/index.js +13 -0
- package/dist-es/models/models_0.js +51 -7
- package/dist-es/pagination/DescribeStorageSystemResourceMetricsPaginator.js +25 -0
- package/dist-es/pagination/DescribeStorageSystemResourcesPaginator.js +25 -0
- package/dist-es/pagination/ListDiscoveryJobsPaginator.js +25 -0
- package/dist-es/pagination/ListStorageSystemsPaginator.js +25 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_json1_1.js +908 -74
- package/dist-types/DataSync.d.ts +94 -2
- package/dist-types/DataSyncClient.d.ts +18 -4
- package/dist-types/commands/AddStorageSystemCommand.d.ts +91 -0
- package/dist-types/commands/CancelTaskExecutionCommand.d.ts +4 -3
- package/dist-types/commands/CreateAgentCommand.d.ts +4 -3
- package/dist-types/commands/CreateLocationEfsCommand.d.ts +2 -1
- package/dist-types/commands/CreateLocationFsxLustreCommand.d.ts +2 -1
- package/dist-types/commands/CreateLocationFsxOntapCommand.d.ts +3 -3
- package/dist-types/commands/CreateLocationFsxOpenZfsCommand.d.ts +4 -4
- package/dist-types/commands/CreateLocationFsxWindowsCommand.d.ts +2 -1
- package/dist-types/commands/CreateLocationHdfsCommand.d.ts +2 -1
- package/dist-types/commands/CreateLocationNfsCommand.d.ts +2 -1
- package/dist-types/commands/CreateLocationObjectStorageCommand.d.ts +5 -2
- package/dist-types/commands/CreateLocationS3Command.d.ts +20 -3
- package/dist-types/commands/CreateLocationSmbCommand.d.ts +2 -1
- package/dist-types/commands/CreateTaskCommand.d.ts +8 -1
- package/dist-types/commands/DeleteAgentCommand.d.ts +4 -4
- package/dist-types/commands/DeleteLocationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteTaskCommand.d.ts +2 -1
- package/dist-types/commands/DescribeAgentCommand.d.ts +4 -2
- package/dist-types/commands/DescribeDiscoveryJobCommand.d.ts +70 -0
- package/dist-types/commands/DescribeLocationEfsCommand.d.ts +4 -2
- package/dist-types/commands/DescribeLocationFsxLustreCommand.d.ts +2 -1
- package/dist-types/commands/DescribeLocationFsxOntapCommand.d.ts +2 -1
- package/dist-types/commands/DescribeLocationFsxOpenZfsCommand.d.ts +3 -2
- package/dist-types/commands/DescribeLocationFsxWindowsCommand.d.ts +4 -3
- package/dist-types/commands/DescribeLocationHdfsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeLocationNfsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeLocationObjectStorageCommand.d.ts +4 -2
- package/dist-types/commands/DescribeLocationS3Command.d.ts +2 -1
- package/dist-types/commands/DescribeLocationSmbCommand.d.ts +2 -1
- package/dist-types/commands/DescribeStorageSystemCommand.d.ts +71 -0
- package/dist-types/commands/DescribeStorageSystemResourceMetricsCommand.d.ts +77 -0
- package/dist-types/commands/DescribeStorageSystemResourcesCommand.d.ts +82 -0
- package/dist-types/commands/DescribeTaskCommand.d.ts +2 -1
- package/dist-types/commands/DescribeTaskExecutionCommand.d.ts +2 -1
- package/dist-types/commands/GenerateRecommendationsCommand.d.ts +82 -0
- package/dist-types/commands/ListAgentsCommand.d.ts +2 -1
- package/dist-types/commands/ListDiscoveryJobsCommand.d.ts +73 -0
- package/dist-types/commands/ListLocationsCommand.d.ts +2 -1
- package/dist-types/commands/ListStorageSystemsCommand.d.ts +71 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListTaskExecutionsCommand.d.ts +2 -1
- package/dist-types/commands/ListTasksCommand.d.ts +2 -1
- package/dist-types/commands/RemoveStorageSystemCommand.d.ts +71 -0
- package/dist-types/commands/StartDiscoveryJobCommand.d.ts +80 -0
- package/dist-types/commands/StartTaskExecutionCommand.d.ts +10 -2
- package/dist-types/commands/StopDiscoveryJobCommand.d.ts +73 -0
- package/dist-types/commands/TagResourceCommand.d.ts +6 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAgentCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDiscoveryJobCommand.d.ts +71 -0
- package/dist-types/commands/UpdateLocationHdfsCommand.d.ts +2 -1
- package/dist-types/commands/UpdateLocationNfsCommand.d.ts +5 -3
- package/dist-types/commands/UpdateLocationObjectStorageCommand.d.ts +2 -1
- package/dist-types/commands/UpdateLocationSmbCommand.d.ts +4 -3
- package/dist-types/commands/UpdateStorageSystemCommand.d.ts +84 -0
- package/dist-types/commands/UpdateTaskCommand.d.ts +2 -1
- package/dist-types/commands/UpdateTaskExecutionCommand.d.ts +7 -7
- package/dist-types/commands/index.d.ts +13 -0
- package/dist-types/models/models_0.d.ts +1429 -296
- package/dist-types/pagination/DescribeStorageSystemResourceMetricsPaginator.d.ts +7 -0
- package/dist-types/pagination/DescribeStorageSystemResourcesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDiscoveryJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListStorageSystemsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +117 -0
- package/dist-types/ts3.4/DataSync.d.ts +227 -0
- package/dist-types/ts3.4/DataSyncClient.d.ts +78 -0
- package/dist-types/ts3.4/commands/AddStorageSystemCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/DescribeDiscoveryJobCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DescribeStorageSystemCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DescribeStorageSystemResourceMetricsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DescribeStorageSystemResourcesCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GenerateRecommendationsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListDiscoveryJobsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListStorageSystemsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/RemoveStorageSystemCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/StartDiscoveryJobCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/StopDiscoveryJobCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/UpdateDiscoveryJobCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateStorageSystemCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +13 -0
- package/dist-types/ts3.4/models/models_0.d.ts +302 -18
- package/dist-types/ts3.4/pagination/DescribeStorageSystemResourceMetricsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/DescribeStorageSystemResourcesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListDiscoveryJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListStorageSystemsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +156 -0
- package/package.json +4 -2
|
@@ -24,6 +24,12 @@ export interface CreateTaskCommandOutput extends CreateTaskResponse, __MetadataB
|
|
|
24
24
|
* <p>A task includes a source location, a destination location, and the preferences for how and
|
|
25
25
|
* when you want to transfer your data (such as bandwidth limits, scheduling, among other
|
|
26
26
|
* options).</p>
|
|
27
|
+
* <important>
|
|
28
|
+
* <p>If you're planning to transfer data to or from an Amazon S3 location, review
|
|
29
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests">how
|
|
30
|
+
* DataSync can affect your S3 request charges</a> and the <a href="http://aws.amazon.com/datasync/pricing/">DataSync pricing page</a> before
|
|
31
|
+
* you begin.</p>
|
|
32
|
+
* </important>
|
|
27
33
|
* @example
|
|
28
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
35
|
* ```javascript
|
|
@@ -85,7 +91,8 @@ export interface CreateTaskCommandOutput extends CreateTaskResponse, __MetadataB
|
|
|
85
91
|
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
86
92
|
*
|
|
87
93
|
* @throws {@link InternalException} (server fault)
|
|
88
|
-
* <p>This exception is thrown when an error occurs in the DataSync
|
|
94
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
95
|
+
* service.</p>
|
|
89
96
|
*
|
|
90
97
|
* @throws {@link InvalidRequestException} (client fault)
|
|
91
98
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
@@ -20,9 +20,8 @@ export interface DeleteAgentCommandOutput extends DeleteAgentResponse, __Metadat
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN)
|
|
23
|
-
* of the agent in your request. The operation disassociates the agent from your Amazon Web Services account.
|
|
24
|
-
*
|
|
25
|
-
* environment.</p>
|
|
23
|
+
* of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your
|
|
24
|
+
* on-premises environment.</p>
|
|
26
25
|
* @example
|
|
27
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
27
|
* ```javascript
|
|
@@ -43,7 +42,8 @@ export interface DeleteAgentCommandOutput extends DeleteAgentResponse, __Metadat
|
|
|
43
42
|
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
44
43
|
*
|
|
45
44
|
* @throws {@link InternalException} (server fault)
|
|
46
|
-
* <p>This exception is thrown when an error occurs in the DataSync
|
|
45
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
46
|
+
* service.</p>
|
|
47
47
|
*
|
|
48
48
|
* @throws {@link InvalidRequestException} (client fault)
|
|
49
49
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
@@ -40,7 +40,8 @@ export interface DeleteLocationCommandOutput extends DeleteLocationResponse, __M
|
|
|
40
40
|
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
41
41
|
*
|
|
42
42
|
* @throws {@link InternalException} (server fault)
|
|
43
|
-
* <p>This exception is thrown when an error occurs in the DataSync
|
|
43
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
44
|
+
* service.</p>
|
|
44
45
|
*
|
|
45
46
|
* @throws {@link InvalidRequestException} (client fault)
|
|
46
47
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
@@ -40,7 +40,8 @@ export interface DeleteTaskCommandOutput extends DeleteTaskResponse, __MetadataB
|
|
|
40
40
|
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
41
41
|
*
|
|
42
42
|
* @throws {@link InternalException} (server fault)
|
|
43
|
-
* <p>This exception is thrown when an error occurs in the DataSync
|
|
43
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
44
|
+
* service.</p>
|
|
44
45
|
*
|
|
45
46
|
* @throws {@link InvalidRequestException} (client fault)
|
|
46
47
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
@@ -19,7 +19,8 @@ export interface DescribeAgentCommandOutput extends DescribeAgentResponse, __Met
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Returns metadata about an DataSync agent, such as its name, endpoint
|
|
22
|
+
* <p>Returns metadata about an DataSync agent, such as its name, endpoint
|
|
23
|
+
* type, and status.</p>
|
|
23
24
|
* @example
|
|
24
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
26
|
* ```javascript
|
|
@@ -40,7 +41,8 @@ export interface DescribeAgentCommandOutput extends DescribeAgentResponse, __Met
|
|
|
40
41
|
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
41
42
|
*
|
|
42
43
|
* @throws {@link InternalException} (server fault)
|
|
43
|
-
* <p>This exception is thrown when an error occurs in the DataSync
|
|
44
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
45
|
+
* service.</p>
|
|
44
46
|
*
|
|
45
47
|
* @throws {@link InvalidRequestException} (client fault)
|
|
46
48
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { DataSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataSyncClient";
|
|
5
|
+
import { DescribeDiscoveryJobRequest, DescribeDiscoveryJobResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link DescribeDiscoveryJobCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface DescribeDiscoveryJobCommandInput extends DescribeDiscoveryJobRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link DescribeDiscoveryJobCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface DescribeDiscoveryJobCommandOutput extends DescribeDiscoveryJobResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Returns information about a DataSync discovery job.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { DataSyncClient, DescribeDiscoveryJobCommand } from "@aws-sdk/client-datasync"; // ES Modules import
|
|
27
|
+
* // const { DataSyncClient, DescribeDiscoveryJobCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
|
|
28
|
+
* const client = new DataSyncClient(config);
|
|
29
|
+
* const input = { // DescribeDiscoveryJobRequest
|
|
30
|
+
* DiscoveryJobArn: "STRING_VALUE", // required
|
|
31
|
+
* };
|
|
32
|
+
* const command = new DescribeDiscoveryJobCommand(input);
|
|
33
|
+
* const response = await client.send(command);
|
|
34
|
+
* ```
|
|
35
|
+
*
|
|
36
|
+
* @param DescribeDiscoveryJobCommandInput - {@link DescribeDiscoveryJobCommandInput}
|
|
37
|
+
* @returns {@link DescribeDiscoveryJobCommandOutput}
|
|
38
|
+
* @see {@link DescribeDiscoveryJobCommandInput} for command's `input` shape.
|
|
39
|
+
* @see {@link DescribeDiscoveryJobCommandOutput} for command's `response` shape.
|
|
40
|
+
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link InternalException} (server fault)
|
|
43
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
44
|
+
* service.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
47
|
+
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
48
|
+
*
|
|
49
|
+
*
|
|
50
|
+
*/
|
|
51
|
+
export declare class DescribeDiscoveryJobCommand extends $Command<DescribeDiscoveryJobCommandInput, DescribeDiscoveryJobCommandOutput, DataSyncClientResolvedConfig> {
|
|
52
|
+
readonly input: DescribeDiscoveryJobCommandInput;
|
|
53
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
54
|
+
/**
|
|
55
|
+
* @public
|
|
56
|
+
*/
|
|
57
|
+
constructor(input: DescribeDiscoveryJobCommandInput);
|
|
58
|
+
/**
|
|
59
|
+
* @internal
|
|
60
|
+
*/
|
|
61
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDiscoveryJobCommandInput, DescribeDiscoveryJobCommandOutput>;
|
|
62
|
+
/**
|
|
63
|
+
* @internal
|
|
64
|
+
*/
|
|
65
|
+
private serialize;
|
|
66
|
+
/**
|
|
67
|
+
* @internal
|
|
68
|
+
*/
|
|
69
|
+
private deserialize;
|
|
70
|
+
}
|
|
@@ -19,7 +19,8 @@ export interface DescribeLocationEfsCommandOutput extends DescribeLocationEfsRes
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Returns metadata about your DataSync location for an Amazon EFS
|
|
22
|
+
* <p>Returns metadata about your DataSync location for an Amazon EFS
|
|
23
|
+
* file system.</p>
|
|
23
24
|
* @example
|
|
24
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
26
|
* ```javascript
|
|
@@ -40,7 +41,8 @@ export interface DescribeLocationEfsCommandOutput extends DescribeLocationEfsRes
|
|
|
40
41
|
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
41
42
|
*
|
|
42
43
|
* @throws {@link InternalException} (server fault)
|
|
43
|
-
* <p>This exception is thrown when an error occurs in the DataSync
|
|
44
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
45
|
+
* service.</p>
|
|
44
46
|
*
|
|
45
47
|
* @throws {@link InvalidRequestException} (client fault)
|
|
46
48
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
@@ -40,7 +40,8 @@ export interface DescribeLocationFsxLustreCommandOutput extends DescribeLocation
|
|
|
40
40
|
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
41
41
|
*
|
|
42
42
|
* @throws {@link InternalException} (server fault)
|
|
43
|
-
* <p>This exception is thrown when an error occurs in the DataSync
|
|
43
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
44
|
+
* service.</p>
|
|
44
45
|
*
|
|
45
46
|
* @throws {@link InvalidRequestException} (client fault)
|
|
46
47
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
@@ -44,7 +44,8 @@ export interface DescribeLocationFsxOntapCommandOutput extends DescribeLocationF
|
|
|
44
44
|
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
45
45
|
*
|
|
46
46
|
* @throws {@link InternalException} (server fault)
|
|
47
|
-
* <p>This exception is thrown when an error occurs in the DataSync
|
|
47
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
48
|
+
* service.</p>
|
|
48
49
|
*
|
|
49
50
|
* @throws {@link InvalidRequestException} (client fault)
|
|
50
51
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
@@ -22,7 +22,7 @@ export interface DescribeLocationFsxOpenZfsCommandOutput extends DescribeLocatio
|
|
|
22
22
|
* <p>Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.</p>
|
|
23
23
|
* <note>
|
|
24
24
|
* <p>Response elements related to <code>SMB</code> aren't supported with the
|
|
25
|
-
*
|
|
25
|
+
* <code>DescribeLocationFsxOpenZfs</code> operation.</p>
|
|
26
26
|
* </note>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -44,7 +44,8 @@ export interface DescribeLocationFsxOpenZfsCommandOutput extends DescribeLocatio
|
|
|
44
44
|
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
45
45
|
*
|
|
46
46
|
* @throws {@link InternalException} (server fault)
|
|
47
|
-
* <p>This exception is thrown when an error occurs in the DataSync
|
|
47
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
48
|
+
* service.</p>
|
|
48
49
|
*
|
|
49
50
|
* @throws {@link InvalidRequestException} (client fault)
|
|
50
51
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
@@ -19,8 +19,8 @@ export interface DescribeLocationFsxWindowsCommandOutput extends DescribeLocatio
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Returns metadata about an Amazon FSx for Windows File Server
|
|
23
|
-
*
|
|
22
|
+
* <p>Returns metadata about an Amazon FSx for Windows File Server location, such as information
|
|
23
|
+
* about its path.</p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
26
|
* ```javascript
|
|
@@ -41,7 +41,8 @@ export interface DescribeLocationFsxWindowsCommandOutput extends DescribeLocatio
|
|
|
41
41
|
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
42
42
|
*
|
|
43
43
|
* @throws {@link InternalException} (server fault)
|
|
44
|
-
* <p>This exception is thrown when an error occurs in the DataSync
|
|
44
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
45
|
+
* service.</p>
|
|
45
46
|
*
|
|
46
47
|
* @throws {@link InvalidRequestException} (client fault)
|
|
47
48
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
@@ -41,7 +41,8 @@ export interface DescribeLocationHdfsCommandOutput extends DescribeLocationHdfsR
|
|
|
41
41
|
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
42
42
|
*
|
|
43
43
|
* @throws {@link InternalException} (server fault)
|
|
44
|
-
* <p>This exception is thrown when an error occurs in the DataSync
|
|
44
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
45
|
+
* service.</p>
|
|
45
46
|
*
|
|
46
47
|
* @throws {@link InvalidRequestException} (client fault)
|
|
47
48
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
@@ -40,7 +40,8 @@ export interface DescribeLocationNfsCommandOutput extends DescribeLocationNfsRes
|
|
|
40
40
|
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
41
41
|
*
|
|
42
42
|
* @throws {@link InternalException} (server fault)
|
|
43
|
-
* <p>This exception is thrown when an error occurs in the DataSync
|
|
43
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
44
|
+
* service.</p>
|
|
44
45
|
*
|
|
45
46
|
* @throws {@link InvalidRequestException} (client fault)
|
|
46
47
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
@@ -19,7 +19,8 @@ export interface DescribeLocationObjectStorageCommandOutput extends DescribeLoca
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Returns metadata about your DataSync location for an object storage
|
|
22
|
+
* <p>Returns metadata about your DataSync location for an object storage
|
|
23
|
+
* system.</p>
|
|
23
24
|
* @example
|
|
24
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
26
|
* ```javascript
|
|
@@ -40,7 +41,8 @@ export interface DescribeLocationObjectStorageCommandOutput extends DescribeLoca
|
|
|
40
41
|
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
41
42
|
*
|
|
42
43
|
* @throws {@link InternalException} (server fault)
|
|
43
|
-
* <p>This exception is thrown when an error occurs in the DataSync
|
|
44
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
45
|
+
* service.</p>
|
|
44
46
|
*
|
|
45
47
|
* @throws {@link InvalidRequestException} (client fault)
|
|
46
48
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
@@ -40,7 +40,8 @@ export interface DescribeLocationS3CommandOutput extends DescribeLocationS3Respo
|
|
|
40
40
|
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
41
41
|
*
|
|
42
42
|
* @throws {@link InternalException} (server fault)
|
|
43
|
-
* <p>This exception is thrown when an error occurs in the DataSync
|
|
43
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
44
|
+
* service.</p>
|
|
44
45
|
*
|
|
45
46
|
* @throws {@link InvalidRequestException} (client fault)
|
|
46
47
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
@@ -40,7 +40,8 @@ export interface DescribeLocationSmbCommandOutput extends DescribeLocationSmbRes
|
|
|
40
40
|
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
41
41
|
*
|
|
42
42
|
* @throws {@link InternalException} (server fault)
|
|
43
|
-
* <p>This exception is thrown when an error occurs in the DataSync
|
|
43
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
44
|
+
* service.</p>
|
|
44
45
|
*
|
|
45
46
|
* @throws {@link InvalidRequestException} (client fault)
|
|
46
47
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { DataSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataSyncClient";
|
|
5
|
+
import { DescribeStorageSystemRequest, DescribeStorageSystemResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link DescribeStorageSystemCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface DescribeStorageSystemCommandInput extends DescribeStorageSystemRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link DescribeStorageSystemCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface DescribeStorageSystemCommandOutput extends DescribeStorageSystemResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Returns information about an on-premises storage system that you're using with
|
|
23
|
+
* DataSync Discovery.</p>
|
|
24
|
+
* @example
|
|
25
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
26
|
+
* ```javascript
|
|
27
|
+
* import { DataSyncClient, DescribeStorageSystemCommand } from "@aws-sdk/client-datasync"; // ES Modules import
|
|
28
|
+
* // const { DataSyncClient, DescribeStorageSystemCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
|
|
29
|
+
* const client = new DataSyncClient(config);
|
|
30
|
+
* const input = { // DescribeStorageSystemRequest
|
|
31
|
+
* StorageSystemArn: "STRING_VALUE", // required
|
|
32
|
+
* };
|
|
33
|
+
* const command = new DescribeStorageSystemCommand(input);
|
|
34
|
+
* const response = await client.send(command);
|
|
35
|
+
* ```
|
|
36
|
+
*
|
|
37
|
+
* @param DescribeStorageSystemCommandInput - {@link DescribeStorageSystemCommandInput}
|
|
38
|
+
* @returns {@link DescribeStorageSystemCommandOutput}
|
|
39
|
+
* @see {@link DescribeStorageSystemCommandInput} for command's `input` shape.
|
|
40
|
+
* @see {@link DescribeStorageSystemCommandOutput} for command's `response` shape.
|
|
41
|
+
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link InternalException} (server fault)
|
|
44
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
45
|
+
* service.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
48
|
+
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
49
|
+
*
|
|
50
|
+
*
|
|
51
|
+
*/
|
|
52
|
+
export declare class DescribeStorageSystemCommand extends $Command<DescribeStorageSystemCommandInput, DescribeStorageSystemCommandOutput, DataSyncClientResolvedConfig> {
|
|
53
|
+
readonly input: DescribeStorageSystemCommandInput;
|
|
54
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
55
|
+
/**
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
58
|
+
constructor(input: DescribeStorageSystemCommandInput);
|
|
59
|
+
/**
|
|
60
|
+
* @internal
|
|
61
|
+
*/
|
|
62
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeStorageSystemCommandInput, DescribeStorageSystemCommandOutput>;
|
|
63
|
+
/**
|
|
64
|
+
* @internal
|
|
65
|
+
*/
|
|
66
|
+
private serialize;
|
|
67
|
+
/**
|
|
68
|
+
* @internal
|
|
69
|
+
*/
|
|
70
|
+
private deserialize;
|
|
71
|
+
}
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { DataSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataSyncClient";
|
|
5
|
+
import { DescribeStorageSystemResourceMetricsRequest, DescribeStorageSystemResourceMetricsResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link DescribeStorageSystemResourceMetricsCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface DescribeStorageSystemResourceMetricsCommandInput extends DescribeStorageSystemResourceMetricsRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link DescribeStorageSystemResourceMetricsCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface DescribeStorageSystemResourceMetricsCommandOutput extends DescribeStorageSystemResourceMetricsResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Returns information, including performance data and capacity usage, which DataSync Discovery
|
|
23
|
+
* collects about a specific resource in your-premises storage system.</p>
|
|
24
|
+
* @example
|
|
25
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
26
|
+
* ```javascript
|
|
27
|
+
* import { DataSyncClient, DescribeStorageSystemResourceMetricsCommand } from "@aws-sdk/client-datasync"; // ES Modules import
|
|
28
|
+
* // const { DataSyncClient, DescribeStorageSystemResourceMetricsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
|
|
29
|
+
* const client = new DataSyncClient(config);
|
|
30
|
+
* const input = { // DescribeStorageSystemResourceMetricsRequest
|
|
31
|
+
* DiscoveryJobArn: "STRING_VALUE", // required
|
|
32
|
+
* ResourceType: "SVM" || "VOLUME" || "CLUSTER", // required
|
|
33
|
+
* ResourceId: "STRING_VALUE", // required
|
|
34
|
+
* StartTime: new Date("TIMESTAMP"),
|
|
35
|
+
* EndTime: new Date("TIMESTAMP"),
|
|
36
|
+
* MaxResults: Number("int"),
|
|
37
|
+
* NextToken: "STRING_VALUE",
|
|
38
|
+
* };
|
|
39
|
+
* const command = new DescribeStorageSystemResourceMetricsCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* ```
|
|
42
|
+
*
|
|
43
|
+
* @param DescribeStorageSystemResourceMetricsCommandInput - {@link DescribeStorageSystemResourceMetricsCommandInput}
|
|
44
|
+
* @returns {@link DescribeStorageSystemResourceMetricsCommandOutput}
|
|
45
|
+
* @see {@link DescribeStorageSystemResourceMetricsCommandInput} for command's `input` shape.
|
|
46
|
+
* @see {@link DescribeStorageSystemResourceMetricsCommandOutput} for command's `response` shape.
|
|
47
|
+
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link InternalException} (server fault)
|
|
50
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
51
|
+
* service.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
54
|
+
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
55
|
+
*
|
|
56
|
+
*
|
|
57
|
+
*/
|
|
58
|
+
export declare class DescribeStorageSystemResourceMetricsCommand extends $Command<DescribeStorageSystemResourceMetricsCommandInput, DescribeStorageSystemResourceMetricsCommandOutput, DataSyncClientResolvedConfig> {
|
|
59
|
+
readonly input: DescribeStorageSystemResourceMetricsCommandInput;
|
|
60
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
61
|
+
/**
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
64
|
+
constructor(input: DescribeStorageSystemResourceMetricsCommandInput);
|
|
65
|
+
/**
|
|
66
|
+
* @internal
|
|
67
|
+
*/
|
|
68
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeStorageSystemResourceMetricsCommandInput, DescribeStorageSystemResourceMetricsCommandOutput>;
|
|
69
|
+
/**
|
|
70
|
+
* @internal
|
|
71
|
+
*/
|
|
72
|
+
private serialize;
|
|
73
|
+
/**
|
|
74
|
+
* @internal
|
|
75
|
+
*/
|
|
76
|
+
private deserialize;
|
|
77
|
+
}
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { DataSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataSyncClient";
|
|
5
|
+
import { DescribeStorageSystemResourcesRequest, DescribeStorageSystemResourcesResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link DescribeStorageSystemResourcesCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface DescribeStorageSystemResourcesCommandInput extends DescribeStorageSystemResourcesRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link DescribeStorageSystemResourcesCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface DescribeStorageSystemResourcesCommandOutput extends DescribeStorageSystemResourcesResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Returns information that DataSync Discovery collects about resources in your on-premises storage
|
|
23
|
+
* system.</p>
|
|
24
|
+
* @example
|
|
25
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
26
|
+
* ```javascript
|
|
27
|
+
* import { DataSyncClient, DescribeStorageSystemResourcesCommand } from "@aws-sdk/client-datasync"; // ES Modules import
|
|
28
|
+
* // const { DataSyncClient, DescribeStorageSystemResourcesCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
|
|
29
|
+
* const client = new DataSyncClient(config);
|
|
30
|
+
* const input = { // DescribeStorageSystemResourcesRequest
|
|
31
|
+
* DiscoveryJobArn: "STRING_VALUE", // required
|
|
32
|
+
* ResourceType: "SVM" || "VOLUME" || "CLUSTER", // required
|
|
33
|
+
* ResourceIds: [ // ResourceIds
|
|
34
|
+
* "STRING_VALUE",
|
|
35
|
+
* ],
|
|
36
|
+
* Filter: { // ResourceFilters
|
|
37
|
+
* "<keys>": [ // FilterMembers
|
|
38
|
+
* "STRING_VALUE",
|
|
39
|
+
* ],
|
|
40
|
+
* },
|
|
41
|
+
* MaxResults: Number("int"),
|
|
42
|
+
* NextToken: "STRING_VALUE",
|
|
43
|
+
* };
|
|
44
|
+
* const command = new DescribeStorageSystemResourcesCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param DescribeStorageSystemResourcesCommandInput - {@link DescribeStorageSystemResourcesCommandInput}
|
|
49
|
+
* @returns {@link DescribeStorageSystemResourcesCommandOutput}
|
|
50
|
+
* @see {@link DescribeStorageSystemResourcesCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link DescribeStorageSystemResourcesCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link InternalException} (server fault)
|
|
55
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
56
|
+
* service.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
59
|
+
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
60
|
+
*
|
|
61
|
+
*
|
|
62
|
+
*/
|
|
63
|
+
export declare class DescribeStorageSystemResourcesCommand extends $Command<DescribeStorageSystemResourcesCommandInput, DescribeStorageSystemResourcesCommandOutput, DataSyncClientResolvedConfig> {
|
|
64
|
+
readonly input: DescribeStorageSystemResourcesCommandInput;
|
|
65
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
66
|
+
/**
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
constructor(input: DescribeStorageSystemResourcesCommandInput);
|
|
70
|
+
/**
|
|
71
|
+
* @internal
|
|
72
|
+
*/
|
|
73
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeStorageSystemResourcesCommandInput, DescribeStorageSystemResourcesCommandOutput>;
|
|
74
|
+
/**
|
|
75
|
+
* @internal
|
|
76
|
+
*/
|
|
77
|
+
private serialize;
|
|
78
|
+
/**
|
|
79
|
+
* @internal
|
|
80
|
+
*/
|
|
81
|
+
private deserialize;
|
|
82
|
+
}
|
|
@@ -40,7 +40,8 @@ export interface DescribeTaskCommandOutput extends DescribeTaskResponse, __Metad
|
|
|
40
40
|
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
41
41
|
*
|
|
42
42
|
* @throws {@link InternalException} (server fault)
|
|
43
|
-
* <p>This exception is thrown when an error occurs in the DataSync
|
|
43
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
44
|
+
* service.</p>
|
|
44
45
|
*
|
|
45
46
|
* @throws {@link InvalidRequestException} (client fault)
|
|
46
47
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
@@ -40,7 +40,8 @@ export interface DescribeTaskExecutionCommandOutput extends DescribeTaskExecutio
|
|
|
40
40
|
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
41
41
|
*
|
|
42
42
|
* @throws {@link InternalException} (server fault)
|
|
43
|
-
* <p>This exception is thrown when an error occurs in the DataSync
|
|
43
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
44
|
+
* service.</p>
|
|
44
45
|
*
|
|
45
46
|
* @throws {@link InvalidRequestException} (client fault)
|
|
46
47
|
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { DataSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataSyncClient";
|
|
5
|
+
import { GenerateRecommendationsRequest, GenerateRecommendationsResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link GenerateRecommendationsCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface GenerateRecommendationsCommandInput extends GenerateRecommendationsRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link GenerateRecommendationsCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface GenerateRecommendationsCommandOutput extends GenerateRecommendationsResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Creates recommendations about where to migrate your data to in Amazon Web Services.
|
|
23
|
+
* Recommendations are generated based on information that DataSync Discovery collects about your
|
|
24
|
+
* on-premises storage system's resources. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html">Recommendations
|
|
25
|
+
* provided by DataSync Discovery</a>.</p>
|
|
26
|
+
* <p>Once generated, you can view your recommendations by using the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeStorageSystemResources.html">DescribeStorageSystemResources</a> operation.</p>
|
|
27
|
+
* <note>
|
|
28
|
+
* <p>If your <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#discovery-job-statuses-table">discovery job completes successfully</a>, you don't need to use this operation. DataSync
|
|
29
|
+
* Discovery generates the recommendations for you automatically.</p>
|
|
30
|
+
* </note>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { DataSyncClient, GenerateRecommendationsCommand } from "@aws-sdk/client-datasync"; // ES Modules import
|
|
35
|
+
* // const { DataSyncClient, GenerateRecommendationsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
|
|
36
|
+
* const client = new DataSyncClient(config);
|
|
37
|
+
* const input = { // GenerateRecommendationsRequest
|
|
38
|
+
* DiscoveryJobArn: "STRING_VALUE", // required
|
|
39
|
+
* ResourceIds: [ // ResourceIds // required
|
|
40
|
+
* "STRING_VALUE",
|
|
41
|
+
* ],
|
|
42
|
+
* ResourceType: "SVM" || "VOLUME" || "CLUSTER", // required
|
|
43
|
+
* };
|
|
44
|
+
* const command = new GenerateRecommendationsCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param GenerateRecommendationsCommandInput - {@link GenerateRecommendationsCommandInput}
|
|
49
|
+
* @returns {@link GenerateRecommendationsCommandOutput}
|
|
50
|
+
* @see {@link GenerateRecommendationsCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link GenerateRecommendationsCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link InternalException} (server fault)
|
|
55
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
56
|
+
* service.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
59
|
+
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
60
|
+
*
|
|
61
|
+
*
|
|
62
|
+
*/
|
|
63
|
+
export declare class GenerateRecommendationsCommand extends $Command<GenerateRecommendationsCommandInput, GenerateRecommendationsCommandOutput, DataSyncClientResolvedConfig> {
|
|
64
|
+
readonly input: GenerateRecommendationsCommandInput;
|
|
65
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
66
|
+
/**
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
constructor(input: GenerateRecommendationsCommandInput);
|
|
70
|
+
/**
|
|
71
|
+
* @internal
|
|
72
|
+
*/
|
|
73
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GenerateRecommendationsCommandInput, GenerateRecommendationsCommandOutput>;
|
|
74
|
+
/**
|
|
75
|
+
* @internal
|
|
76
|
+
*/
|
|
77
|
+
private serialize;
|
|
78
|
+
/**
|
|
79
|
+
* @internal
|
|
80
|
+
*/
|
|
81
|
+
private deserialize;
|
|
82
|
+
}
|