@aws-sdk/client-datasync 3.437.0 → 3.439.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/dist-cjs/endpoint/endpointResolver.js +1 -1
- package/dist-cjs/index.js +1 -0
- package/dist-cjs/protocols/Aws_json1_1.js +1 -0
- package/dist-es/endpoint/endpointResolver.js +1 -1
- package/dist-es/index.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +1 -0
- package/dist-types/commands/CreateLocationFsxOntapCommand.d.ts +3 -1
- package/dist-types/commands/CreateLocationFsxWindowsCommand.d.ts +2 -1
- package/dist-types/commands/DeleteAgentCommand.d.ts +5 -3
- package/dist-types/commands/DescribeAgentCommand.d.ts +4 -1
- package/dist-types/commands/ListAgentsCommand.d.ts +3 -0
- package/dist-types/commands/UpdateAgentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateLocationSmbCommand.d.ts +2 -3
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +98 -59
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +5 -0
- package/package.json +6 -5
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.defaultEndpointResolver = void 0;
|
|
4
|
-
const util_endpoints_1 = require("@
|
|
4
|
+
const util_endpoints_1 = require("@smithy/util-endpoints");
|
|
5
5
|
const ruleset_1 = require("./ruleset");
|
|
6
6
|
const defaultEndpointResolver = (endpointParams, context = {}) => {
|
|
7
7
|
return (0, util_endpoints_1.resolveEndpoint)(ruleset_1.ruleSet, {
|
package/dist-cjs/index.js
CHANGED
|
@@ -7,5 +7,6 @@ tslib_1.__exportStar(require("./DataSync"), exports);
|
|
|
7
7
|
tslib_1.__exportStar(require("./commands"), exports);
|
|
8
8
|
tslib_1.__exportStar(require("./pagination"), exports);
|
|
9
9
|
tslib_1.__exportStar(require("./models"), exports);
|
|
10
|
+
require("@aws-sdk/util-endpoints");
|
|
10
11
|
var DataSyncServiceException_1 = require("./models/DataSyncServiceException");
|
|
11
12
|
Object.defineProperty(exports, "DataSyncServiceException", { enumerable: true, get: function () { return DataSyncServiceException_1.DataSyncServiceException; } });
|
|
@@ -2795,6 +2795,7 @@ const de_DescribeAgentResponse = (output, context) => {
|
|
|
2795
2795
|
EndpointType: smithy_client_1.expectString,
|
|
2796
2796
|
LastConnectionTime: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
|
|
2797
2797
|
Name: smithy_client_1.expectString,
|
|
2798
|
+
Platform: smithy_client_1._json,
|
|
2798
2799
|
PrivateLinkConfig: smithy_client_1._json,
|
|
2799
2800
|
Status: smithy_client_1.expectString,
|
|
2800
2801
|
});
|
package/dist-es/index.js
CHANGED
|
@@ -2670,6 +2670,7 @@ const de_DescribeAgentResponse = (output, context) => {
|
|
|
2670
2670
|
EndpointType: __expectString,
|
|
2671
2671
|
LastConnectionTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
2672
2672
|
Name: __expectString,
|
|
2673
|
+
Platform: _json,
|
|
2673
2674
|
PrivateLinkConfig: _json,
|
|
2674
2675
|
Status: __expectString,
|
|
2675
2676
|
});
|
|
@@ -23,7 +23,9 @@ export interface CreateLocationFsxOntapCommandOutput extends CreateLocationFsxOn
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can
|
|
26
|
+
* <p>Creates an endpoint for an Amazon FSx for NetApp ONTAP file system 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-ontap-location.html#create-ontap-location-access">accesses an FSx for ONTAP file system</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
|
|
@@ -23,7 +23,8 @@ export interface CreateLocationFsxWindowsCommandOutput extends CreateLocationFsx
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Creates an endpoint for an Amazon FSx for Windows File Server file system.</p>
|
|
26
|
+
* <p>Creates an endpoint for an Amazon FSx for Windows File Server file system that DataSync can use for a data transfer.</p>
|
|
27
|
+
* <p>Before you begin, make sure that you understand how DataSync <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-location-access">accesses an FSx for Windows File Server</a>.</p>
|
|
27
28
|
* @example
|
|
28
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
30
|
* ```javascript
|
|
@@ -23,9 +23,11 @@ export interface DeleteAgentCommandOutput extends DeleteAgentResponse, __Metadat
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>
|
|
27
|
-
*
|
|
28
|
-
*
|
|
26
|
+
* <p>Removes an DataSync agent resource from your Amazon Web Services account.</p>
|
|
27
|
+
* <p>Keep in mind that this operation (which can't be undone) doesn't remove the agent's
|
|
28
|
+
* virtual machine (VM) or Amazon EC2 instance from your storage environment. For next
|
|
29
|
+
* steps, you can delete the VM or instance from your storage environment or reuse it to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html">activate a new
|
|
30
|
+
* agent</a>.</p>
|
|
29
31
|
* @example
|
|
30
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
33
|
* ```javascript
|
|
@@ -23,7 +23,7 @@ export interface DescribeAgentCommandOutput extends DescribeAgentResponse, __Met
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns
|
|
26
|
+
* <p>Returns information about an DataSync agent, such as its name, service endpoint
|
|
27
27
|
* type, and status.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -53,6 +53,9 @@ export interface DescribeAgentCommandOutput extends DescribeAgentResponse, __Met
|
|
|
53
53
|
* // "STRING_VALUE",
|
|
54
54
|
* // ],
|
|
55
55
|
* // },
|
|
56
|
+
* // Platform: { // Platform
|
|
57
|
+
* // Version: "STRING_VALUE",
|
|
58
|
+
* // },
|
|
56
59
|
* // };
|
|
57
60
|
*
|
|
58
61
|
* ```
|
|
@@ -52,6 +52,9 @@ export interface ListAgentsCommandOutput extends ListAgentsResponse, __MetadataB
|
|
|
52
52
|
* // AgentArn: "STRING_VALUE",
|
|
53
53
|
* // Name: "STRING_VALUE",
|
|
54
54
|
* // Status: "ONLINE" || "OFFLINE",
|
|
55
|
+
* // Platform: { // Platform
|
|
56
|
+
* // Version: "STRING_VALUE",
|
|
57
|
+
* // },
|
|
55
58
|
* // },
|
|
56
59
|
* // ],
|
|
57
60
|
* // NextToken: "STRING_VALUE",
|
|
@@ -23,7 +23,7 @@ export interface UpdateAgentCommandOutput extends UpdateAgentResponse, __Metadat
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Updates the name of an agent.</p>
|
|
26
|
+
* <p>Updates the name of an DataSync agent.</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,9 +23,8 @@ export interface UpdateLocationSmbCommandOutput extends UpdateLocationSmbRespons
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Updates some of the parameters of a
|
|
27
|
-
* (SMB) file
|
|
28
|
-
* location for SMB</a>.</p>
|
|
26
|
+
* <p>Updates some of the parameters of a Server Message Block
|
|
27
|
+
* (SMB) file server location that you can use for DataSync transfers.</p>
|
|
29
28
|
* @example
|
|
30
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
30
|
* ```javascript
|
package/dist-types/index.d.ts
CHANGED
|
@@ -17,4 +17,5 @@ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
|
|
|
17
17
|
export * from "./commands";
|
|
18
18
|
export * from "./pagination";
|
|
19
19
|
export * from "./models";
|
|
20
|
+
import "@aws-sdk/util-endpoints";
|
|
20
21
|
export { DataSyncServiceException } from "./models/DataSyncServiceException";
|
|
@@ -164,6 +164,21 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
164
164
|
*/
|
|
165
165
|
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
166
166
|
}
|
|
167
|
+
/**
|
|
168
|
+
* @public
|
|
169
|
+
* <p>The platform-related details about the DataSync agent, such as the version
|
|
170
|
+
* number.</p>
|
|
171
|
+
*/
|
|
172
|
+
export interface Platform {
|
|
173
|
+
/**
|
|
174
|
+
* @public
|
|
175
|
+
* <p>The version of the DataSync agent.</p>
|
|
176
|
+
* <important>
|
|
177
|
+
* <p>Beginning December 7, 2023, we will discontinue version 1 DataSync agents. Check the DataSync console to see if you have affected agents. If you do, <a href="https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html">replace</a> those agents before then to avoid data transfer or storage discovery disruptions. If you need more help, contact <a href="https://aws.amazon.com/contact-us/">Amazon Web Services Support</a>.</p>
|
|
178
|
+
* </important>
|
|
179
|
+
*/
|
|
180
|
+
Version?: string;
|
|
181
|
+
}
|
|
167
182
|
/**
|
|
168
183
|
* @public
|
|
169
184
|
* @enum
|
|
@@ -194,10 +209,26 @@ export interface AgentListEntry {
|
|
|
194
209
|
Name?: string;
|
|
195
210
|
/**
|
|
196
211
|
* @public
|
|
197
|
-
* <p>The status of an agent
|
|
198
|
-
*
|
|
212
|
+
* <p>The status of an agent.</p>
|
|
213
|
+
* <ul>
|
|
214
|
+
* <li>
|
|
215
|
+
* <p>If the status is <code>ONLINE</code>, the agent is configured properly and ready to
|
|
216
|
+
* use.</p>
|
|
217
|
+
* </li>
|
|
218
|
+
* <li>
|
|
219
|
+
* <p>If the status is <code>OFFLINE</code>, the agent has been out of contact with
|
|
220
|
+
* DataSync for five minutes or longer. This can happen for a few reasons. For
|
|
221
|
+
* more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline">What do I do if my agent is offline?</a>
|
|
222
|
+
* </p>
|
|
223
|
+
* </li>
|
|
224
|
+
* </ul>
|
|
199
225
|
*/
|
|
200
226
|
Status?: AgentStatus;
|
|
227
|
+
/**
|
|
228
|
+
* @public
|
|
229
|
+
* <p>The platform-related details about the agent, such as the version number.</p>
|
|
230
|
+
*/
|
|
231
|
+
Platform?: Platform;
|
|
201
232
|
}
|
|
202
233
|
/**
|
|
203
234
|
* @public
|
|
@@ -935,19 +966,22 @@ export interface CreateLocationFsxWindowsRequest {
|
|
|
935
966
|
* @public
|
|
936
967
|
* <p>Specifies the user who has the permissions to access files, folders, and metadata in your
|
|
937
968
|
* file system.</p>
|
|
938
|
-
* <p>For information about choosing a user with
|
|
969
|
+
* <p>For information about choosing a user with the right level of access for your transfer, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions">required permissions</a> for FSx for Windows File Server locations.</p>
|
|
939
970
|
*/
|
|
940
971
|
User: string | undefined;
|
|
941
972
|
/**
|
|
942
973
|
* @public
|
|
943
974
|
* <p>Specifies the name of the Windows domain that the FSx for Windows File Server belongs
|
|
944
975
|
* to.</p>
|
|
976
|
+
* <p>If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.</p>
|
|
977
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions">required permissions</a> for FSx for Windows File Server locations.</p>
|
|
945
978
|
*/
|
|
946
979
|
Domain?: string;
|
|
947
980
|
/**
|
|
948
981
|
* @public
|
|
949
982
|
* <p>Specifies the password of the user who has the permissions to access files and folders in
|
|
950
983
|
* the file system.</p>
|
|
984
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions">required permissions</a> for FSx for Windows File Server locations.</p>
|
|
951
985
|
*/
|
|
952
986
|
Password: string | undefined;
|
|
953
987
|
}
|
|
@@ -1458,6 +1492,7 @@ export interface CreateLocationSmbRequest {
|
|
|
1458
1492
|
/**
|
|
1459
1493
|
* @public
|
|
1460
1494
|
* <p>Specifies the Windows domain name that your SMB file server belongs to. </p>
|
|
1495
|
+
* <p>If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.</p>
|
|
1461
1496
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">required permissions</a> for SMB locations.</p>
|
|
1462
1497
|
*/
|
|
1463
1498
|
Domain?: string;
|
|
@@ -1975,7 +2010,7 @@ export interface TaskSchedule {
|
|
|
1975
2010
|
}
|
|
1976
2011
|
/**
|
|
1977
2012
|
* @public
|
|
1978
|
-
* <p>Specifies the Amazon S3 bucket where DataSync uploads your <a href="https://docs.aws.amazon.com/datasync/latest/userguide/
|
|
2013
|
+
* <p>Specifies the Amazon S3 bucket where DataSync uploads your <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">task report</a>.</p>
|
|
1979
2014
|
*/
|
|
1980
2015
|
export interface ReportDestinationS3 {
|
|
1981
2016
|
/**
|
|
@@ -1990,13 +2025,13 @@ export interface ReportDestinationS3 {
|
|
|
1990
2025
|
S3BucketArn: string | undefined;
|
|
1991
2026
|
/**
|
|
1992
2027
|
* @public
|
|
1993
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/https:/docs.aws.amazon.com/datasync/latest/userguide/
|
|
2028
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/https:/docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">Allowing DataSync to upload a task report to an Amazon S3 bucket</a>.</p>
|
|
1994
2029
|
*/
|
|
1995
2030
|
BucketAccessRoleArn: string | undefined;
|
|
1996
2031
|
}
|
|
1997
2032
|
/**
|
|
1998
2033
|
* @public
|
|
1999
|
-
* <p>Specifies where DataSync uploads your <a href="https://docs.aws.amazon.com/datasync/latest/userguide/
|
|
2034
|
+
* <p>Specifies where DataSync uploads your <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">task report</a>.</p>
|
|
2000
2035
|
*/
|
|
2001
2036
|
export interface ReportDestination {
|
|
2002
2037
|
/**
|
|
@@ -2044,7 +2079,7 @@ export type ReportLevel = (typeof ReportLevel)[keyof typeof ReportLevel];
|
|
|
2044
2079
|
/**
|
|
2045
2080
|
* @public
|
|
2046
2081
|
* <p>Specifies the level of detail for a particular aspect of your DataSync
|
|
2047
|
-
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/
|
|
2082
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">task
|
|
2048
2083
|
* report</a>.</p>
|
|
2049
2084
|
*/
|
|
2050
2085
|
export interface ReportOverride {
|
|
@@ -2058,7 +2093,7 @@ export interface ReportOverride {
|
|
|
2058
2093
|
/**
|
|
2059
2094
|
* @public
|
|
2060
2095
|
* <p>The level of detail included in each aspect of your DataSync
|
|
2061
|
-
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/
|
|
2096
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">task
|
|
2062
2097
|
* report</a>.</p>
|
|
2063
2098
|
*/
|
|
2064
2099
|
export interface ReportOverrides {
|
|
@@ -2086,14 +2121,14 @@ export interface ReportOverrides {
|
|
|
2086
2121
|
/**
|
|
2087
2122
|
* @public
|
|
2088
2123
|
* <p>Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.</p>
|
|
2089
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/
|
|
2124
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">Task
|
|
2090
2125
|
* reports</a>.</p>
|
|
2091
2126
|
*/
|
|
2092
2127
|
export interface TaskReportConfig {
|
|
2093
2128
|
/**
|
|
2094
2129
|
* @public
|
|
2095
2130
|
* <p>Specifies the Amazon S3 bucket where DataSync uploads your task report. For more
|
|
2096
|
-
* information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/
|
|
2131
|
+
* information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html#task-report-access">Task reports</a>.</p>
|
|
2097
2132
|
*/
|
|
2098
2133
|
Destination?: ReportDestination;
|
|
2099
2134
|
/**
|
|
@@ -2282,8 +2317,8 @@ export interface DeleteTaskResponse {
|
|
|
2282
2317
|
export interface DescribeAgentRequest {
|
|
2283
2318
|
/**
|
|
2284
2319
|
* @public
|
|
2285
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent
|
|
2286
|
-
*
|
|
2320
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent that you want
|
|
2321
|
+
* information about.</p>
|
|
2287
2322
|
*/
|
|
2288
2323
|
AgentArn: string | undefined;
|
|
2289
2324
|
}
|
|
@@ -2303,8 +2338,7 @@ export type EndpointType = (typeof EndpointType)[keyof typeof EndpointType];
|
|
|
2303
2338
|
/**
|
|
2304
2339
|
* @public
|
|
2305
2340
|
* <p>Specifies how your DataSync agent connects to Amazon Web Services using a
|
|
2306
|
-
* virtual private cloud (VPC) service endpoint
|
|
2307
|
-
* accessible over the public internet.</p>
|
|
2341
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc">virtual private cloud (VPC) service endpoint</a>. An agent that uses a VPC endpoint isn't accessible over the public internet.</p>
|
|
2308
2342
|
*/
|
|
2309
2343
|
export interface PrivateLinkConfig {
|
|
2310
2344
|
/**
|
|
@@ -2347,34 +2381,48 @@ export interface DescribeAgentResponse {
|
|
|
2347
2381
|
Name?: string;
|
|
2348
2382
|
/**
|
|
2349
2383
|
* @public
|
|
2350
|
-
* <p>The status of the agent
|
|
2351
|
-
*
|
|
2352
|
-
*
|
|
2353
|
-
*
|
|
2354
|
-
*
|
|
2384
|
+
* <p>The status of the agent.</p>
|
|
2385
|
+
* <ul>
|
|
2386
|
+
* <li>
|
|
2387
|
+
* <p>If the status is <code>ONLINE</code>, the agent is configured properly and ready to
|
|
2388
|
+
* use.</p>
|
|
2389
|
+
* </li>
|
|
2390
|
+
* <li>
|
|
2391
|
+
* <p>If the status is <code>OFFLINE</code>, the agent has been out of contact with
|
|
2392
|
+
* DataSync for five minutes or longer. This can happen for a few reasons. For
|
|
2393
|
+
* more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline">What do I do if my agent is offline?</a>
|
|
2394
|
+
* </p>
|
|
2395
|
+
* </li>
|
|
2396
|
+
* </ul>
|
|
2355
2397
|
*/
|
|
2356
2398
|
Status?: AgentStatus;
|
|
2357
2399
|
/**
|
|
2358
2400
|
* @public
|
|
2359
|
-
* <p>The time that the agent
|
|
2401
|
+
* <p>The last time that the agent was communicating with the DataSync
|
|
2402
|
+
* service.</p>
|
|
2360
2403
|
*/
|
|
2361
2404
|
LastConnectionTime?: Date;
|
|
2362
2405
|
/**
|
|
2363
2406
|
* @public
|
|
2364
|
-
* <p>The time that the agent was activated
|
|
2407
|
+
* <p>The time that the agent was <a href="https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html">activated</a>.</p>
|
|
2365
2408
|
*/
|
|
2366
2409
|
CreationTime?: Date;
|
|
2367
2410
|
/**
|
|
2368
2411
|
* @public
|
|
2369
|
-
* <p>The type of endpoint that your agent is connected to
|
|
2370
|
-
* the agent is not accessible over the public internet. </p>
|
|
2412
|
+
* <p>The type of <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html">service endpoint</a> that your agent is connected to.</p>
|
|
2371
2413
|
*/
|
|
2372
2414
|
EndpointType?: EndpointType;
|
|
2373
2415
|
/**
|
|
2374
2416
|
* @public
|
|
2375
|
-
* <p>The
|
|
2417
|
+
* <p>The network configuration that the agent uses when connecting to a <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc">VPC
|
|
2418
|
+
* service endpoint</a>.</p>
|
|
2376
2419
|
*/
|
|
2377
2420
|
PrivateLinkConfig?: PrivateLinkConfig;
|
|
2421
|
+
/**
|
|
2422
|
+
* @public
|
|
2423
|
+
* <p>The platform-related details about the agent, such as the version number.</p>
|
|
2424
|
+
*/
|
|
2425
|
+
Platform?: Platform;
|
|
2378
2426
|
}
|
|
2379
2427
|
/**
|
|
2380
2428
|
* @public
|
|
@@ -3905,7 +3953,7 @@ export interface DescribeTaskResponse {
|
|
|
3905
3953
|
Includes?: FilterRule[];
|
|
3906
3954
|
/**
|
|
3907
3955
|
* @public
|
|
3908
|
-
* <p>The configuration of your task report. For more information, see <a href="https://docs.aws.amazon.com/
|
|
3956
|
+
* <p>The configuration of your task report. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">Creating a task report</a>.</p>
|
|
3909
3957
|
*/
|
|
3910
3958
|
TaskReportConfig?: TaskReportConfig;
|
|
3911
3959
|
}
|
|
@@ -3936,7 +3984,7 @@ export declare const PhaseStatus: {
|
|
|
3936
3984
|
export type PhaseStatus = (typeof PhaseStatus)[keyof typeof PhaseStatus];
|
|
3937
3985
|
/**
|
|
3938
3986
|
* @public
|
|
3939
|
-
* <p>Indicates whether DataSync created a complete <a href="https://docs.aws.amazon.com/datasync/latest/userguide/
|
|
3987
|
+
* <p>Indicates whether DataSync created a complete <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">task report</a> for your
|
|
3940
3988
|
* transfer.</p>
|
|
3941
3989
|
*/
|
|
3942
3990
|
export interface ReportResult {
|
|
@@ -4153,11 +4201,16 @@ export interface DescribeTaskExecutionResponse {
|
|
|
4153
4201
|
* @public
|
|
4154
4202
|
* <p>The number of files, objects, and directories that DataSync verified during your
|
|
4155
4203
|
* transfer.</p>
|
|
4204
|
+
* <note>
|
|
4205
|
+
* <p>When you configure your task to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-data-verification-options.html">verify only the
|
|
4206
|
+
* data that's transferred</a>, DataSync doesn't verify directories in some
|
|
4207
|
+
* situations or files that fail to transfer.</p>
|
|
4208
|
+
* </note>
|
|
4156
4209
|
*/
|
|
4157
4210
|
FilesVerified?: number;
|
|
4158
4211
|
/**
|
|
4159
4212
|
* @public
|
|
4160
|
-
* <p>Indicates whether DataSync generated a complete <a href="https://docs.aws.amazon.com/datasync/latest/userguide/
|
|
4213
|
+
* <p>Indicates whether DataSync generated a complete <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">task report</a> for your
|
|
4161
4214
|
* transfer.</p>
|
|
4162
4215
|
*/
|
|
4163
4216
|
ReportResult?: ReportResult;
|
|
@@ -5142,58 +5195,44 @@ export interface UpdateLocationObjectStorageResponse {
|
|
|
5142
5195
|
export interface UpdateLocationSmbRequest {
|
|
5143
5196
|
/**
|
|
5144
5197
|
* @public
|
|
5145
|
-
* <p>
|
|
5198
|
+
* <p>Specifies the ARN of the SMB location that you want to update.</p>
|
|
5146
5199
|
*/
|
|
5147
5200
|
LocationArn: string | undefined;
|
|
5148
5201
|
/**
|
|
5149
5202
|
* @public
|
|
5150
|
-
* <p>
|
|
5151
|
-
*
|
|
5152
|
-
*
|
|
5153
|
-
*
|
|
5154
|
-
* <
|
|
5155
|
-
*
|
|
5156
|
-
* <code>Subdirectory</code> must be specified with forward slashes. For example,
|
|
5157
|
-
* <code>/path/to/folder</code>.</p>
|
|
5158
|
-
* </note>
|
|
5159
|
-
* <p>To transfer all the data in the folder that you specified, DataSync must have
|
|
5160
|
-
* permissions to mount the SMB share and to access all the data in that share. To ensure this,
|
|
5161
|
-
* do either of the following:</p>
|
|
5162
|
-
* <ul>
|
|
5163
|
-
* <li>
|
|
5164
|
-
* <p>Ensure that the user/password specified belongs to the user who can mount the share
|
|
5165
|
-
* and who has the appropriate permissions for all of the files and directories that you want
|
|
5166
|
-
* DataSync to access.</p>
|
|
5167
|
-
* </li>
|
|
5168
|
-
* <li>
|
|
5169
|
-
* <p>Use credentials of a member of the Backup Operators group to mount the share. </p>
|
|
5170
|
-
* </li>
|
|
5171
|
-
* </ul>
|
|
5172
|
-
* <p>Doing either of these options enables the agent to access the data. For the agent to
|
|
5173
|
-
* access directories, you must also enable all execute access.</p>
|
|
5203
|
+
* <p>Specifies the name of the share exported by your SMB file server where DataSync
|
|
5204
|
+
* will read or write data. You can include a subdirectory in the share path (for example,
|
|
5205
|
+
* <code>/path/to/subdirectory</code>). Make sure that other SMB clients in your network can
|
|
5206
|
+
* also mount this path.</p>
|
|
5207
|
+
* <p>To copy all data in the specified subdirectory, DataSync must be able to mount
|
|
5208
|
+
* the SMB share and access all of its data. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">required permissions</a> for SMB locations.</p>
|
|
5174
5209
|
*/
|
|
5175
5210
|
Subdirectory?: string;
|
|
5176
5211
|
/**
|
|
5177
5212
|
* @public
|
|
5178
|
-
* <p>
|
|
5179
|
-
*
|
|
5213
|
+
* <p>Specifies the user name that can mount your SMB file server and has permission to access
|
|
5214
|
+
* the files and folders involved in your transfer.</p>
|
|
5215
|
+
* <p>For information about choosing a user with the right level of access for your transfer,
|
|
5216
|
+
* see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">required permissions</a> for SMB locations.</p>
|
|
5180
5217
|
*/
|
|
5181
5218
|
User?: string;
|
|
5182
5219
|
/**
|
|
5183
5220
|
* @public
|
|
5184
|
-
* <p>
|
|
5221
|
+
* <p>Specifies the Windows domain name that your SMB file server belongs to. </p>
|
|
5222
|
+
* <p>If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.</p>
|
|
5223
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">required permissions</a> for SMB locations.</p>
|
|
5185
5224
|
*/
|
|
5186
5225
|
Domain?: string;
|
|
5187
5226
|
/**
|
|
5188
5227
|
* @public
|
|
5189
|
-
* <p>
|
|
5190
|
-
* folders in
|
|
5228
|
+
* <p>Specifies the password of the user who can mount your SMB file server and has permission
|
|
5229
|
+
* to access the files and folders involved in your transfer.</p>
|
|
5230
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">required permissions</a> for SMB locations.</p>
|
|
5191
5231
|
*/
|
|
5192
5232
|
Password?: string;
|
|
5193
5233
|
/**
|
|
5194
5234
|
* @public
|
|
5195
|
-
* <p>
|
|
5196
|
-
* location.</p>
|
|
5235
|
+
* <p>Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).</p>
|
|
5197
5236
|
*/
|
|
5198
5237
|
AgentArns?: string[];
|
|
5199
5238
|
/**
|
|
@@ -4,4 +4,5 @@ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
|
|
|
4
4
|
export * from "./commands";
|
|
5
5
|
export * from "./pagination";
|
|
6
6
|
export * from "./models";
|
|
7
|
+
import "@aws-sdk/util-endpoints";
|
|
7
8
|
export { DataSyncServiceException } from "./models/DataSyncServiceException";
|
|
@@ -45,6 +45,9 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
45
45
|
opts: __ExceptionOptionType<InvalidRequestException, __BaseException>
|
|
46
46
|
);
|
|
47
47
|
}
|
|
48
|
+
export interface Platform {
|
|
49
|
+
Version?: string;
|
|
50
|
+
}
|
|
48
51
|
export declare const AgentStatus: {
|
|
49
52
|
readonly OFFLINE: "OFFLINE";
|
|
50
53
|
readonly ONLINE: "ONLINE";
|
|
@@ -54,6 +57,7 @@ export interface AgentListEntry {
|
|
|
54
57
|
AgentArn?: string;
|
|
55
58
|
Name?: string;
|
|
56
59
|
Status?: AgentStatus;
|
|
60
|
+
Platform?: Platform;
|
|
57
61
|
}
|
|
58
62
|
export declare const Atime: {
|
|
59
63
|
readonly BEST_EFFORT: "BEST_EFFORT";
|
|
@@ -526,6 +530,7 @@ export interface DescribeAgentResponse {
|
|
|
526
530
|
CreationTime?: Date;
|
|
527
531
|
EndpointType?: EndpointType;
|
|
528
532
|
PrivateLinkConfig?: PrivateLinkConfig;
|
|
533
|
+
Platform?: Platform;
|
|
529
534
|
}
|
|
530
535
|
export interface DescribeDiscoveryJobRequest {
|
|
531
536
|
DiscoveryJobArn: string | undefined;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-datasync",
|
|
3
3
|
"description": "AWS SDK for JavaScript Datasync Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.439.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,17 +21,17 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.438.0",
|
|
25
25
|
"@aws-sdk/core": "3.436.0",
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.438.0",
|
|
27
27
|
"@aws-sdk/middleware-host-header": "3.433.0",
|
|
28
28
|
"@aws-sdk/middleware-logger": "3.433.0",
|
|
29
29
|
"@aws-sdk/middleware-recursion-detection": "3.433.0",
|
|
30
30
|
"@aws-sdk/middleware-signing": "3.433.0",
|
|
31
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
31
|
+
"@aws-sdk/middleware-user-agent": "3.438.0",
|
|
32
32
|
"@aws-sdk/region-config-resolver": "3.433.0",
|
|
33
33
|
"@aws-sdk/types": "3.433.0",
|
|
34
|
-
"@aws-sdk/util-endpoints": "3.
|
|
34
|
+
"@aws-sdk/util-endpoints": "3.438.0",
|
|
35
35
|
"@aws-sdk/util-user-agent-browser": "3.433.0",
|
|
36
36
|
"@aws-sdk/util-user-agent-node": "3.437.0",
|
|
37
37
|
"@smithy/config-resolver": "^2.0.16",
|
|
@@ -54,6 +54,7 @@
|
|
|
54
54
|
"@smithy/util-body-length-node": "^2.1.0",
|
|
55
55
|
"@smithy/util-defaults-mode-browser": "^2.0.16",
|
|
56
56
|
"@smithy/util-defaults-mode-node": "^2.0.21",
|
|
57
|
+
"@smithy/util-endpoints": "^1.0.2",
|
|
57
58
|
"@smithy/util-retry": "^2.0.5",
|
|
58
59
|
"@smithy/util-utf8": "^2.0.0",
|
|
59
60
|
"tslib": "^2.5.0",
|