@aws-sdk/client-datasync 3.369.0 → 3.377.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 (39) hide show
  1. package/README.md +27 -3
  2. package/dist-cjs/DataSync.js +6 -0
  3. package/dist-cjs/commands/CreateLocationAzureBlobCommand.js +47 -0
  4. package/dist-cjs/commands/DescribeLocationAzureBlobCommand.js +46 -0
  5. package/dist-cjs/commands/UpdateLocationAzureBlobCommand.js +47 -0
  6. package/dist-cjs/commands/index.js +3 -0
  7. package/dist-cjs/models/models_0.js +28 -2
  8. package/dist-cjs/protocols/Aws_json1_1.js +146 -3
  9. package/dist-es/DataSync.js +6 -0
  10. package/dist-es/commands/CreateLocationAzureBlobCommand.js +43 -0
  11. package/dist-es/commands/DescribeLocationAzureBlobCommand.js +42 -0
  12. package/dist-es/commands/UpdateLocationAzureBlobCommand.js +43 -0
  13. package/dist-es/commands/index.js +3 -0
  14. package/dist-es/models/models_0.js +23 -0
  15. package/dist-es/protocols/Aws_json1_1.js +137 -0
  16. package/dist-types/DataSync.d.ts +24 -3
  17. package/dist-types/DataSyncClient.d.ts +8 -5
  18. package/dist-types/commands/CreateAgentCommand.d.ts +19 -12
  19. package/dist-types/commands/CreateLocationAzureBlobCommand.d.ts +98 -0
  20. package/dist-types/commands/CreateLocationNfsCommand.d.ts +2 -2
  21. package/dist-types/commands/CreateLocationSmbCommand.d.ts +3 -1
  22. package/dist-types/commands/DescribeLocationAzureBlobCommand.d.ts +88 -0
  23. package/dist-types/commands/DescribeStorageSystemResourcesCommand.d.ts +3 -0
  24. package/dist-types/commands/DescribeTaskCommand.d.ts +1 -1
  25. package/dist-types/commands/DescribeTaskExecutionCommand.d.ts +2 -1
  26. package/dist-types/commands/UpdateLocationAzureBlobCommand.d.ts +88 -0
  27. package/dist-types/commands/index.d.ts +3 -0
  28. package/dist-types/index.d.ts +3 -3
  29. package/dist-types/models/models_0.d.ts +295 -87
  30. package/dist-types/protocols/Aws_json1_1.d.ts +27 -0
  31. package/dist-types/ts3.4/DataSync.d.ts +51 -0
  32. package/dist-types/ts3.4/DataSyncClient.d.ts +18 -0
  33. package/dist-types/ts3.4/commands/CreateLocationAzureBlobCommand.d.ts +42 -0
  34. package/dist-types/ts3.4/commands/DescribeLocationAzureBlobCommand.d.ts +42 -0
  35. package/dist-types/ts3.4/commands/UpdateLocationAzureBlobCommand.d.ts +42 -0
  36. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  37. package/dist-types/ts3.4/models/models_0.d.ts +66 -0
  38. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +36 -0
  39. package/package.json +16 -17
@@ -0,0 +1,98 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { DataSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataSyncClient";
5
+ import { CreateLocationAzureBlobRequest, CreateLocationAzureBlobResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link CreateLocationAzureBlobCommand}.
14
+ */
15
+ export interface CreateLocationAzureBlobCommandInput extends CreateLocationAzureBlobRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateLocationAzureBlobCommand}.
21
+ */
22
+ export interface CreateLocationAzureBlobCommandOutput extends CreateLocationAzureBlobResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Creates an endpoint for a Microsoft Azure Blob Storage container that DataSync can use as a transfer source or destination.</p>
27
+ * <p>Before you begin, make sure you know <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access">how DataSync accesses Azure Blob Storage</a> and works with <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers">access tiers</a> and <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#blob-types">blob types</a>. You also need a <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-creating-agent">DataSync agent</a> that can connect to your
28
+ * container.</p>
29
+ * @example
30
+ * Use a bare-bones client and the command you need to make an API call.
31
+ * ```javascript
32
+ * import { DataSyncClient, CreateLocationAzureBlobCommand } from "@aws-sdk/client-datasync"; // ES Modules import
33
+ * // const { DataSyncClient, CreateLocationAzureBlobCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
34
+ * const client = new DataSyncClient(config);
35
+ * const input = { // CreateLocationAzureBlobRequest
36
+ * ContainerUrl: "STRING_VALUE", // required
37
+ * AuthenticationType: "SAS", // required
38
+ * SasConfiguration: { // AzureBlobSasConfiguration
39
+ * Token: "STRING_VALUE", // required
40
+ * },
41
+ * BlobType: "BLOCK",
42
+ * AccessTier: "HOT" || "COOL" || "ARCHIVE",
43
+ * Subdirectory: "STRING_VALUE",
44
+ * AgentArns: [ // AgentArnList // required
45
+ * "STRING_VALUE",
46
+ * ],
47
+ * Tags: [ // InputTagList
48
+ * { // TagListEntry
49
+ * Key: "STRING_VALUE", // required
50
+ * Value: "STRING_VALUE",
51
+ * },
52
+ * ],
53
+ * };
54
+ * const command = new CreateLocationAzureBlobCommand(input);
55
+ * const response = await client.send(command);
56
+ * // { // CreateLocationAzureBlobResponse
57
+ * // LocationArn: "STRING_VALUE",
58
+ * // };
59
+ *
60
+ * ```
61
+ *
62
+ * @param CreateLocationAzureBlobCommandInput - {@link CreateLocationAzureBlobCommandInput}
63
+ * @returns {@link CreateLocationAzureBlobCommandOutput}
64
+ * @see {@link CreateLocationAzureBlobCommandInput} for command's `input` shape.
65
+ * @see {@link CreateLocationAzureBlobCommandOutput} for command's `response` shape.
66
+ * @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
67
+ *
68
+ * @throws {@link InternalException} (server fault)
69
+ * <p>This exception is thrown when an error occurs in the DataSync
70
+ * service.</p>
71
+ *
72
+ * @throws {@link InvalidRequestException} (client fault)
73
+ * <p>This exception is thrown when the client submits a malformed request.</p>
74
+ *
75
+ * @throws {@link DataSyncServiceException}
76
+ * <p>Base exception class for all service exceptions from DataSync service.</p>
77
+ *
78
+ */
79
+ export declare class CreateLocationAzureBlobCommand extends $Command<CreateLocationAzureBlobCommandInput, CreateLocationAzureBlobCommandOutput, DataSyncClientResolvedConfig> {
80
+ readonly input: CreateLocationAzureBlobCommandInput;
81
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
82
+ /**
83
+ * @public
84
+ */
85
+ constructor(input: CreateLocationAzureBlobCommandInput);
86
+ /**
87
+ * @internal
88
+ */
89
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateLocationAzureBlobCommandInput, CreateLocationAzureBlobCommandOutput>;
90
+ /**
91
+ * @internal
92
+ */
93
+ private serialize;
94
+ /**
95
+ * @internal
96
+ */
97
+ private deserialize;
98
+ }
@@ -23,8 +23,8 @@ export interface CreateLocationNfsCommandOutput extends CreateLocationNfsRespons
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Defines a file system on a Network File System (NFS) server that can be read from or
27
- * written to.</p>
26
+ * <p>Creates an endpoint for an Network File System (NFS) file server that DataSync can use for a
27
+ * data transfer.</p>
28
28
  * @example
29
29
  * Use a bare-bones client and the command you need to make an API call.
30
30
  * ```javascript
@@ -23,7 +23,9 @@ export interface CreateLocationSmbCommandOutput extends CreateLocationSmbRespons
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html">Creating an SMB location</a>.</p>
26
+ * <p>Creates an endpoint for a Server Message Block (SMB) file server that DataSync can use for a data transfer.</p>
27
+ * <p>Before you begin, make sure that you understand how DataSync
28
+ * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html">accesses an SMB file server</a>.</p>
27
29
  * @example
28
30
  * Use a bare-bones client and the command you need to make an API call.
29
31
  * ```javascript
@@ -0,0 +1,88 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { DataSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataSyncClient";
5
+ import { DescribeLocationAzureBlobRequest, DescribeLocationAzureBlobResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DescribeLocationAzureBlobCommand}.
14
+ */
15
+ export interface DescribeLocationAzureBlobCommandInput extends DescribeLocationAzureBlobRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DescribeLocationAzureBlobCommand}.
21
+ */
22
+ export interface DescribeLocationAzureBlobCommandOutput extends DescribeLocationAzureBlobResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { DataSyncClient, DescribeLocationAzureBlobCommand } from "@aws-sdk/client-datasync"; // ES Modules import
31
+ * // const { DataSyncClient, DescribeLocationAzureBlobCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
32
+ * const client = new DataSyncClient(config);
33
+ * const input = { // DescribeLocationAzureBlobRequest
34
+ * LocationArn: "STRING_VALUE", // required
35
+ * };
36
+ * const command = new DescribeLocationAzureBlobCommand(input);
37
+ * const response = await client.send(command);
38
+ * // { // DescribeLocationAzureBlobResponse
39
+ * // LocationArn: "STRING_VALUE",
40
+ * // LocationUri: "STRING_VALUE",
41
+ * // AuthenticationType: "SAS",
42
+ * // BlobType: "BLOCK",
43
+ * // AccessTier: "HOT" || "COOL" || "ARCHIVE",
44
+ * // AgentArns: [ // AgentArnList
45
+ * // "STRING_VALUE",
46
+ * // ],
47
+ * // CreationTime: new Date("TIMESTAMP"),
48
+ * // };
49
+ *
50
+ * ```
51
+ *
52
+ * @param DescribeLocationAzureBlobCommandInput - {@link DescribeLocationAzureBlobCommandInput}
53
+ * @returns {@link DescribeLocationAzureBlobCommandOutput}
54
+ * @see {@link DescribeLocationAzureBlobCommandInput} for command's `input` shape.
55
+ * @see {@link DescribeLocationAzureBlobCommandOutput} for command's `response` shape.
56
+ * @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
57
+ *
58
+ * @throws {@link InternalException} (server fault)
59
+ * <p>This exception is thrown when an error occurs in the DataSync
60
+ * service.</p>
61
+ *
62
+ * @throws {@link InvalidRequestException} (client fault)
63
+ * <p>This exception is thrown when the client submits a malformed request.</p>
64
+ *
65
+ * @throws {@link DataSyncServiceException}
66
+ * <p>Base exception class for all service exceptions from DataSync service.</p>
67
+ *
68
+ */
69
+ export declare class DescribeLocationAzureBlobCommand extends $Command<DescribeLocationAzureBlobCommandInput, DescribeLocationAzureBlobCommandOutput, DataSyncClientResolvedConfig> {
70
+ readonly input: DescribeLocationAzureBlobCommandInput;
71
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
75
+ constructor(input: DescribeLocationAzureBlobCommandInput);
76
+ /**
77
+ * @internal
78
+ */
79
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeLocationAzureBlobCommandInput, DescribeLocationAzureBlobCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
83
+ private serialize;
84
+ /**
85
+ * @internal
86
+ */
87
+ private deserialize;
88
+ }
@@ -86,6 +86,7 @@ export interface DescribeStorageSystemResourcesCommandOutput extends DescribeSto
86
86
  * // NfsExportedVolumes: Number("long"),
87
87
  * // RecommendationStatus: "NONE" || "IN_PROGRESS" || "COMPLETED" || "FAILED",
88
88
  * // TotalSnapshotCapacityUsed: Number("long"),
89
+ * // LunCount: Number("long"),
89
90
  * // },
90
91
  * // ],
91
92
  * // NetAppONTAPVolumes: [ // NetAppONTAPVolumes
@@ -124,6 +125,7 @@ export interface DescribeStorageSystemResourcesCommandOutput extends DescribeSto
124
125
  * // },
125
126
  * // ],
126
127
  * // RecommendationStatus: "NONE" || "IN_PROGRESS" || "COMPLETED" || "FAILED",
128
+ * // LunCount: Number("long"),
127
129
  * // },
128
130
  * // ],
129
131
  * // NetAppONTAPClusters: [ // NetAppONTAPClusters
@@ -158,6 +160,7 @@ export interface DescribeStorageSystemResourcesCommandOutput extends DescribeSto
158
160
  * // },
159
161
  * // ],
160
162
  * // RecommendationStatus: "NONE" || "IN_PROGRESS" || "COMPLETED" || "FAILED",
163
+ * // LunCount: Number("long"),
161
164
  * // },
162
165
  * // ],
163
166
  * // },
@@ -23,7 +23,7 @@ export interface DescribeTaskCommandOutput extends DescribeTaskResponse, __Metad
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Returns metadata about a task.</p>
26
+ * <p>Provides information about an DataSync transfer task.</p>
27
27
  * @example
28
28
  * Use a bare-bones client and the command you need to make an API call.
29
29
  * ```javascript
@@ -23,7 +23,8 @@ export interface DescribeTaskExecutionCommandOutput extends DescribeTaskExecutio
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Returns detailed metadata about a task that is being executed.</p>
26
+ * <p>Provides information about an DataSync transfer task that's
27
+ * running.</p>
27
28
  * @example
28
29
  * Use a bare-bones client and the command you need to make an API call.
29
30
  * ```javascript
@@ -0,0 +1,88 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { DataSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataSyncClient";
5
+ import { UpdateLocationAzureBlobRequest, UpdateLocationAzureBlobResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UpdateLocationAzureBlobCommand}.
14
+ */
15
+ export interface UpdateLocationAzureBlobCommandInput extends UpdateLocationAzureBlobRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateLocationAzureBlobCommand}.
21
+ */
22
+ export interface UpdateLocationAzureBlobCommandOutput extends UpdateLocationAzureBlobResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { DataSyncClient, UpdateLocationAzureBlobCommand } from "@aws-sdk/client-datasync"; // ES Modules import
31
+ * // const { DataSyncClient, UpdateLocationAzureBlobCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
32
+ * const client = new DataSyncClient(config);
33
+ * const input = { // UpdateLocationAzureBlobRequest
34
+ * LocationArn: "STRING_VALUE", // required
35
+ * Subdirectory: "STRING_VALUE",
36
+ * AuthenticationType: "SAS",
37
+ * SasConfiguration: { // AzureBlobSasConfiguration
38
+ * Token: "STRING_VALUE", // required
39
+ * },
40
+ * BlobType: "BLOCK",
41
+ * AccessTier: "HOT" || "COOL" || "ARCHIVE",
42
+ * AgentArns: [ // AgentArnList
43
+ * "STRING_VALUE",
44
+ * ],
45
+ * };
46
+ * const command = new UpdateLocationAzureBlobCommand(input);
47
+ * const response = await client.send(command);
48
+ * // {};
49
+ *
50
+ * ```
51
+ *
52
+ * @param UpdateLocationAzureBlobCommandInput - {@link UpdateLocationAzureBlobCommandInput}
53
+ * @returns {@link UpdateLocationAzureBlobCommandOutput}
54
+ * @see {@link UpdateLocationAzureBlobCommandInput} for command's `input` shape.
55
+ * @see {@link UpdateLocationAzureBlobCommandOutput} for command's `response` shape.
56
+ * @see {@link DataSyncClientResolvedConfig | config} for DataSyncClient's `config` shape.
57
+ *
58
+ * @throws {@link InternalException} (server fault)
59
+ * <p>This exception is thrown when an error occurs in the DataSync
60
+ * service.</p>
61
+ *
62
+ * @throws {@link InvalidRequestException} (client fault)
63
+ * <p>This exception is thrown when the client submits a malformed request.</p>
64
+ *
65
+ * @throws {@link DataSyncServiceException}
66
+ * <p>Base exception class for all service exceptions from DataSync service.</p>
67
+ *
68
+ */
69
+ export declare class UpdateLocationAzureBlobCommand extends $Command<UpdateLocationAzureBlobCommandInput, UpdateLocationAzureBlobCommandOutput, DataSyncClientResolvedConfig> {
70
+ readonly input: UpdateLocationAzureBlobCommandInput;
71
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
75
+ constructor(input: UpdateLocationAzureBlobCommandInput);
76
+ /**
77
+ * @internal
78
+ */
79
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateLocationAzureBlobCommandInput, UpdateLocationAzureBlobCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
83
+ private serialize;
84
+ /**
85
+ * @internal
86
+ */
87
+ private deserialize;
88
+ }
@@ -1,6 +1,7 @@
1
1
  export * from "./AddStorageSystemCommand";
2
2
  export * from "./CancelTaskExecutionCommand";
3
3
  export * from "./CreateAgentCommand";
4
+ export * from "./CreateLocationAzureBlobCommand";
4
5
  export * from "./CreateLocationEfsCommand";
5
6
  export * from "./CreateLocationFsxLustreCommand";
6
7
  export * from "./CreateLocationFsxOntapCommand";
@@ -17,6 +18,7 @@ export * from "./DeleteLocationCommand";
17
18
  export * from "./DeleteTaskCommand";
18
19
  export * from "./DescribeAgentCommand";
19
20
  export * from "./DescribeDiscoveryJobCommand";
21
+ export * from "./DescribeLocationAzureBlobCommand";
20
22
  export * from "./DescribeLocationEfsCommand";
21
23
  export * from "./DescribeLocationFsxLustreCommand";
22
24
  export * from "./DescribeLocationFsxOntapCommand";
@@ -48,6 +50,7 @@ export * from "./TagResourceCommand";
48
50
  export * from "./UntagResourceCommand";
49
51
  export * from "./UpdateAgentCommand";
50
52
  export * from "./UpdateDiscoveryJobCommand";
53
+ export * from "./UpdateLocationAzureBlobCommand";
51
54
  export * from "./UpdateLocationHdfsCommand";
52
55
  export * from "./UpdateLocationNfsCommand";
53
56
  export * from "./UpdateLocationObjectStorageCommand";
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * <fullname>DataSync</fullname>
3
- * <p>DataSync is a managed data transfer service that makes it simpler for you
4
- * to automate moving data between on-premises storage and Amazon Web Services storage services.
5
- * You also can use DataSync to transfer data between other cloud providers and Amazon Web Services storage services.</p>
3
+ * <p>DataSync is an online data movement and discovery service that simplifies data migration
4
+ * and helps you quickly, easily, and securely transfer your file or object data to, from, and
5
+ * between Amazon Web Services storage services.</p>
6
6
  * <p>This API interface reference includes documentation for using DataSync
7
7
  * programmatically. For complete information, see the <i>
8
8
  * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/what-is-datasync.html">DataSync User