@aws-sdk/client-datasync 3.812.0 → 3.814.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 +3 -107
- package/dist-cjs/index.js +26 -890
- package/dist-es/DataSync.js +0 -26
- package/dist-es/commands/index.js +0 -13
- package/dist-es/models/models_0.js +18 -62
- package/dist-es/pagination/index.js +0 -4
- package/dist-es/protocols/Aws_json1_1.js +2 -554
- package/dist-types/DataSync.d.ts +3 -96
- package/dist-types/DataSyncClient.d.ts +5 -18
- package/dist-types/commands/CreateAgentCommand.d.ts +2 -1
- package/dist-types/commands/CreateLocationFsxLustreCommand.d.ts +3 -3
- package/dist-types/commands/CreateLocationFsxOpenZfsCommand.d.ts +5 -4
- package/dist-types/commands/CreateLocationHdfsCommand.d.ts +2 -2
- package/dist-types/commands/CreateLocationNfsCommand.d.ts +2 -2
- package/dist-types/commands/CreateLocationObjectStorageCommand.d.ts +1 -2
- package/dist-types/commands/CreateLocationS3Command.d.ts +4 -2
- package/dist-types/commands/CreateTaskCommand.d.ts +4 -3
- package/dist-types/commands/DescribeAgentCommand.d.ts +2 -2
- package/dist-types/commands/DescribeLocationAzureBlobCommand.d.ts +2 -1
- package/dist-types/commands/DescribeTaskCommand.d.ts +2 -1
- package/dist-types/commands/UpdateLocationAzureBlobCommand.d.ts +2 -1
- package/dist-types/commands/UpdateLocationEfsCommand.d.ts +4 -2
- package/dist-types/commands/UpdateLocationFsxLustreCommand.d.ts +4 -2
- package/dist-types/commands/UpdateLocationFsxOntapCommand.d.ts +4 -2
- package/dist-types/commands/UpdateLocationFsxOpenZfsCommand.d.ts +5 -3
- package/dist-types/commands/UpdateLocationFsxWindowsCommand.d.ts +4 -2
- package/dist-types/commands/UpdateLocationHdfsCommand.d.ts +4 -3
- package/dist-types/commands/UpdateLocationNfsCommand.d.ts +4 -3
- package/dist-types/commands/UpdateLocationObjectStorageCommand.d.ts +4 -2
- package/dist-types/commands/UpdateLocationS3Command.d.ts +3 -2
- package/dist-types/commands/UpdateLocationSmbCommand.d.ts +4 -3
- package/dist-types/commands/UpdateTaskCommand.d.ts +2 -1
- package/dist-types/commands/UpdateTaskExecutionCommand.d.ts +2 -2
- package/dist-types/commands/index.d.ts +0 -13
- package/dist-types/index.d.ts +3 -3
- package/dist-types/models/models_0.d.ts +368 -1499
- package/dist-types/pagination/index.d.ts +0 -4
- package/dist-types/protocols/Aws_json1_1.d.ts +0 -117
- package/dist-types/ts3.4/DataSync.d.ts +0 -229
- package/dist-types/ts3.4/DataSyncClient.d.ts +0 -78
- package/dist-types/ts3.4/commands/index.d.ts +0 -13
- package/dist-types/ts3.4/models/models_0.d.ts +18 -307
- package/dist-types/ts3.4/pagination/index.d.ts +0 -4
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +0 -156
- package/package.json +2 -4
- package/dist-es/commands/AddStorageSystemCommand.js +0 -23
- package/dist-es/commands/DescribeDiscoveryJobCommand.js +0 -22
- package/dist-es/commands/DescribeStorageSystemCommand.js +0 -22
- package/dist-es/commands/DescribeStorageSystemResourceMetricsCommand.js +0 -22
- package/dist-es/commands/DescribeStorageSystemResourcesCommand.js +0 -22
- package/dist-es/commands/GenerateRecommendationsCommand.js +0 -22
- package/dist-es/commands/ListDiscoveryJobsCommand.js +0 -22
- package/dist-es/commands/ListStorageSystemsCommand.js +0 -22
- package/dist-es/commands/RemoveStorageSystemCommand.js +0 -22
- package/dist-es/commands/StartDiscoveryJobCommand.js +0 -22
- package/dist-es/commands/StopDiscoveryJobCommand.js +0 -22
- package/dist-es/commands/UpdateDiscoveryJobCommand.js +0 -22
- package/dist-es/commands/UpdateStorageSystemCommand.js +0 -23
- package/dist-es/pagination/DescribeStorageSystemResourceMetricsPaginator.js +0 -4
- package/dist-es/pagination/DescribeStorageSystemResourcesPaginator.js +0 -4
- package/dist-es/pagination/ListDiscoveryJobsPaginator.js +0 -4
- package/dist-es/pagination/ListStorageSystemsPaginator.js +0 -4
- package/dist-types/commands/AddStorageSystemCommand.d.ts +0 -100
- package/dist-types/commands/DescribeDiscoveryJobCommand.d.ts +0 -84
- package/dist-types/commands/DescribeStorageSystemCommand.d.ts +0 -94
- package/dist-types/commands/DescribeStorageSystemResourceMetricsCommand.d.ts +0 -118
- package/dist-types/commands/DescribeStorageSystemResourcesCommand.d.ts +0 -208
- package/dist-types/commands/GenerateRecommendationsCommand.d.ts +0 -85
- package/dist-types/commands/ListDiscoveryJobsCommand.d.ts +0 -88
- package/dist-types/commands/ListStorageSystemsCommand.d.ts +0 -86
- package/dist-types/commands/RemoveStorageSystemCommand.d.ts +0 -78
- package/dist-types/commands/StartDiscoveryJobCommand.d.ts +0 -89
- package/dist-types/commands/StopDiscoveryJobCommand.d.ts +0 -80
- package/dist-types/commands/UpdateDiscoveryJobCommand.d.ts +0 -78
- package/dist-types/commands/UpdateStorageSystemCommand.d.ts +0 -91
- package/dist-types/pagination/DescribeStorageSystemResourceMetricsPaginator.d.ts +0 -7
- package/dist-types/pagination/DescribeStorageSystemResourcesPaginator.d.ts +0 -7
- package/dist-types/pagination/ListDiscoveryJobsPaginator.d.ts +0 -7
- package/dist-types/pagination/ListStorageSystemsPaginator.d.ts +0 -7
- package/dist-types/ts3.4/commands/AddStorageSystemCommand.d.ts +0 -50
- package/dist-types/ts3.4/commands/DescribeDiscoveryJobCommand.d.ts +0 -51
- package/dist-types/ts3.4/commands/DescribeStorageSystemCommand.d.ts +0 -51
- package/dist-types/ts3.4/commands/DescribeStorageSystemResourceMetricsCommand.d.ts +0 -51
- package/dist-types/ts3.4/commands/DescribeStorageSystemResourcesCommand.d.ts +0 -51
- package/dist-types/ts3.4/commands/GenerateRecommendationsCommand.d.ts +0 -51
- package/dist-types/ts3.4/commands/ListDiscoveryJobsCommand.d.ts +0 -51
- package/dist-types/ts3.4/commands/ListStorageSystemsCommand.d.ts +0 -51
- package/dist-types/ts3.4/commands/RemoveStorageSystemCommand.d.ts +0 -51
- package/dist-types/ts3.4/commands/StartDiscoveryJobCommand.d.ts +0 -51
- package/dist-types/ts3.4/commands/StopDiscoveryJobCommand.d.ts +0 -50
- package/dist-types/ts3.4/commands/UpdateDiscoveryJobCommand.d.ts +0 -51
- package/dist-types/ts3.4/commands/UpdateStorageSystemCommand.d.ts +0 -51
- package/dist-types/ts3.4/pagination/DescribeStorageSystemResourceMetricsPaginator.d.ts +0 -11
- package/dist-types/ts3.4/pagination/DescribeStorageSystemResourcesPaginator.d.ts +0 -11
- package/dist-types/ts3.4/pagination/ListDiscoveryJobsPaginator.d.ts +0 -11
- package/dist-types/ts3.4/pagination/ListStorageSystemsPaginator.d.ts +0 -11
|
@@ -1,169 +1,5 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { DataSyncServiceException as __BaseException } from "./DataSyncServiceException";
|
|
3
|
-
/**
|
|
4
|
-
* <p>The credentials that provide DataSync Discovery read access to your on-premises storage system's
|
|
5
|
-
* management interface.</p>
|
|
6
|
-
* <p>DataSync Discovery stores these credentials in <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">Secrets Manager</a>. For more
|
|
7
|
-
* information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-configure-storage.html">Accessing your on-premises
|
|
8
|
-
* storage system</a>.</p>
|
|
9
|
-
* @public
|
|
10
|
-
*/
|
|
11
|
-
export interface Credentials {
|
|
12
|
-
/**
|
|
13
|
-
* <p>Specifies the user name for your storage system's management interface.</p>
|
|
14
|
-
* @public
|
|
15
|
-
*/
|
|
16
|
-
Username: string | undefined;
|
|
17
|
-
/**
|
|
18
|
-
* <p>Specifies the password for your storage system's management interface.</p>
|
|
19
|
-
* @public
|
|
20
|
-
*/
|
|
21
|
-
Password: string | undefined;
|
|
22
|
-
}
|
|
23
|
-
/**
|
|
24
|
-
* <p>The network settings that DataSync Discovery uses to connect with your on-premises storage system's
|
|
25
|
-
* management interface.</p>
|
|
26
|
-
* @public
|
|
27
|
-
*/
|
|
28
|
-
export interface DiscoveryServerConfiguration {
|
|
29
|
-
/**
|
|
30
|
-
* <p>The domain name or IP address of your storage system's management interface.</p>
|
|
31
|
-
* @public
|
|
32
|
-
*/
|
|
33
|
-
ServerHostname: string | undefined;
|
|
34
|
-
/**
|
|
35
|
-
* <p>The network port for accessing the storage system's management interface.</p>
|
|
36
|
-
* @public
|
|
37
|
-
*/
|
|
38
|
-
ServerPort?: number | undefined;
|
|
39
|
-
}
|
|
40
|
-
/**
|
|
41
|
-
* @public
|
|
42
|
-
* @enum
|
|
43
|
-
*/
|
|
44
|
-
export declare const DiscoverySystemType: {
|
|
45
|
-
readonly NetAppONTAP: "NetAppONTAP";
|
|
46
|
-
};
|
|
47
|
-
/**
|
|
48
|
-
* @public
|
|
49
|
-
*/
|
|
50
|
-
export type DiscoverySystemType = (typeof DiscoverySystemType)[keyof typeof DiscoverySystemType];
|
|
51
|
-
/**
|
|
52
|
-
* <p>A key-value pair representing a single tag that's been applied to an Amazon Web Services
|
|
53
|
-
* resource.</p>
|
|
54
|
-
* @public
|
|
55
|
-
*/
|
|
56
|
-
export interface TagListEntry {
|
|
57
|
-
/**
|
|
58
|
-
* <p>The key for an Amazon Web Services resource tag.</p>
|
|
59
|
-
* @public
|
|
60
|
-
*/
|
|
61
|
-
Key: string | undefined;
|
|
62
|
-
/**
|
|
63
|
-
* <p>The value for an Amazon Web Services resource tag.</p>
|
|
64
|
-
* @public
|
|
65
|
-
*/
|
|
66
|
-
Value?: string | undefined;
|
|
67
|
-
}
|
|
68
|
-
/**
|
|
69
|
-
* @public
|
|
70
|
-
*/
|
|
71
|
-
export interface AddStorageSystemRequest {
|
|
72
|
-
/**
|
|
73
|
-
* <p>Specifies the server name and network port required to connect with the management
|
|
74
|
-
* interface of your on-premises storage system.</p>
|
|
75
|
-
* @public
|
|
76
|
-
*/
|
|
77
|
-
ServerConfiguration: DiscoveryServerConfiguration | undefined;
|
|
78
|
-
/**
|
|
79
|
-
* <p>Specifies the type of on-premises storage system that you want DataSync Discovery to collect
|
|
80
|
-
* information about.</p>
|
|
81
|
-
* <note>
|
|
82
|
-
* <p>DataSync Discovery currently supports NetApp
|
|
83
|
-
* Fabric-Attached
|
|
84
|
-
* Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or
|
|
85
|
-
* later.</p>
|
|
86
|
-
* </note>
|
|
87
|
-
* @public
|
|
88
|
-
*/
|
|
89
|
-
SystemType: DiscoverySystemType | undefined;
|
|
90
|
-
/**
|
|
91
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to
|
|
92
|
-
* and reads from your on-premises storage system's management interface. You can only specify
|
|
93
|
-
* one ARN.</p>
|
|
94
|
-
* @public
|
|
95
|
-
*/
|
|
96
|
-
AgentArns: string[] | undefined;
|
|
97
|
-
/**
|
|
98
|
-
* <p>Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging
|
|
99
|
-
* discovery job events.</p>
|
|
100
|
-
* @public
|
|
101
|
-
*/
|
|
102
|
-
CloudWatchLogGroupArn?: string | undefined;
|
|
103
|
-
/**
|
|
104
|
-
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
|
|
105
|
-
* resources. We recommend creating at least a name tag for your on-premises storage
|
|
106
|
-
* system.</p>
|
|
107
|
-
* @public
|
|
108
|
-
*/
|
|
109
|
-
Tags?: TagListEntry[] | undefined;
|
|
110
|
-
/**
|
|
111
|
-
* <p>Specifies a familiar name for your on-premises storage system.</p>
|
|
112
|
-
* @public
|
|
113
|
-
*/
|
|
114
|
-
Name?: string | undefined;
|
|
115
|
-
/**
|
|
116
|
-
* <p>Specifies a client token to make sure requests with this API operation are idempotent. If
|
|
117
|
-
* you don't specify a client token, DataSync generates one for you
|
|
118
|
-
* automatically.</p>
|
|
119
|
-
* @public
|
|
120
|
-
*/
|
|
121
|
-
ClientToken?: string | undefined;
|
|
122
|
-
/**
|
|
123
|
-
* <p>Specifies the user name and password for accessing your on-premises storage system's
|
|
124
|
-
* management interface.</p>
|
|
125
|
-
* @public
|
|
126
|
-
*/
|
|
127
|
-
Credentials: Credentials | undefined;
|
|
128
|
-
}
|
|
129
|
-
/**
|
|
130
|
-
* @public
|
|
131
|
-
*/
|
|
132
|
-
export interface AddStorageSystemResponse {
|
|
133
|
-
/**
|
|
134
|
-
* <p>The ARN of the on-premises storage system that you can use with DataSync Discovery.</p>
|
|
135
|
-
* @public
|
|
136
|
-
*/
|
|
137
|
-
StorageSystemArn: string | undefined;
|
|
138
|
-
}
|
|
139
|
-
/**
|
|
140
|
-
* <p>This exception is thrown when an error occurs in the DataSync
|
|
141
|
-
* service.</p>
|
|
142
|
-
* @public
|
|
143
|
-
*/
|
|
144
|
-
export declare class InternalException extends __BaseException {
|
|
145
|
-
readonly name: "InternalException";
|
|
146
|
-
readonly $fault: "server";
|
|
147
|
-
errorCode?: string | undefined;
|
|
148
|
-
/**
|
|
149
|
-
* @internal
|
|
150
|
-
*/
|
|
151
|
-
constructor(opts: __ExceptionOptionType<InternalException, __BaseException>);
|
|
152
|
-
}
|
|
153
|
-
/**
|
|
154
|
-
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
155
|
-
* @public
|
|
156
|
-
*/
|
|
157
|
-
export declare class InvalidRequestException extends __BaseException {
|
|
158
|
-
readonly name: "InvalidRequestException";
|
|
159
|
-
readonly $fault: "client";
|
|
160
|
-
errorCode?: string | undefined;
|
|
161
|
-
datasyncErrorCode?: string | undefined;
|
|
162
|
-
/**
|
|
163
|
-
* @internal
|
|
164
|
-
*/
|
|
165
|
-
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
166
|
-
}
|
|
167
3
|
/**
|
|
168
4
|
* <p>The platform-related details about the DataSync agent, such as the version
|
|
169
5
|
* number.</p>
|
|
@@ -213,7 +49,7 @@ export interface AgentListEntry {
|
|
|
213
49
|
* </li>
|
|
214
50
|
* <li>
|
|
215
51
|
* <p>If the status is <code>OFFLINE</code>, the agent has been out of contact with
|
|
216
|
-
*
|
|
52
|
+
* DataSync for five minutes or longer. This can happen for a few reasons. For
|
|
217
53
|
* 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>
|
|
218
54
|
* </p>
|
|
219
55
|
* </li>
|
|
@@ -264,7 +100,8 @@ export declare const AzureBlobAuthenticationType: {
|
|
|
264
100
|
*/
|
|
265
101
|
export type AzureBlobAuthenticationType = (typeof AzureBlobAuthenticationType)[keyof typeof AzureBlobAuthenticationType];
|
|
266
102
|
/**
|
|
267
|
-
* <p>The shared access signature (SAS) configuration that allows DataSync to
|
|
103
|
+
* <p>The shared access signature (SAS) configuration that allows DataSync to
|
|
104
|
+
* access your Microsoft Azure Blob Storage.</p>
|
|
268
105
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-sas-tokens">SAS
|
|
269
106
|
* tokens</a> for accessing your Azure Blob Storage.</p>
|
|
270
107
|
* @public
|
|
@@ -272,7 +109,8 @@ export type AzureBlobAuthenticationType = (typeof AzureBlobAuthenticationType)[k
|
|
|
272
109
|
export interface AzureBlobSasConfiguration {
|
|
273
110
|
/**
|
|
274
111
|
* <p>Specifies a SAS token that provides permissions to access your Azure Blob Storage.</p>
|
|
275
|
-
* <p>The token is part of the SAS URI string that comes after the storage resource URI and a
|
|
112
|
+
* <p>The token is part of the SAS URI string that comes after the storage resource URI and a
|
|
113
|
+
* question mark. A token looks something like this:</p>
|
|
276
114
|
* <p>
|
|
277
115
|
* <code>sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D</code>
|
|
278
116
|
* </p>
|
|
@@ -308,32 +146,49 @@ export interface CancelTaskExecutionRequest {
|
|
|
308
146
|
export interface CancelTaskExecutionResponse {
|
|
309
147
|
}
|
|
310
148
|
/**
|
|
311
|
-
* <p>
|
|
312
|
-
*
|
|
149
|
+
* <p>This exception is thrown when an error occurs in the DataSync
|
|
150
|
+
* service.</p>
|
|
313
151
|
* @public
|
|
314
152
|
*/
|
|
315
|
-
export
|
|
153
|
+
export declare class InternalException extends __BaseException {
|
|
154
|
+
readonly name: "InternalException";
|
|
155
|
+
readonly $fault: "server";
|
|
156
|
+
errorCode?: string | undefined;
|
|
316
157
|
/**
|
|
317
|
-
*
|
|
318
|
-
* @public
|
|
158
|
+
* @internal
|
|
319
159
|
*/
|
|
320
|
-
|
|
160
|
+
constructor(opts: __ExceptionOptionType<InternalException, __BaseException>);
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* <p>This exception is thrown when the client submits a malformed request.</p>
|
|
164
|
+
* @public
|
|
165
|
+
*/
|
|
166
|
+
export declare class InvalidRequestException extends __BaseException {
|
|
167
|
+
readonly name: "InvalidRequestException";
|
|
168
|
+
readonly $fault: "client";
|
|
169
|
+
errorCode?: string | undefined;
|
|
170
|
+
datasyncErrorCode?: string | undefined;
|
|
321
171
|
/**
|
|
322
|
-
*
|
|
323
|
-
* @public
|
|
172
|
+
* @internal
|
|
324
173
|
*/
|
|
325
|
-
|
|
174
|
+
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* <p>A key-value pair representing a single tag that's been applied to an Amazon Web Services
|
|
178
|
+
* resource.</p>
|
|
179
|
+
* @public
|
|
180
|
+
*/
|
|
181
|
+
export interface TagListEntry {
|
|
326
182
|
/**
|
|
327
|
-
* <p>The
|
|
328
|
-
* compression or deduplication.</p>
|
|
183
|
+
* <p>The key for an Amazon Web Services resource tag.</p>
|
|
329
184
|
* @public
|
|
330
185
|
*/
|
|
331
|
-
|
|
186
|
+
Key: string | undefined;
|
|
332
187
|
/**
|
|
333
|
-
* <p>The
|
|
188
|
+
* <p>The value for an Amazon Web Services resource tag.</p>
|
|
334
189
|
* @public
|
|
335
190
|
*/
|
|
336
|
-
|
|
191
|
+
Value?: string | undefined;
|
|
337
192
|
}
|
|
338
193
|
/**
|
|
339
194
|
* <p>CreateAgentRequest</p>
|
|
@@ -353,14 +208,14 @@ export interface CreateAgentRequest {
|
|
|
353
208
|
*/
|
|
354
209
|
AgentName?: string | undefined;
|
|
355
210
|
/**
|
|
356
|
-
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
|
|
357
|
-
* We recommend creating at least one tag for your agent.</p>
|
|
211
|
+
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.</p>
|
|
358
212
|
* @public
|
|
359
213
|
*/
|
|
360
214
|
Tags?: TagListEntry[] | undefined;
|
|
361
215
|
/**
|
|
362
|
-
* <p>Specifies the ID of the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#datasync-in-vpc">VPC service
|
|
363
|
-
*
|
|
216
|
+
* <p>Specifies the ID of the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#datasync-in-vpc">VPC service
|
|
217
|
+
* endpoint</a> that you're using. For example, a VPC endpoint ID looks like
|
|
218
|
+
* <code>vpce-01234d5aff67890e1</code>.</p>
|
|
364
219
|
* <important>
|
|
365
220
|
* <p>The VPC service endpoint you use must include the DataSync service name (for
|
|
366
221
|
* example, <code>com.amazonaws.us-east-2.datasync</code>).</p>
|
|
@@ -403,12 +258,15 @@ export interface CreateLocationAzureBlobRequest {
|
|
|
403
258
|
*/
|
|
404
259
|
ContainerUrl: string | undefined;
|
|
405
260
|
/**
|
|
406
|
-
* <p>Specifies the authentication method DataSync uses to access your Azure Blob
|
|
261
|
+
* <p>Specifies the authentication method DataSync uses to access your Azure Blob
|
|
262
|
+
* Storage. DataSync can access blob storage using a shared access signature
|
|
263
|
+
* (SAS).</p>
|
|
407
264
|
* @public
|
|
408
265
|
*/
|
|
409
266
|
AuthenticationType: AzureBlobAuthenticationType | undefined;
|
|
410
267
|
/**
|
|
411
|
-
* <p>Specifies the SAS configuration that allows DataSync to access your Azure Blob
|
|
268
|
+
* <p>Specifies the SAS configuration that allows DataSync to access your Azure Blob
|
|
269
|
+
* Storage.</p>
|
|
412
270
|
* @public
|
|
413
271
|
*/
|
|
414
272
|
SasConfiguration?: AzureBlobSasConfiguration | undefined;
|
|
@@ -420,7 +278,8 @@ export interface CreateLocationAzureBlobRequest {
|
|
|
420
278
|
*/
|
|
421
279
|
BlobType?: AzureBlobType | undefined;
|
|
422
280
|
/**
|
|
423
|
-
* <p>Specifies the access tier that you want your objects or files transferred into. This only
|
|
281
|
+
* <p>Specifies the access tier that you want your objects or files transferred into. This only
|
|
282
|
+
* applies when using the location as a transfer destination. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers">Access tiers</a>.</p>
|
|
424
283
|
* @public
|
|
425
284
|
*/
|
|
426
285
|
AccessTier?: AzureAccessTier | undefined;
|
|
@@ -431,14 +290,16 @@ export interface CreateLocationAzureBlobRequest {
|
|
|
431
290
|
*/
|
|
432
291
|
Subdirectory?: string | undefined;
|
|
433
292
|
/**
|
|
434
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect
|
|
293
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect
|
|
294
|
+
* with your Azure Blob Storage container.</p>
|
|
435
295
|
* <p>You can specify more than one agent. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html">Using multiple
|
|
436
296
|
* agents for your transfer</a>.</p>
|
|
437
297
|
* @public
|
|
438
298
|
*/
|
|
439
299
|
AgentArns: string[] | undefined;
|
|
440
300
|
/**
|
|
441
|
-
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
|
|
301
|
+
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
|
|
302
|
+
* resources. We recommend creating at least a name tag for your transfer location.</p>
|
|
442
303
|
* @public
|
|
443
304
|
*/
|
|
444
305
|
Tags?: TagListEntry[] | undefined;
|
|
@@ -502,7 +363,8 @@ export type EfsInTransitEncryption = (typeof EfsInTransitEncryption)[keyof typeo
|
|
|
502
363
|
*/
|
|
503
364
|
export interface CreateLocationEfsRequest {
|
|
504
365
|
/**
|
|
505
|
-
* <p>Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or
|
|
366
|
+
* <p>Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or
|
|
367
|
+
* destination location).</p>
|
|
506
368
|
* <p>By default, DataSync uses the root directory (or <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html">access point</a> if you provide one by using
|
|
507
369
|
* <code>AccessPointArn</code>). You can also include subdirectories using forward slashes (for
|
|
508
370
|
* example, <code>/path/to/folder</code>).</p>
|
|
@@ -530,13 +392,15 @@ export interface CreateLocationEfsRequest {
|
|
|
530
392
|
/**
|
|
531
393
|
* <p>Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses
|
|
532
394
|
* to mount your Amazon EFS file system.</p>
|
|
533
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam">Accessing
|
|
395
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam">Accessing
|
|
396
|
+
* restricted file systems</a>.</p>
|
|
534
397
|
* @public
|
|
535
398
|
*/
|
|
536
399
|
AccessPointArn?: string | undefined;
|
|
537
400
|
/**
|
|
538
401
|
* <p>Specifies an Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.</p>
|
|
539
|
-
* <p>For information on creating this role, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role">Creating a DataSync
|
|
402
|
+
* <p>For information on creating this role, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role">Creating a DataSync
|
|
403
|
+
* IAM role for file system access</a>.</p>
|
|
540
404
|
* @public
|
|
541
405
|
*/
|
|
542
406
|
FileSystemAccessRoleArn?: string | undefined;
|
|
@@ -567,29 +431,35 @@ export interface CreateLocationEfsResponse {
|
|
|
567
431
|
*/
|
|
568
432
|
export interface CreateLocationFsxLustreRequest {
|
|
569
433
|
/**
|
|
570
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the FSx for Lustre file
|
|
434
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the FSx for Lustre file
|
|
435
|
+
* system.</p>
|
|
571
436
|
* @public
|
|
572
437
|
*/
|
|
573
438
|
FsxFilesystemArn: string | undefined;
|
|
574
439
|
/**
|
|
575
|
-
* <p>Specifies the Amazon Resource Names (ARNs) of up to five security groups that provide
|
|
576
|
-
*
|
|
440
|
+
* <p>Specifies the Amazon Resource Names (ARNs) of up to five security groups that provide
|
|
441
|
+
* access to your FSx for Lustre file system.</p>
|
|
577
442
|
* <p>The security groups must be able to access the file system's ports. The file system must
|
|
578
443
|
* also allow access from the security groups. For information about file system access, see the
|
|
579
|
-
*
|
|
444
|
+
* <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/limit-access-security-groups.html">
|
|
580
445
|
* <i>Amazon FSx for Lustre User Guide</i>
|
|
581
446
|
* </a>.</p>
|
|
582
447
|
* @public
|
|
583
448
|
*/
|
|
584
449
|
SecurityGroupArns: string[] | undefined;
|
|
585
450
|
/**
|
|
586
|
-
* <p>Specifies a mount path for your FSx for Lustre file system. The path can include
|
|
587
|
-
*
|
|
451
|
+
* <p>Specifies a mount path for your FSx for Lustre file system. The path can include
|
|
452
|
+
* subdirectories.</p>
|
|
453
|
+
* <p>When the location is used as a source, DataSync reads data from the mount path.
|
|
454
|
+
* When the location is used as a destination, DataSync writes data to the mount path.
|
|
455
|
+
* If you don't include this parameter, DataSync uses the file system's root directory
|
|
456
|
+
* (<code>/</code>).</p>
|
|
588
457
|
* @public
|
|
589
458
|
*/
|
|
590
459
|
Subdirectory?: string | undefined;
|
|
591
460
|
/**
|
|
592
|
-
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
|
|
461
|
+
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
|
|
462
|
+
* resources. We recommend creating at least a name tag for your location.</p>
|
|
593
463
|
* @public
|
|
594
464
|
*/
|
|
595
465
|
Tags?: TagListEntry[] | undefined;
|
|
@@ -732,16 +602,18 @@ export interface SmbMountOptions {
|
|
|
732
602
|
Version?: SmbVersion | undefined;
|
|
733
603
|
}
|
|
734
604
|
/**
|
|
735
|
-
* <p>Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine
|
|
736
|
-
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access">Providing DataSync access to FSx for ONTAP file systems</a>.</p>
|
|
605
|
+
* <p>Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine
|
|
606
|
+
* (SVM). For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access">Providing DataSync access to FSx for ONTAP file systems</a>.</p>
|
|
737
607
|
* @public
|
|
738
608
|
*/
|
|
739
609
|
export interface FsxProtocolSmb {
|
|
740
610
|
/**
|
|
741
|
-
* <p>Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs
|
|
611
|
+
* <p>Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs
|
|
612
|
+
* to.</p>
|
|
742
613
|
* <p>If you have multiple domains in your environment, configuring this setting makes sure that
|
|
743
|
-
*
|
|
744
|
-
* <p>If you have multiple Active Directory domains in your environment, configuring this
|
|
614
|
+
* DataSync connects to the right SVM.</p>
|
|
615
|
+
* <p>If you have multiple Active Directory domains in your environment, configuring this
|
|
616
|
+
* parameter makes sure that DataSync connects to the right SVM.</p>
|
|
745
617
|
* @public
|
|
746
618
|
*/
|
|
747
619
|
Domain?: string | undefined;
|
|
@@ -756,8 +628,10 @@ export interface FsxProtocolSmb {
|
|
|
756
628
|
*/
|
|
757
629
|
Password: string | undefined;
|
|
758
630
|
/**
|
|
759
|
-
* <p>Specifies a user that can mount and access the files, folders, and metadata in your
|
|
760
|
-
*
|
|
631
|
+
* <p>Specifies a user that can mount and access the files, folders, and metadata in your
|
|
632
|
+
* SVM.</p>
|
|
633
|
+
* <p>For information about choosing a user with the right level of access for your transfer,
|
|
634
|
+
* see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb">Using
|
|
761
635
|
* the SMB protocol</a>.</p>
|
|
762
636
|
* @public
|
|
763
637
|
*/
|
|
@@ -821,7 +695,8 @@ export interface CreateLocationFsxOntapRequest {
|
|
|
821
695
|
*/
|
|
822
696
|
StorageVirtualMachineArn: string | undefined;
|
|
823
697
|
/**
|
|
824
|
-
* <p>Specifies a path to the file share in the SVM where you want to transfer data to or
|
|
698
|
+
* <p>Specifies a path to the file share in the SVM where you want to transfer data to or
|
|
699
|
+
* from.</p>
|
|
825
700
|
* <p>You can specify a junction path (also known as a mount point), qtree path (for NFS file
|
|
826
701
|
* shares), or share name (for SMB file shares). For example, your mount path might be
|
|
827
702
|
* <code>/vol1</code>, <code>/vol1/tree1</code>, or <code>/share1</code>.</p>
|
|
@@ -910,7 +785,8 @@ export interface CreateLocationFsxWindowsRequest {
|
|
|
910
785
|
*/
|
|
911
786
|
FsxFilesystemArn: string | undefined;
|
|
912
787
|
/**
|
|
913
|
-
* <p>Specifies the ARNs of the Amazon EC2 security groups that provide access to your
|
|
788
|
+
* <p>Specifies the ARNs of the Amazon EC2 security groups that provide access to your
|
|
789
|
+
* file system's preferred subnet.</p>
|
|
914
790
|
* <p>The security groups that you specify must be able to communicate with your file system's
|
|
915
791
|
* security groups. For information about configuring security groups for file system access, see
|
|
916
792
|
* the <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html">
|
|
@@ -941,12 +817,14 @@ export interface CreateLocationFsxWindowsRequest {
|
|
|
941
817
|
/**
|
|
942
818
|
* <p>Specifies the user with the permissions to mount and access the files, folders, and file
|
|
943
819
|
* metadata in your FSx for Windows File Server file system.</p>
|
|
944
|
-
* <p>For information about choosing a user with the right level of access for your transfer,
|
|
820
|
+
* <p>For information about choosing a user with the right level of access for your transfer,
|
|
821
|
+
* 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
822
|
* @public
|
|
946
823
|
*/
|
|
947
824
|
User: string | undefined;
|
|
948
825
|
/**
|
|
949
|
-
* <p>Specifies the name of the Windows domain that the FSx for Windows File Server file system
|
|
826
|
+
* <p>Specifies the name of the Windows domain that the FSx for Windows File Server file system
|
|
827
|
+
* belongs to.</p>
|
|
950
828
|
* <p>If you have multiple Active Directory domains in your environment, configuring this
|
|
951
829
|
* parameter makes sure that DataSync connects to the right file system.</p>
|
|
952
830
|
* @public
|
|
@@ -1123,8 +1001,7 @@ export interface CreateLocationHdfsRequest {
|
|
|
1123
1001
|
/**
|
|
1124
1002
|
* <p>The Kerberos key table (keytab) that contains mappings between the defined Kerberos
|
|
1125
1003
|
* principal and the encrypted keys. You can load the keytab from a file by providing the file's
|
|
1126
|
-
* address
|
|
1127
|
-
* Otherwise, provide the base64-encoded text. </p>
|
|
1004
|
+
* address.</p>
|
|
1128
1005
|
* <note>
|
|
1129
1006
|
* <p>If <code>KERBEROS</code> is specified for <code>AuthenticationType</code>, this
|
|
1130
1007
|
* parameter is required. </p>
|
|
@@ -1145,7 +1022,8 @@ export interface CreateLocationHdfsRequest {
|
|
|
1145
1022
|
*/
|
|
1146
1023
|
KerberosKrb5Conf?: Uint8Array | undefined;
|
|
1147
1024
|
/**
|
|
1148
|
-
* <p>The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your
|
|
1025
|
+
* <p>The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your
|
|
1026
|
+
* HDFS cluster.</p>
|
|
1149
1027
|
* @public
|
|
1150
1028
|
*/
|
|
1151
1029
|
AgentArns: string[] | undefined;
|
|
@@ -1173,9 +1051,9 @@ export interface CreateLocationHdfsResponse {
|
|
|
1173
1051
|
*/
|
|
1174
1052
|
export interface OnPremConfig {
|
|
1175
1053
|
/**
|
|
1176
|
-
* <p>The Amazon Resource Names (ARNs) of the DataSync agents that can connect to
|
|
1177
|
-
*
|
|
1178
|
-
*
|
|
1054
|
+
* <p>The Amazon Resource Names (ARNs) of the DataSync agents that can connect to
|
|
1055
|
+
* your NFS file server.</p>
|
|
1056
|
+
* <p>You can specify more than one agent. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#multiple-agents">Using multiple DataSync agents</a>.</p>
|
|
1179
1057
|
* @public
|
|
1180
1058
|
*/
|
|
1181
1059
|
AgentArns: string[] | undefined;
|
|
@@ -1194,16 +1072,14 @@ export interface CreateLocationNfsRequest {
|
|
|
1194
1072
|
*/
|
|
1195
1073
|
Subdirectory: string | undefined;
|
|
1196
1074
|
/**
|
|
1197
|
-
* <p>Specifies the DNS name or IP version 4 address of the NFS file
|
|
1198
|
-
* server that your DataSync agent connects to.</p>
|
|
1075
|
+
* <p>Specifies the DNS name or IP version 4 address of the NFS file server that your DataSync agent connects to.</p>
|
|
1199
1076
|
* @public
|
|
1200
1077
|
*/
|
|
1201
1078
|
ServerHostname: string | undefined;
|
|
1202
1079
|
/**
|
|
1203
1080
|
* <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent that can
|
|
1204
1081
|
* connect to your NFS file server.</p>
|
|
1205
|
-
* <p>You can specify more than one agent. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#multiple-agents">Using multiple DataSync
|
|
1206
|
-
* agents</a>.</p>
|
|
1082
|
+
* <p>You can specify more than one agent. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#multiple-agents">Using multiple DataSync agents</a>.</p>
|
|
1207
1083
|
* @public
|
|
1208
1084
|
*/
|
|
1209
1085
|
OnPremConfig: OnPremConfig | undefined;
|
|
@@ -1214,8 +1090,7 @@ export interface CreateLocationNfsRequest {
|
|
|
1214
1090
|
*/
|
|
1215
1091
|
MountOptions?: NfsMountOptions | undefined;
|
|
1216
1092
|
/**
|
|
1217
|
-
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
|
|
1218
|
-
* We recommend creating at least a name tag for your location.</p>
|
|
1093
|
+
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.</p>
|
|
1219
1094
|
* @public
|
|
1220
1095
|
*/
|
|
1221
1096
|
Tags?: TagListEntry[] | undefined;
|
|
@@ -1249,8 +1124,8 @@ export type ObjectStorageServerProtocol = (typeof ObjectStorageServerProtocol)[k
|
|
|
1249
1124
|
*/
|
|
1250
1125
|
export interface CreateLocationObjectStorageRequest {
|
|
1251
1126
|
/**
|
|
1252
|
-
* <p>Specifies the domain name or IP version 4 (IPv4) address of the object storage server that
|
|
1253
|
-
* agent connects to.</p>
|
|
1127
|
+
* <p>Specifies the domain name or IP version 4 (IPv4) address of the object storage server that
|
|
1128
|
+
* your DataSync agent connects to.</p>
|
|
1254
1129
|
* @public
|
|
1255
1130
|
*/
|
|
1256
1131
|
ServerHostname: string | undefined;
|
|
@@ -1344,7 +1219,8 @@ export interface CreateLocationObjectStorageResponse {
|
|
|
1344
1219
|
}
|
|
1345
1220
|
/**
|
|
1346
1221
|
* <p>Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.</p>
|
|
1347
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access">Providing
|
|
1222
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access">Providing
|
|
1223
|
+
* DataSync access to S3 buckets</a>.</p>
|
|
1348
1224
|
* @public
|
|
1349
1225
|
*/
|
|
1350
1226
|
export interface S3Config {
|
|
@@ -1379,12 +1255,12 @@ export type S3StorageClass = (typeof S3StorageClass)[keyof typeof S3StorageClass
|
|
|
1379
1255
|
*/
|
|
1380
1256
|
export interface CreateLocationS3Request {
|
|
1381
1257
|
/**
|
|
1382
|
-
* <p>Specifies a prefix in the S3 bucket that DataSync
|
|
1258
|
+
* <p>Specifies a prefix in the S3 bucket that DataSync reads from or writes to
|
|
1383
1259
|
* (depending on whether the bucket is a source or destination location).</p>
|
|
1384
1260
|
* <note>
|
|
1385
|
-
* <p>DataSync can't transfer objects with a prefix that begins with a slash
|
|
1386
|
-
*
|
|
1387
|
-
*
|
|
1261
|
+
* <p>DataSync can't transfer objects with a prefix that begins with a slash (<code>/</code>)
|
|
1262
|
+
* or includes <code>//</code>, <code>/./</code>, or <code>/../</code> patterns. For
|
|
1263
|
+
* example:</p>
|
|
1388
1264
|
* <ul>
|
|
1389
1265
|
* <li>
|
|
1390
1266
|
* <p>
|
|
@@ -1415,9 +1291,10 @@ export interface CreateLocationS3Request {
|
|
|
1415
1291
|
* <p>Specifies the ARN of the S3 bucket that you want to use as a location. (When creating
|
|
1416
1292
|
* your DataSync task later, you specify whether this location is a transfer source or
|
|
1417
1293
|
* destination.) </p>
|
|
1418
|
-
* <p>If your S3 bucket is located on an Outposts resource, you must specify an
|
|
1419
|
-
*
|
|
1420
|
-
*
|
|
1294
|
+
* <p>If your S3 bucket is located on an Outposts resource, you must specify an
|
|
1295
|
+
* Amazon S3 access point. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html">Managing data access
|
|
1296
|
+
* with Amazon S3 access points</a> in the <i>Amazon S3 User
|
|
1297
|
+
* Guide</i>.</p>
|
|
1421
1298
|
* @public
|
|
1422
1299
|
*/
|
|
1423
1300
|
S3BucketArn: string | undefined;
|
|
@@ -1434,20 +1311,20 @@ export interface CreateLocationS3Request {
|
|
|
1434
1311
|
S3StorageClass?: S3StorageClass | undefined;
|
|
1435
1312
|
/**
|
|
1436
1313
|
* <p>Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.</p>
|
|
1437
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access">Providing
|
|
1314
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access">Providing
|
|
1315
|
+
* DataSync access to S3 buckets</a>.</p>
|
|
1438
1316
|
* @public
|
|
1439
1317
|
*/
|
|
1440
1318
|
S3Config: S3Config | undefined;
|
|
1441
1319
|
/**
|
|
1442
|
-
* <p>(Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of the
|
|
1443
|
-
*
|
|
1444
|
-
*
|
|
1320
|
+
* <p>(Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of the
|
|
1321
|
+
* DataSync agent on your Outpost.</p>
|
|
1322
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent">Deploy your DataSync agent on Outposts</a>.</p>
|
|
1445
1323
|
* @public
|
|
1446
1324
|
*/
|
|
1447
1325
|
AgentArns?: string[] | undefined;
|
|
1448
1326
|
/**
|
|
1449
|
-
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
|
|
1450
|
-
* We recommend creating at least a name tag for your transfer location.</p>
|
|
1327
|
+
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.</p>
|
|
1451
1328
|
* @public
|
|
1452
1329
|
*/
|
|
1453
1330
|
Tags?: TagListEntry[] | undefined;
|
|
@@ -1576,10 +1453,9 @@ export interface CreateLocationSmbRequest {
|
|
|
1576
1453
|
/**
|
|
1577
1454
|
* <p>Specifies your Kerberos key table (keytab) file, which includes mappings between your
|
|
1578
1455
|
* Kerberos principal and encryption keys.</p>
|
|
1579
|
-
* <p>The file must be base64 encoded. If you're using the CLI, the encoding is
|
|
1580
|
-
* done for you.</p>
|
|
1581
1456
|
* <p>To avoid task execution errors, make sure that the Kerberos principal that you use to
|
|
1582
|
-
* create the keytab file matches exactly what you specify for <code>KerberosPrincipal</code>.
|
|
1457
|
+
* create the keytab file matches exactly what you specify for <code>KerberosPrincipal</code>.
|
|
1458
|
+
* </p>
|
|
1583
1459
|
* @public
|
|
1584
1460
|
*/
|
|
1585
1461
|
KerberosKeytab?: Uint8Array | undefined;
|
|
@@ -1669,13 +1545,13 @@ export interface S3ManifestConfig {
|
|
|
1669
1545
|
*/
|
|
1670
1546
|
ManifestObjectPath: string | undefined;
|
|
1671
1547
|
/**
|
|
1672
|
-
* <p>Specifies the Identity and Access Management (IAM) role that allows DataSync to access your
|
|
1673
|
-
* manifest. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access">Providing DataSync access to your manifest</a>.</p>
|
|
1548
|
+
* <p>Specifies the Identity and Access Management (IAM) role that allows DataSync to access your manifest. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access">Providing DataSync access to your manifest</a>.</p>
|
|
1674
1549
|
* @public
|
|
1675
1550
|
*/
|
|
1676
1551
|
BucketAccessRoleArn: string | undefined;
|
|
1677
1552
|
/**
|
|
1678
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your
|
|
1553
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your
|
|
1554
|
+
* manifest.</p>
|
|
1679
1555
|
* @public
|
|
1680
1556
|
*/
|
|
1681
1557
|
S3BucketArn: string | undefined;
|
|
@@ -1717,8 +1593,8 @@ export interface ManifestConfig {
|
|
|
1717
1593
|
* <p>Specifies the manifest that you want DataSync to use and where it's
|
|
1718
1594
|
* hosted.</p>
|
|
1719
1595
|
* <note>
|
|
1720
|
-
* <p>You must specify this parameter if you're configuring a new manifest on or after
|
|
1721
|
-
* 2024.</p>
|
|
1596
|
+
* <p>You must specify this parameter if you're configuring a new manifest on or after
|
|
1597
|
+
* February 7, 2024.</p>
|
|
1722
1598
|
* <p>If you don't, you'll get a 400 status code and <code>ValidationException</code> error
|
|
1723
1599
|
* stating that you're missing the IAM role for DataSync to access the
|
|
1724
1600
|
* S3 bucket where you're hosting your manifest. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access">Providing DataSync access to your manifest</a>.</p>
|
|
@@ -1894,8 +1770,10 @@ export type VerifyMode = (typeof VerifyMode)[keyof typeof VerifyMode];
|
|
|
1894
1770
|
* <p>Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You
|
|
1895
1771
|
* also can specify how to verify data integrity, set bandwidth limits for your task, among other
|
|
1896
1772
|
* options.</p>
|
|
1897
|
-
* <p>Each option has a default value. Unless you need to, you don't have to configure any
|
|
1898
|
-
*
|
|
1773
|
+
* <p>Each option has a default value. Unless you need to, you don't have to configure any
|
|
1774
|
+
* option before calling <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
|
|
1775
|
+
* <p>You also can override your task options for each task execution. For example, you might
|
|
1776
|
+
* want to adjust the <code>LogLevel</code> for an individual execution.</p>
|
|
1899
1777
|
* @public
|
|
1900
1778
|
*/
|
|
1901
1779
|
export interface Options {
|
|
@@ -1926,8 +1804,8 @@ export interface Options {
|
|
|
1926
1804
|
* <p>The is the default option for <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Basic mode tasks</a> and
|
|
1927
1805
|
* isn't currently supported with Enhanced mode tasks.</p>
|
|
1928
1806
|
* </note>
|
|
1929
|
-
* <p>If you use a <a href="https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html">manifest</a>,
|
|
1930
|
-
*
|
|
1807
|
+
* <p>If you use a <a href="https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html">manifest</a>,
|
|
1808
|
+
* DataSync only scans and verifies what's listed in the manifest.</p>
|
|
1931
1809
|
* <p>You can't use this option when transferring to S3 Glacier Flexible Retrieval
|
|
1932
1810
|
* or S3 Glacier Deep Archive storage classes. For more information, see
|
|
1933
1811
|
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Storage
|
|
@@ -2048,7 +1926,8 @@ export interface Options {
|
|
|
2048
1926
|
* <code>NONE</code> - Ignores UID and GID.</p>
|
|
2049
1927
|
* </li>
|
|
2050
1928
|
* </ul>
|
|
2051
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html">Understanding how DataSync handles file and object
|
|
1929
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html">Understanding how DataSync handles file and object
|
|
1930
|
+
* metadata</a>.</p>
|
|
2052
1931
|
* @public
|
|
2053
1932
|
*/
|
|
2054
1933
|
Gid?: Gid | undefined;
|
|
@@ -2103,7 +1982,8 @@ export interface Options {
|
|
|
2103
1982
|
/**
|
|
2104
1983
|
* <p>Specifies which users or groups can access a file for a specific purpose such as reading,
|
|
2105
1984
|
* writing, or execution of the file.</p>
|
|
2106
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html">Understanding how DataSync handles file and object
|
|
1985
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html">Understanding how DataSync handles file and object
|
|
1986
|
+
* metadata</a>.</p>
|
|
2107
1987
|
* <ul>
|
|
2108
1988
|
* <li>
|
|
2109
1989
|
* <p>
|
|
@@ -2185,7 +2065,8 @@ export interface Options {
|
|
|
2185
2065
|
* <p>Specifies which components of the SMB security descriptor are copied from source to
|
|
2186
2066
|
* destination objects. </p>
|
|
2187
2067
|
* <p>This value is only used for transfers between SMB and Amazon FSx for Windows File Server
|
|
2188
|
-
* locations or between two FSx for Windows File Server locations. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html">Understanding how
|
|
2068
|
+
* locations or between two FSx for Windows File Server locations. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html">Understanding how
|
|
2069
|
+
* DataSync handles file and object metadata</a>.</p>
|
|
2189
2070
|
* <ul>
|
|
2190
2071
|
* <li>
|
|
2191
2072
|
* <p>
|
|
@@ -2220,8 +2101,8 @@ export interface Options {
|
|
|
2220
2101
|
* object.</p>
|
|
2221
2102
|
* <p>Copying SACLs requires granting additional permissions to the Windows user that
|
|
2222
2103
|
* DataSync uses to access your SMB location. For information about choosing
|
|
2223
|
-
* a user with the right permissions, see required permissions for <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">SMB</a>, <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions">FSx for Windows File Server</a>, or <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb">FSx for ONTAP</a> (depending
|
|
2224
|
-
*
|
|
2104
|
+
* a user with the right permissions, see required permissions for <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">SMB</a>, <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions">FSx for Windows File Server</a>, or <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb">FSx for ONTAP</a> (depending on the type of
|
|
2105
|
+
* location in your transfer).</p>
|
|
2225
2106
|
* </li>
|
|
2226
2107
|
* </ul>
|
|
2227
2108
|
* </li>
|
|
@@ -2303,7 +2184,8 @@ export declare const TaskMode: {
|
|
|
2303
2184
|
*/
|
|
2304
2185
|
export type TaskMode = (typeof TaskMode)[keyof typeof TaskMode];
|
|
2305
2186
|
/**
|
|
2306
|
-
* <p>Specifies the Amazon S3 bucket where DataSync uploads your <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">task
|
|
2187
|
+
* <p>Specifies the Amazon S3 bucket where DataSync uploads your <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">task
|
|
2188
|
+
* report</a>.</p>
|
|
2307
2189
|
* @public
|
|
2308
2190
|
*/
|
|
2309
2191
|
export interface ReportDestinationS3 {
|
|
@@ -2318,7 +2200,10 @@ export interface ReportDestinationS3 {
|
|
|
2318
2200
|
*/
|
|
2319
2201
|
S3BucketArn: string | undefined;
|
|
2320
2202
|
/**
|
|
2321
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the IAM policy that allows
|
|
2203
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the IAM policy that allows
|
|
2204
|
+
* DataSync to upload a task report to your S3 bucket. For more information, see
|
|
2205
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">Allowing
|
|
2206
|
+
* DataSync to upload a task report to an Amazon S3 bucket</a>.</p>
|
|
2322
2207
|
* @public
|
|
2323
2208
|
*/
|
|
2324
2209
|
BucketAccessRoleArn: string | undefined;
|
|
@@ -2329,7 +2214,8 @@ export interface ReportDestinationS3 {
|
|
|
2329
2214
|
*/
|
|
2330
2215
|
export interface ReportDestination {
|
|
2331
2216
|
/**
|
|
2332
|
-
* <p>Specifies the Amazon S3 bucket where DataSync uploads your task
|
|
2217
|
+
* <p>Specifies the Amazon S3 bucket where DataSync uploads your task
|
|
2218
|
+
* report.</p>
|
|
2333
2219
|
* @public
|
|
2334
2220
|
*/
|
|
2335
2221
|
S3?: ReportDestinationS3 | undefined;
|
|
@@ -2379,7 +2265,11 @@ export type ReportLevel = (typeof ReportLevel)[keyof typeof ReportLevel];
|
|
|
2379
2265
|
export interface ReportOverride {
|
|
2380
2266
|
/**
|
|
2381
2267
|
* <p>Specifies whether your task report includes errors only or successes and errors.</p>
|
|
2382
|
-
* <p>For example, your report might mostly include only what didn't go well in your transfer
|
|
2268
|
+
* <p>For example, your report might mostly include only what didn't go well in your transfer
|
|
2269
|
+
* (<code>ERRORS_ONLY</code>). At the same time, you want to verify that your <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">task filter</a> is
|
|
2270
|
+
* working correctly. In this situation, you can get a list of what files DataSync
|
|
2271
|
+
* successfully skipped and if something transferred that you didn't to transfer
|
|
2272
|
+
* (<code>SUCCESSES_AND_ERRORS</code>).</p>
|
|
2383
2273
|
* @public
|
|
2384
2274
|
*/
|
|
2385
2275
|
ReportLevel?: ReportLevel | undefined;
|
|
@@ -2402,7 +2292,8 @@ export interface ReportOverrides {
|
|
|
2402
2292
|
*/
|
|
2403
2293
|
Verified?: ReportOverride | undefined;
|
|
2404
2294
|
/**
|
|
2405
|
-
* <p>Specifies the level of reporting for the files, objects, and directories that DataSync attempted to delete in your destination location. This only applies if you <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html">configure your
|
|
2295
|
+
* <p>Specifies the level of reporting for the files, objects, and directories that DataSync attempted to delete in your destination location. This only applies if you <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html">configure your
|
|
2296
|
+
* task</a> to delete data in the destination that isn't in the source.</p>
|
|
2406
2297
|
* @public
|
|
2407
2298
|
*/
|
|
2408
2299
|
Deleted?: ReportOverride | undefined;
|
|
@@ -2413,15 +2304,16 @@ export interface ReportOverrides {
|
|
|
2413
2304
|
Skipped?: ReportOverride | undefined;
|
|
2414
2305
|
}
|
|
2415
2306
|
/**
|
|
2416
|
-
* <p>Specifies how you want to configure a task report, which provides detailed information
|
|
2417
|
-
*
|
|
2418
|
-
*
|
|
2307
|
+
* <p>Specifies how you want to configure a task report, which provides detailed information
|
|
2308
|
+
* about for your DataSync transfer.</p>
|
|
2309
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">Task reports</a>.</p>
|
|
2419
2310
|
* @public
|
|
2420
2311
|
*/
|
|
2421
2312
|
export interface TaskReportConfig {
|
|
2422
2313
|
/**
|
|
2423
|
-
* <p>Specifies the Amazon S3 bucket where DataSync uploads your task report.
|
|
2424
|
-
* information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html#task-report-access">Task
|
|
2314
|
+
* <p>Specifies the Amazon S3 bucket where DataSync uploads your task report.
|
|
2315
|
+
* For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html#task-report-access">Task
|
|
2316
|
+
* reports</a>.</p>
|
|
2425
2317
|
* @public
|
|
2426
2318
|
*/
|
|
2427
2319
|
Destination?: ReportDestination | undefined;
|
|
@@ -2430,37 +2322,42 @@ export interface TaskReportConfig {
|
|
|
2430
2322
|
* <ul>
|
|
2431
2323
|
* <li>
|
|
2432
2324
|
* <p>
|
|
2433
|
-
* <code>SUMMARY_ONLY</code>: Provides necessary details about your task, including the
|
|
2434
|
-
* files, objects, and directories transferred and transfer duration.</p>
|
|
2325
|
+
* <code>SUMMARY_ONLY</code>: Provides necessary details about your task, including the
|
|
2326
|
+
* number of files, objects, and directories transferred and transfer duration.</p>
|
|
2435
2327
|
* </li>
|
|
2436
2328
|
* <li>
|
|
2437
2329
|
* <p>
|
|
2438
|
-
* <code>STANDARD</code>: Provides complete details about your task, including a full
|
|
2439
|
-
* files, objects, and directories that were transferred, skipped, verified, and
|
|
2330
|
+
* <code>STANDARD</code>: Provides complete details about your task, including a full
|
|
2331
|
+
* list of files, objects, and directories that were transferred, skipped, verified, and
|
|
2332
|
+
* more.</p>
|
|
2440
2333
|
* </li>
|
|
2441
2334
|
* </ul>
|
|
2442
2335
|
* @public
|
|
2443
2336
|
*/
|
|
2444
2337
|
OutputType?: ReportOutputType | undefined;
|
|
2445
2338
|
/**
|
|
2446
|
-
* <p>Specifies whether you want your task report to include only what went wrong with your
|
|
2339
|
+
* <p>Specifies whether you want your task report to include only what went wrong with your
|
|
2340
|
+
* transfer or a list of what succeeded and didn't.</p>
|
|
2447
2341
|
* <ul>
|
|
2448
2342
|
* <li>
|
|
2449
2343
|
* <p>
|
|
2450
|
-
* <code>ERRORS_ONLY</code>: A report shows what DataSync was unable to
|
|
2451
|
-
* verify, and delete.</p>
|
|
2344
|
+
* <code>ERRORS_ONLY</code>: A report shows what DataSync was unable to
|
|
2345
|
+
* transfer, skip, verify, and delete.</p>
|
|
2452
2346
|
* </li>
|
|
2453
2347
|
* <li>
|
|
2454
2348
|
* <p>
|
|
2455
|
-
* <code>SUCCESSES_AND_ERRORS</code>: A report shows what DataSync was able and
|
|
2456
|
-
* to transfer, skip, verify, and delete.</p>
|
|
2349
|
+
* <code>SUCCESSES_AND_ERRORS</code>: A report shows what DataSync was able and
|
|
2350
|
+
* unable to transfer, skip, verify, and delete.</p>
|
|
2457
2351
|
* </li>
|
|
2458
2352
|
* </ul>
|
|
2459
2353
|
* @public
|
|
2460
2354
|
*/
|
|
2461
2355
|
ReportLevel?: ReportLevel | undefined;
|
|
2462
2356
|
/**
|
|
2463
|
-
* <p>Specifies whether your task report includes the new version of each object transferred
|
|
2357
|
+
* <p>Specifies whether your task report includes the new version of each object transferred
|
|
2358
|
+
* into an S3 bucket. This only applies if you <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html">enable versioning on your
|
|
2359
|
+
* bucket</a>. Keep in mind that setting this to <code>INCLUDE</code> can increase the
|
|
2360
|
+
* duration of your task execution.</p>
|
|
2464
2361
|
* @public
|
|
2465
2362
|
*/
|
|
2466
2363
|
ObjectVersionIds?: ObjectVersionIds | undefined;
|
|
@@ -2492,7 +2389,8 @@ export interface CreateTaskRequest {
|
|
|
2492
2389
|
* <p>Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for
|
|
2493
2390
|
* monitoring your task.</p>
|
|
2494
2391
|
* <p>For Enhanced mode tasks, you don't need to specify anything. DataSync
|
|
2495
|
-
* automatically sends logs to a CloudWatch log group named
|
|
2392
|
+
* automatically sends logs to a CloudWatch log group named
|
|
2393
|
+
* <code>/aws/datasync</code>.</p>
|
|
2496
2394
|
* @public
|
|
2497
2395
|
*/
|
|
2498
2396
|
CloudWatchLogGroupArn?: string | undefined;
|
|
@@ -2508,8 +2406,9 @@ export interface CreateTaskRequest {
|
|
|
2508
2406
|
*/
|
|
2509
2407
|
Options?: Options | undefined;
|
|
2510
2408
|
/**
|
|
2511
|
-
* <p>Specifies exclude filters that define the files, objects, and folders in your source
|
|
2512
|
-
*
|
|
2409
|
+
* <p>Specifies exclude filters that define the files, objects, and folders in your source
|
|
2410
|
+
* location that you don't want DataSync to transfer. For more information and
|
|
2411
|
+
* examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Specifying what DataSync transfers by using filters</a>.</p>
|
|
2513
2412
|
* @public
|
|
2514
2413
|
*/
|
|
2515
2414
|
Excludes?: FilterRule[] | undefined;
|
|
@@ -2573,7 +2472,8 @@ export interface CreateTaskRequest {
|
|
|
2573
2472
|
* mode for most workloads.</p>
|
|
2574
2473
|
* </li>
|
|
2575
2474
|
* </ul>
|
|
2576
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences">Understanding
|
|
2475
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences">Understanding
|
|
2476
|
+
* task mode differences</a>.</p>
|
|
2577
2477
|
* @public
|
|
2578
2478
|
*/
|
|
2579
2479
|
TaskMode?: TaskMode | undefined;
|
|
@@ -2665,7 +2565,8 @@ export declare const EndpointType: {
|
|
|
2665
2565
|
export type EndpointType = (typeof EndpointType)[keyof typeof EndpointType];
|
|
2666
2566
|
/**
|
|
2667
2567
|
* <p>Specifies how your DataSync agent connects to Amazon Web Services using a
|
|
2668
|
-
*
|
|
2568
|
+
* <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
|
|
2569
|
+
* isn't accessible over the public internet.</p>
|
|
2669
2570
|
* @public
|
|
2670
2571
|
*/
|
|
2671
2572
|
export interface PrivateLinkConfig {
|
|
@@ -2675,8 +2576,7 @@ export interface PrivateLinkConfig {
|
|
|
2675
2576
|
*/
|
|
2676
2577
|
VpcEndpointId?: string | undefined;
|
|
2677
2578
|
/**
|
|
2678
|
-
* <p>Specifies the VPC endpoint provided by <a href="https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html">Amazon Web Services PrivateLink</a> that
|
|
2679
|
-
* your agent connects to.</p>
|
|
2579
|
+
* <p>Specifies the VPC endpoint provided by <a href="https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html">Amazon Web Services PrivateLink</a> that your agent connects to.</p>
|
|
2680
2580
|
* @public
|
|
2681
2581
|
*/
|
|
2682
2582
|
PrivateLinkEndpoint?: string | undefined;
|
|
@@ -2752,75 +2652,13 @@ export interface DescribeAgentResponse {
|
|
|
2752
2652
|
*/
|
|
2753
2653
|
Platform?: Platform | undefined;
|
|
2754
2654
|
}
|
|
2755
|
-
/**
|
|
2756
|
-
* @public
|
|
2757
|
-
*/
|
|
2758
|
-
export interface DescribeDiscoveryJobRequest {
|
|
2759
|
-
/**
|
|
2760
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the discovery job that you want information
|
|
2761
|
-
* about.</p>
|
|
2762
|
-
* @public
|
|
2763
|
-
*/
|
|
2764
|
-
DiscoveryJobArn: string | undefined;
|
|
2765
|
-
}
|
|
2766
|
-
/**
|
|
2767
|
-
* @public
|
|
2768
|
-
* @enum
|
|
2769
|
-
*/
|
|
2770
|
-
export declare const DiscoveryJobStatus: {
|
|
2771
|
-
readonly COMPLETED: "COMPLETED";
|
|
2772
|
-
readonly COMPLETED_WITH_ISSUES: "COMPLETED_WITH_ISSUES";
|
|
2773
|
-
readonly FAILED: "FAILED";
|
|
2774
|
-
readonly RUNNING: "RUNNING";
|
|
2775
|
-
readonly STOPPED: "STOPPED";
|
|
2776
|
-
readonly TERMINATED: "TERMINATED";
|
|
2777
|
-
readonly WARNING: "WARNING";
|
|
2778
|
-
};
|
|
2779
|
-
/**
|
|
2780
|
-
* @public
|
|
2781
|
-
*/
|
|
2782
|
-
export type DiscoveryJobStatus = (typeof DiscoveryJobStatus)[keyof typeof DiscoveryJobStatus];
|
|
2783
|
-
/**
|
|
2784
|
-
* @public
|
|
2785
|
-
*/
|
|
2786
|
-
export interface DescribeDiscoveryJobResponse {
|
|
2787
|
-
/**
|
|
2788
|
-
* <p>The ARN of the on-premises storage system you're running the discovery job on.</p>
|
|
2789
|
-
* @public
|
|
2790
|
-
*/
|
|
2791
|
-
StorageSystemArn?: string | undefined;
|
|
2792
|
-
/**
|
|
2793
|
-
* <p>The ARN of the discovery job.</p>
|
|
2794
|
-
* @public
|
|
2795
|
-
*/
|
|
2796
|
-
DiscoveryJobArn?: string | undefined;
|
|
2797
|
-
/**
|
|
2798
|
-
* <p>The number of minutes that the discovery job runs.</p>
|
|
2799
|
-
* @public
|
|
2800
|
-
*/
|
|
2801
|
-
CollectionDurationMinutes?: number | undefined;
|
|
2802
|
-
/**
|
|
2803
|
-
* <p>Indicates the status of a discovery job. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#discovery-job-statuses-table">Discovery job statuses</a>.</p>
|
|
2804
|
-
* @public
|
|
2805
|
-
*/
|
|
2806
|
-
Status?: DiscoveryJobStatus | undefined;
|
|
2807
|
-
/**
|
|
2808
|
-
* <p>The time when the discovery job started.</p>
|
|
2809
|
-
* @public
|
|
2810
|
-
*/
|
|
2811
|
-
JobStartTime?: Date | undefined;
|
|
2812
|
-
/**
|
|
2813
|
-
* <p>The time when the discovery job ended.</p>
|
|
2814
|
-
* @public
|
|
2815
|
-
*/
|
|
2816
|
-
JobEndTime?: Date | undefined;
|
|
2817
|
-
}
|
|
2818
2655
|
/**
|
|
2819
2656
|
* @public
|
|
2820
2657
|
*/
|
|
2821
2658
|
export interface DescribeLocationAzureBlobRequest {
|
|
2822
2659
|
/**
|
|
2823
|
-
* <p>Specifies the Amazon Resource Name (ARN) of your Azure Blob Storage transfer
|
|
2660
|
+
* <p>Specifies the Amazon Resource Name (ARN) of your Azure Blob Storage transfer
|
|
2661
|
+
* location.</p>
|
|
2824
2662
|
* @public
|
|
2825
2663
|
*/
|
|
2826
2664
|
LocationArn: string | undefined;
|
|
@@ -2840,7 +2678,8 @@ export interface DescribeLocationAzureBlobResponse {
|
|
|
2840
2678
|
*/
|
|
2841
2679
|
LocationUri?: string | undefined;
|
|
2842
2680
|
/**
|
|
2843
|
-
* <p>The authentication method DataSync uses to access your Azure Blob Storage.
|
|
2681
|
+
* <p>The authentication method DataSync uses to access your Azure Blob Storage.
|
|
2682
|
+
* DataSync can access blob storage using a shared access signature (SAS).</p>
|
|
2844
2683
|
* @public
|
|
2845
2684
|
*/
|
|
2846
2685
|
AuthenticationType?: AzureBlobAuthenticationType | undefined;
|
|
@@ -2852,12 +2691,14 @@ export interface DescribeLocationAzureBlobResponse {
|
|
|
2852
2691
|
*/
|
|
2853
2692
|
BlobType?: AzureBlobType | undefined;
|
|
2854
2693
|
/**
|
|
2855
|
-
* <p>The access tier that you want your objects or files transferred into. This only applies
|
|
2694
|
+
* <p>The access tier that you want your objects or files transferred into. This only applies
|
|
2695
|
+
* when using the location as a transfer destination. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers">Access tiers</a>.</p>
|
|
2856
2696
|
* @public
|
|
2857
2697
|
*/
|
|
2858
2698
|
AccessTier?: AzureAccessTier | undefined;
|
|
2859
2699
|
/**
|
|
2860
|
-
* <p>The ARNs of the DataSync agents that can connect with your Azure Blob Storage
|
|
2700
|
+
* <p>The ARNs of the DataSync agents that can connect with your Azure Blob Storage
|
|
2701
|
+
* container.</p>
|
|
2861
2702
|
* @public
|
|
2862
2703
|
*/
|
|
2863
2704
|
AgentArns?: string[] | undefined;
|
|
@@ -2908,14 +2749,16 @@ export interface DescribeLocationEfsResponse {
|
|
|
2908
2749
|
/**
|
|
2909
2750
|
* <p>The ARN of the access point that DataSync uses to access the Amazon EFS
|
|
2910
2751
|
* file system.</p>
|
|
2911
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam">Accessing
|
|
2752
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam">Accessing
|
|
2753
|
+
* restricted file systems</a>.</p>
|
|
2912
2754
|
* @public
|
|
2913
2755
|
*/
|
|
2914
2756
|
AccessPointArn?: string | undefined;
|
|
2915
2757
|
/**
|
|
2916
2758
|
* <p>The Identity and Access Management (IAM) role that allows DataSync to
|
|
2917
2759
|
* access your Amazon EFS file system.</p>
|
|
2918
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role">Creating a DataSync
|
|
2760
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role">Creating a DataSync
|
|
2761
|
+
* IAM role for file system access</a>.</p>
|
|
2919
2762
|
* @public
|
|
2920
2763
|
*/
|
|
2921
2764
|
FileSystemAccessRoleArn?: string | undefined;
|
|
@@ -3335,7 +3178,8 @@ export interface DescribeLocationS3Response {
|
|
|
3335
3178
|
S3StorageClass?: S3StorageClass | undefined;
|
|
3336
3179
|
/**
|
|
3337
3180
|
* <p>Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.</p>
|
|
3338
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access">Providing
|
|
3181
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access">Providing
|
|
3182
|
+
* DataSync access to S3 buckets</a>.</p>
|
|
3339
3183
|
* @public
|
|
3340
3184
|
*/
|
|
3341
3185
|
S3Config?: S3Config | undefined;
|
|
@@ -3430,805 +3274,65 @@ export interface DescribeLocationSmbResponse {
|
|
|
3430
3274
|
AuthenticationType?: SmbAuthenticationType | undefined;
|
|
3431
3275
|
}
|
|
3432
3276
|
/**
|
|
3277
|
+
* <p>DescribeTaskRequest</p>
|
|
3433
3278
|
* @public
|
|
3434
3279
|
*/
|
|
3435
|
-
export interface
|
|
3280
|
+
export interface DescribeTaskRequest {
|
|
3436
3281
|
/**
|
|
3437
|
-
* <p>Specifies the Amazon Resource Name (ARN) of
|
|
3438
|
-
*
|
|
3282
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the transfer task that you want information
|
|
3283
|
+
* about.</p>
|
|
3439
3284
|
* @public
|
|
3440
3285
|
*/
|
|
3441
|
-
|
|
3286
|
+
TaskArn: string | undefined;
|
|
3442
3287
|
}
|
|
3443
3288
|
/**
|
|
3444
3289
|
* @public
|
|
3445
3290
|
* @enum
|
|
3446
3291
|
*/
|
|
3447
|
-
export declare const
|
|
3448
|
-
readonly
|
|
3449
|
-
readonly
|
|
3450
|
-
readonly UNKNOWN: "UNKNOWN";
|
|
3292
|
+
export declare const ScheduleDisabledBy: {
|
|
3293
|
+
readonly SERVICE: "SERVICE";
|
|
3294
|
+
readonly USER: "USER";
|
|
3451
3295
|
};
|
|
3452
3296
|
/**
|
|
3453
3297
|
* @public
|
|
3454
3298
|
*/
|
|
3455
|
-
export type
|
|
3299
|
+
export type ScheduleDisabledBy = (typeof ScheduleDisabledBy)[keyof typeof ScheduleDisabledBy];
|
|
3456
3300
|
/**
|
|
3301
|
+
* <p>Provides information about your DataSync
|
|
3302
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">task
|
|
3303
|
+
* schedule</a>.</p>
|
|
3457
3304
|
* @public
|
|
3458
3305
|
*/
|
|
3459
|
-
export interface
|
|
3460
|
-
/**
|
|
3461
|
-
* <p>The ARN of the on-premises storage system that the discovery job looked at.</p>
|
|
3462
|
-
* @public
|
|
3463
|
-
*/
|
|
3464
|
-
StorageSystemArn?: string | undefined;
|
|
3465
|
-
/**
|
|
3466
|
-
* <p>The server name and network port required to connect with your on-premises storage
|
|
3467
|
-
* system's management interface.</p>
|
|
3468
|
-
* @public
|
|
3469
|
-
*/
|
|
3470
|
-
ServerConfiguration?: DiscoveryServerConfiguration | undefined;
|
|
3306
|
+
export interface TaskScheduleDetails {
|
|
3471
3307
|
/**
|
|
3472
|
-
* <p>
|
|
3473
|
-
*
|
|
3474
|
-
* <p>DataSync Discovery currently only supports NetApp
|
|
3475
|
-
* Fabric-Attached
|
|
3476
|
-
* Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.
|
|
3477
|
-
* </p>
|
|
3478
|
-
* </note>
|
|
3308
|
+
* <p>Indicates the last time the status of your task schedule changed. For example, if DataSync automatically disables your schedule because of a repeated error, you can see
|
|
3309
|
+
* when the schedule was disabled.</p>
|
|
3479
3310
|
* @public
|
|
3480
3311
|
*/
|
|
3481
|
-
|
|
3312
|
+
StatusUpdateTime?: Date | undefined;
|
|
3482
3313
|
/**
|
|
3483
|
-
* <p>
|
|
3484
|
-
*
|
|
3314
|
+
* <p>Provides a reason if the task schedule is disabled.</p>
|
|
3315
|
+
* <p>If your schedule is disabled by <code>USER</code>, you see a <code>Manually disabled by
|
|
3316
|
+
* user.</code> message.</p>
|
|
3317
|
+
* <p>If your schedule is disabled by <code>SERVICE</code>, you see an error message to help you
|
|
3318
|
+
* understand why the task keeps failing. For information on resolving DataSync errors,
|
|
3319
|
+
* see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html">Troubleshooting issues with DataSync transfers</a>.</p>
|
|
3485
3320
|
* @public
|
|
3486
3321
|
*/
|
|
3487
|
-
|
|
3322
|
+
DisabledReason?: string | undefined;
|
|
3488
3323
|
/**
|
|
3489
|
-
* <p>
|
|
3490
|
-
*
|
|
3491
|
-
|
|
3492
|
-
|
|
3493
|
-
|
|
3494
|
-
*
|
|
3495
|
-
*
|
|
3496
|
-
*
|
|
3497
|
-
|
|
3498
|
-
|
|
3499
|
-
|
|
3500
|
-
*
|
|
3501
|
-
* @public
|
|
3502
|
-
*/
|
|
3503
|
-
ConnectivityStatus?: StorageSystemConnectivityStatus | undefined;
|
|
3504
|
-
/**
|
|
3505
|
-
* <p>The ARN of the Amazon CloudWatch log group that's used to monitor and log discovery
|
|
3506
|
-
* job events.</p>
|
|
3507
|
-
* @public
|
|
3508
|
-
*/
|
|
3509
|
-
CloudWatchLogGroupArn?: string | undefined;
|
|
3510
|
-
/**
|
|
3511
|
-
* <p>The time when you added the on-premises storage system to DataSync Discovery.</p>
|
|
3512
|
-
* @public
|
|
3513
|
-
*/
|
|
3514
|
-
CreationTime?: Date | undefined;
|
|
3515
|
-
/**
|
|
3516
|
-
* <p>The ARN of the secret that stores your on-premises storage system's credentials. DataSync Discovery
|
|
3517
|
-
* stores these credentials in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-configure-storage.html#discovery-add-storage">Secrets Manager</a>.</p>
|
|
3518
|
-
* @public
|
|
3519
|
-
*/
|
|
3520
|
-
SecretsManagerArn?: string | undefined;
|
|
3521
|
-
}
|
|
3522
|
-
/**
|
|
3523
|
-
* @public
|
|
3524
|
-
* @enum
|
|
3525
|
-
*/
|
|
3526
|
-
export declare const DiscoveryResourceType: {
|
|
3527
|
-
readonly CLUSTER: "CLUSTER";
|
|
3528
|
-
readonly SVM: "SVM";
|
|
3529
|
-
readonly VOLUME: "VOLUME";
|
|
3530
|
-
};
|
|
3531
|
-
/**
|
|
3532
|
-
* @public
|
|
3533
|
-
*/
|
|
3534
|
-
export type DiscoveryResourceType = (typeof DiscoveryResourceType)[keyof typeof DiscoveryResourceType];
|
|
3535
|
-
/**
|
|
3536
|
-
* @public
|
|
3537
|
-
*/
|
|
3538
|
-
export interface DescribeStorageSystemResourceMetricsRequest {
|
|
3539
|
-
/**
|
|
3540
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the discovery job that collects information
|
|
3541
|
-
* about your on-premises storage system.</p>
|
|
3542
|
-
* @public
|
|
3543
|
-
*/
|
|
3544
|
-
DiscoveryJobArn: string | undefined;
|
|
3545
|
-
/**
|
|
3546
|
-
* <p>Specifies the kind of storage system resource that you want information about.</p>
|
|
3547
|
-
* @public
|
|
3548
|
-
*/
|
|
3549
|
-
ResourceType: DiscoveryResourceType | undefined;
|
|
3550
|
-
/**
|
|
3551
|
-
* <p>Specifies the universally unique identifier (UUID) of the storage system resource that you
|
|
3552
|
-
* want information about.</p>
|
|
3553
|
-
* @public
|
|
3554
|
-
*/
|
|
3555
|
-
ResourceId: string | undefined;
|
|
3556
|
-
/**
|
|
3557
|
-
* <p>Specifies a time within the total duration that the discovery job ran. To see information
|
|
3558
|
-
* gathered during a certain time frame, use this parameter with <code>EndTime</code>.</p>
|
|
3559
|
-
* @public
|
|
3560
|
-
*/
|
|
3561
|
-
StartTime?: Date | undefined;
|
|
3562
|
-
/**
|
|
3563
|
-
* <p>Specifies a time within the total duration that the discovery job ran. To see information
|
|
3564
|
-
* gathered during a certain time frame, use this parameter with <code>StartTime</code>.</p>
|
|
3565
|
-
* @public
|
|
3566
|
-
*/
|
|
3567
|
-
EndTime?: Date | undefined;
|
|
3568
|
-
/**
|
|
3569
|
-
* <p>Specifies how many results that you want in the response.</p>
|
|
3570
|
-
* @public
|
|
3571
|
-
*/
|
|
3572
|
-
MaxResults?: number | undefined;
|
|
3573
|
-
/**
|
|
3574
|
-
* <p>Specifies an opaque string that indicates the position to begin the next list of results
|
|
3575
|
-
* in the response.</p>
|
|
3576
|
-
* @public
|
|
3577
|
-
*/
|
|
3578
|
-
NextToken?: string | undefined;
|
|
3579
|
-
}
|
|
3580
|
-
/**
|
|
3581
|
-
* <p>The IOPS peaks for an on-premises storage system
|
|
3582
|
-
* resource.
|
|
3583
|
-
* Each data point represents the 95th percentile peak value during a 1-hour interval.</p>
|
|
3584
|
-
* @public
|
|
3585
|
-
*/
|
|
3586
|
-
export interface IOPS {
|
|
3587
|
-
/**
|
|
3588
|
-
* <p>Peak IOPS related to read operations.</p>
|
|
3589
|
-
* @public
|
|
3590
|
-
*/
|
|
3591
|
-
Read?: number | undefined;
|
|
3592
|
-
/**
|
|
3593
|
-
* <p>Peak IOPS related to write operations.</p>
|
|
3594
|
-
* @public
|
|
3595
|
-
*/
|
|
3596
|
-
Write?: number | undefined;
|
|
3597
|
-
/**
|
|
3598
|
-
* <p>Peak IOPS unrelated to read and write operations.</p>
|
|
3599
|
-
* @public
|
|
3600
|
-
*/
|
|
3601
|
-
Other?: number | undefined;
|
|
3602
|
-
/**
|
|
3603
|
-
* <p>Peak total IOPS on your on-premises storage system resource.</p>
|
|
3604
|
-
* @public
|
|
3605
|
-
*/
|
|
3606
|
-
Total?: number | undefined;
|
|
3607
|
-
}
|
|
3608
|
-
/**
|
|
3609
|
-
* <p>The latency peaks for an on-premises storage system
|
|
3610
|
-
* resource.
|
|
3611
|
-
* Each data point represents the 95th percentile peak value during a 1-hour interval.</p>
|
|
3612
|
-
* @public
|
|
3613
|
-
*/
|
|
3614
|
-
export interface Latency {
|
|
3615
|
-
/**
|
|
3616
|
-
* <p>Peak latency for read operations.</p>
|
|
3617
|
-
* @public
|
|
3618
|
-
*/
|
|
3619
|
-
Read?: number | undefined;
|
|
3620
|
-
/**
|
|
3621
|
-
* <p>Peak latency for write operations.</p>
|
|
3622
|
-
* @public
|
|
3623
|
-
*/
|
|
3624
|
-
Write?: number | undefined;
|
|
3625
|
-
/**
|
|
3626
|
-
* <p>Peak latency for operations unrelated to read and write operations.</p>
|
|
3627
|
-
* @public
|
|
3628
|
-
*/
|
|
3629
|
-
Other?: number | undefined;
|
|
3630
|
-
}
|
|
3631
|
-
/**
|
|
3632
|
-
* <p>The throughput peaks for an on-premises storage system volume. Each data point represents
|
|
3633
|
-
* the 95th percentile peak value during a 1-hour interval.</p>
|
|
3634
|
-
* @public
|
|
3635
|
-
*/
|
|
3636
|
-
export interface Throughput {
|
|
3637
|
-
/**
|
|
3638
|
-
* <p>Peak throughput related to read operations.</p>
|
|
3639
|
-
* @public
|
|
3640
|
-
*/
|
|
3641
|
-
Read?: number | undefined;
|
|
3642
|
-
/**
|
|
3643
|
-
* <p>Peak throughput related to write operations.</p>
|
|
3644
|
-
* @public
|
|
3645
|
-
*/
|
|
3646
|
-
Write?: number | undefined;
|
|
3647
|
-
/**
|
|
3648
|
-
* <p>Peak throughput unrelated to read and write operations.</p>
|
|
3649
|
-
* @public
|
|
3650
|
-
*/
|
|
3651
|
-
Other?: number | undefined;
|
|
3652
|
-
/**
|
|
3653
|
-
* <p>Peak total throughput on your on-premises storage system resource.</p>
|
|
3654
|
-
* @public
|
|
3655
|
-
*/
|
|
3656
|
-
Total?: number | undefined;
|
|
3657
|
-
}
|
|
3658
|
-
/**
|
|
3659
|
-
* <p>The types of performance data that DataSync Discovery collects about an on-premises storage system
|
|
3660
|
-
* resource.</p>
|
|
3661
|
-
* @public
|
|
3662
|
-
*/
|
|
3663
|
-
export interface P95Metrics {
|
|
3664
|
-
/**
|
|
3665
|
-
* <p>The IOPS peaks for an on-premises storage system resource. Each data point represents the
|
|
3666
|
-
* 95th percentile peak value during a 1-hour interval.</p>
|
|
3667
|
-
* @public
|
|
3668
|
-
*/
|
|
3669
|
-
IOPS?: IOPS | undefined;
|
|
3670
|
-
/**
|
|
3671
|
-
* <p>The throughput peaks for an on-premises storage system resource. Each data point
|
|
3672
|
-
* represents the 95th percentile peak value during a 1-hour interval.</p>
|
|
3673
|
-
* @public
|
|
3674
|
-
*/
|
|
3675
|
-
Throughput?: Throughput | undefined;
|
|
3676
|
-
/**
|
|
3677
|
-
* <p>The latency peaks for an on-premises storage system resource. Each data point represents
|
|
3678
|
-
* the 95th percentile peak value during a 1-hour interval.</p>
|
|
3679
|
-
* @public
|
|
3680
|
-
*/
|
|
3681
|
-
Latency?: Latency | undefined;
|
|
3682
|
-
}
|
|
3683
|
-
/**
|
|
3684
|
-
* <p>Information, including performance data and capacity usage, provided by DataSync Discovery about a
|
|
3685
|
-
* resource in your on-premises storage system.</p>
|
|
3686
|
-
* @public
|
|
3687
|
-
*/
|
|
3688
|
-
export interface ResourceMetrics {
|
|
3689
|
-
/**
|
|
3690
|
-
* <p>The time when DataSync Discovery collected this information from the
|
|
3691
|
-
* resource.</p>
|
|
3692
|
-
* @public
|
|
3693
|
-
*/
|
|
3694
|
-
Timestamp?: Date | undefined;
|
|
3695
|
-
/**
|
|
3696
|
-
* <p>The types of performance data that DataSync Discovery collects about the on-premises storage system
|
|
3697
|
-
* resource.</p>
|
|
3698
|
-
* @public
|
|
3699
|
-
*/
|
|
3700
|
-
P95Metrics?: P95Metrics | undefined;
|
|
3701
|
-
/**
|
|
3702
|
-
* <p>The storage capacity of the on-premises storage system resource.</p>
|
|
3703
|
-
* @public
|
|
3704
|
-
*/
|
|
3705
|
-
Capacity?: Capacity | undefined;
|
|
3706
|
-
/**
|
|
3707
|
-
* <p>The universally unique identifier (UUID) of the on-premises storage system
|
|
3708
|
-
* resource.</p>
|
|
3709
|
-
* @public
|
|
3710
|
-
*/
|
|
3711
|
-
ResourceId?: string | undefined;
|
|
3712
|
-
/**
|
|
3713
|
-
* <p>The type of on-premises storage system resource.</p>
|
|
3714
|
-
* @public
|
|
3715
|
-
*/
|
|
3716
|
-
ResourceType?: DiscoveryResourceType | undefined;
|
|
3717
|
-
}
|
|
3718
|
-
/**
|
|
3719
|
-
* @public
|
|
3720
|
-
*/
|
|
3721
|
-
export interface DescribeStorageSystemResourceMetricsResponse {
|
|
3722
|
-
/**
|
|
3723
|
-
* <p>The details that your discovery job collected about your storage system resource.</p>
|
|
3724
|
-
* @public
|
|
3725
|
-
*/
|
|
3726
|
-
Metrics?: ResourceMetrics[] | undefined;
|
|
3727
|
-
/**
|
|
3728
|
-
* <p>The opaque string that indicates the position to begin the next list of results in the
|
|
3729
|
-
* response.</p>
|
|
3730
|
-
* @public
|
|
3731
|
-
*/
|
|
3732
|
-
NextToken?: string | undefined;
|
|
3733
|
-
}
|
|
3734
|
-
/**
|
|
3735
|
-
* @public
|
|
3736
|
-
* @enum
|
|
3737
|
-
*/
|
|
3738
|
-
export declare const DiscoveryResourceFilter: {
|
|
3739
|
-
readonly SVM: "SVM";
|
|
3740
|
-
};
|
|
3741
|
-
/**
|
|
3742
|
-
* @public
|
|
3743
|
-
*/
|
|
3744
|
-
export type DiscoveryResourceFilter = (typeof DiscoveryResourceFilter)[keyof typeof DiscoveryResourceFilter];
|
|
3745
|
-
/**
|
|
3746
|
-
* @public
|
|
3747
|
-
*/
|
|
3748
|
-
export interface DescribeStorageSystemResourcesRequest {
|
|
3749
|
-
/**
|
|
3750
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the discovery job that's collecting data from
|
|
3751
|
-
* your on-premises storage system.</p>
|
|
3752
|
-
* @public
|
|
3753
|
-
*/
|
|
3754
|
-
DiscoveryJobArn: string | undefined;
|
|
3755
|
-
/**
|
|
3756
|
-
* <p>Specifies what kind of storage system resources that you want information about.</p>
|
|
3757
|
-
* @public
|
|
3758
|
-
*/
|
|
3759
|
-
ResourceType: DiscoveryResourceType | undefined;
|
|
3760
|
-
/**
|
|
3761
|
-
* <p>Specifies the universally unique identifiers (UUIDs) of the storage system resources that
|
|
3762
|
-
* you want information about. You can't use this parameter in combination with the
|
|
3763
|
-
* <code>Filter</code> parameter.</p>
|
|
3764
|
-
* @public
|
|
3765
|
-
*/
|
|
3766
|
-
ResourceIds?: string[] | undefined;
|
|
3767
|
-
/**
|
|
3768
|
-
* <p>Filters the storage system resources that you want returned. For example, this might be
|
|
3769
|
-
* volumes associated with a specific storage virtual machine (SVM).</p>
|
|
3770
|
-
* @public
|
|
3771
|
-
*/
|
|
3772
|
-
Filter?: Partial<Record<DiscoveryResourceFilter, string[]>> | undefined;
|
|
3773
|
-
/**
|
|
3774
|
-
* <p>Specifies the maximum number of storage system resources that you want to list in a
|
|
3775
|
-
* response.</p>
|
|
3776
|
-
* @public
|
|
3777
|
-
*/
|
|
3778
|
-
MaxResults?: number | undefined;
|
|
3779
|
-
/**
|
|
3780
|
-
* <p>Specifies an opaque string that indicates the position to begin the next list of results
|
|
3781
|
-
* in the response.</p>
|
|
3782
|
-
* @public
|
|
3783
|
-
*/
|
|
3784
|
-
NextToken?: string | undefined;
|
|
3785
|
-
}
|
|
3786
|
-
/**
|
|
3787
|
-
* <p>The performance data that DataSync Discovery collects about an on-premises storage system
|
|
3788
|
-
* resource.</p>
|
|
3789
|
-
* @public
|
|
3790
|
-
*/
|
|
3791
|
-
export interface MaxP95Performance {
|
|
3792
|
-
/**
|
|
3793
|
-
* <p>Peak IOPS related to read operations.</p>
|
|
3794
|
-
* @public
|
|
3795
|
-
*/
|
|
3796
|
-
IopsRead?: number | undefined;
|
|
3797
|
-
/**
|
|
3798
|
-
* <p>Peak IOPS related to write operations.</p>
|
|
3799
|
-
* @public
|
|
3800
|
-
*/
|
|
3801
|
-
IopsWrite?: number | undefined;
|
|
3802
|
-
/**
|
|
3803
|
-
* <p>Peak IOPS unrelated to read and write operations.</p>
|
|
3804
|
-
* @public
|
|
3805
|
-
*/
|
|
3806
|
-
IopsOther?: number | undefined;
|
|
3807
|
-
/**
|
|
3808
|
-
* <p>Peak total IOPS on your on-premises storage system resource.</p>
|
|
3809
|
-
* @public
|
|
3810
|
-
*/
|
|
3811
|
-
IopsTotal?: number | undefined;
|
|
3812
|
-
/**
|
|
3813
|
-
* <p>Peak throughput related to read operations.</p>
|
|
3814
|
-
* @public
|
|
3815
|
-
*/
|
|
3816
|
-
ThroughputRead?: number | undefined;
|
|
3817
|
-
/**
|
|
3818
|
-
* <p>Peak throughput related to write operations.</p>
|
|
3819
|
-
* @public
|
|
3820
|
-
*/
|
|
3821
|
-
ThroughputWrite?: number | undefined;
|
|
3822
|
-
/**
|
|
3823
|
-
* <p>Peak throughput unrelated to read and write operations.</p>
|
|
3824
|
-
* @public
|
|
3825
|
-
*/
|
|
3826
|
-
ThroughputOther?: number | undefined;
|
|
3827
|
-
/**
|
|
3828
|
-
* <p>Peak total throughput on your on-premises storage system resource.</p>
|
|
3829
|
-
* @public
|
|
3830
|
-
*/
|
|
3831
|
-
ThroughputTotal?: number | undefined;
|
|
3832
|
-
/**
|
|
3833
|
-
* <p>Peak latency for read operations.</p>
|
|
3834
|
-
* @public
|
|
3835
|
-
*/
|
|
3836
|
-
LatencyRead?: number | undefined;
|
|
3837
|
-
/**
|
|
3838
|
-
* <p>Peak latency for write operations.</p>
|
|
3839
|
-
* @public
|
|
3840
|
-
*/
|
|
3841
|
-
LatencyWrite?: number | undefined;
|
|
3842
|
-
/**
|
|
3843
|
-
* <p>Peak latency for operations unrelated to read and write operations.</p>
|
|
3844
|
-
* @public
|
|
3845
|
-
*/
|
|
3846
|
-
LatencyOther?: number | undefined;
|
|
3847
|
-
}
|
|
3848
|
-
/**
|
|
3849
|
-
* <p>The details about an Amazon Web Services storage service that DataSync Discovery recommends for a
|
|
3850
|
-
* resource in your on-premises storage system.</p>
|
|
3851
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html">Recommendations
|
|
3852
|
-
* provided by DataSync Discovery</a>.</p>
|
|
3853
|
-
* @public
|
|
3854
|
-
*/
|
|
3855
|
-
export interface Recommendation {
|
|
3856
|
-
/**
|
|
3857
|
-
* <p>A recommended Amazon Web Services storage service that you can migrate data to based on
|
|
3858
|
-
* information that DataSync Discovery collects about your on-premises storage system.</p>
|
|
3859
|
-
* @public
|
|
3860
|
-
*/
|
|
3861
|
-
StorageType?: string | undefined;
|
|
3862
|
-
/**
|
|
3863
|
-
* <p>Information about how you can set up a recommended Amazon Web Services storage
|
|
3864
|
-
* service.</p>
|
|
3865
|
-
* @public
|
|
3866
|
-
*/
|
|
3867
|
-
StorageConfiguration?: Record<string, string> | undefined;
|
|
3868
|
-
/**
|
|
3869
|
-
* <p>The estimated monthly cost of the recommended Amazon Web Services storage service.</p>
|
|
3870
|
-
* @public
|
|
3871
|
-
*/
|
|
3872
|
-
EstimatedMonthlyStorageCost?: string | undefined;
|
|
3873
|
-
}
|
|
3874
|
-
/**
|
|
3875
|
-
* @public
|
|
3876
|
-
* @enum
|
|
3877
|
-
*/
|
|
3878
|
-
export declare const RecommendationStatus: {
|
|
3879
|
-
readonly COMPLETED: "COMPLETED";
|
|
3880
|
-
readonly FAILED: "FAILED";
|
|
3881
|
-
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
3882
|
-
readonly NONE: "NONE";
|
|
3883
|
-
};
|
|
3884
|
-
/**
|
|
3885
|
-
* @public
|
|
3886
|
-
*/
|
|
3887
|
-
export type RecommendationStatus = (typeof RecommendationStatus)[keyof typeof RecommendationStatus];
|
|
3888
|
-
/**
|
|
3889
|
-
* <p>The information that DataSync Discovery collects about an on-premises storage system
|
|
3890
|
-
* cluster.</p>
|
|
3891
|
-
* @public
|
|
3892
|
-
*/
|
|
3893
|
-
export interface NetAppONTAPCluster {
|
|
3894
|
-
/**
|
|
3895
|
-
* <p>The number of CIFS shares in the cluster.</p>
|
|
3896
|
-
* @public
|
|
3897
|
-
*/
|
|
3898
|
-
CifsShareCount?: number | undefined;
|
|
3899
|
-
/**
|
|
3900
|
-
* <p>The number of NFS volumes in the cluster.</p>
|
|
3901
|
-
* @public
|
|
3902
|
-
*/
|
|
3903
|
-
NfsExportedVolumes?: number | undefined;
|
|
3904
|
-
/**
|
|
3905
|
-
* <p>The universally unique identifier (UUID) of the cluster.</p>
|
|
3906
|
-
* @public
|
|
3907
|
-
*/
|
|
3908
|
-
ResourceId?: string | undefined;
|
|
3909
|
-
/**
|
|
3910
|
-
* <p>The name of the cluster.</p>
|
|
3911
|
-
* @public
|
|
3912
|
-
*/
|
|
3913
|
-
ClusterName?: string | undefined;
|
|
3914
|
-
/**
|
|
3915
|
-
* <p>The performance data that DataSync Discovery collects about the cluster.</p>
|
|
3916
|
-
* @public
|
|
3917
|
-
*/
|
|
3918
|
-
MaxP95Performance?: MaxP95Performance | undefined;
|
|
3919
|
-
/**
|
|
3920
|
-
* <p>The total storage space that's available in the cluster.</p>
|
|
3921
|
-
* @public
|
|
3922
|
-
*/
|
|
3923
|
-
ClusterBlockStorageSize?: number | undefined;
|
|
3924
|
-
/**
|
|
3925
|
-
* <p>The storage space that's being used in a cluster.</p>
|
|
3926
|
-
* @public
|
|
3927
|
-
*/
|
|
3928
|
-
ClusterBlockStorageUsed?: number | undefined;
|
|
3929
|
-
/**
|
|
3930
|
-
* <p>The storage space that's being used in the cluster without accounting for compression or
|
|
3931
|
-
* deduplication.</p>
|
|
3932
|
-
* @public
|
|
3933
|
-
*/
|
|
3934
|
-
ClusterBlockStorageLogicalUsed?: number | undefined;
|
|
3935
|
-
/**
|
|
3936
|
-
* <p>The Amazon Web Services storage services that DataSync Discovery recommends for the cluster. For
|
|
3937
|
-
* more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html">Recommendations
|
|
3938
|
-
* provided by DataSync Discovery</a>.</p>
|
|
3939
|
-
* @public
|
|
3940
|
-
*/
|
|
3941
|
-
Recommendations?: Recommendation[] | undefined;
|
|
3942
|
-
/**
|
|
3943
|
-
* <p>Indicates whether DataSync Discovery recommendations for the cluster are ready to view, incomplete,
|
|
3944
|
-
* or can't be determined.</p>
|
|
3945
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#recommendation-statuses-table">Recommendation statuses</a>.</p>
|
|
3946
|
-
* @public
|
|
3947
|
-
*/
|
|
3948
|
-
RecommendationStatus?: RecommendationStatus | undefined;
|
|
3949
|
-
/**
|
|
3950
|
-
* <p>The number of LUNs (logical unit numbers) in the cluster.</p>
|
|
3951
|
-
* @public
|
|
3952
|
-
*/
|
|
3953
|
-
LunCount?: number | undefined;
|
|
3954
|
-
/**
|
|
3955
|
-
* <p>The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering).</p>
|
|
3956
|
-
* @public
|
|
3957
|
-
*/
|
|
3958
|
-
ClusterCloudStorageUsed?: number | undefined;
|
|
3959
|
-
}
|
|
3960
|
-
/**
|
|
3961
|
-
* <p>The information that DataSync Discovery collects about a storage virtual machine (SVM) in your
|
|
3962
|
-
* on-premises storage system.</p>
|
|
3963
|
-
* @public
|
|
3964
|
-
*/
|
|
3965
|
-
export interface NetAppONTAPSVM {
|
|
3966
|
-
/**
|
|
3967
|
-
* <p>The universally unique identifier (UUID) of the cluster associated with the SVM.</p>
|
|
3968
|
-
* @public
|
|
3969
|
-
*/
|
|
3970
|
-
ClusterUuid?: string | undefined;
|
|
3971
|
-
/**
|
|
3972
|
-
* <p>The UUID of the SVM.</p>
|
|
3973
|
-
* @public
|
|
3974
|
-
*/
|
|
3975
|
-
ResourceId?: string | undefined;
|
|
3976
|
-
/**
|
|
3977
|
-
* <p>The name of the SVM</p>
|
|
3978
|
-
* @public
|
|
3979
|
-
*/
|
|
3980
|
-
SvmName?: string | undefined;
|
|
3981
|
-
/**
|
|
3982
|
-
* <p>The number of CIFS shares in the SVM.</p>
|
|
3983
|
-
* @public
|
|
3984
|
-
*/
|
|
3985
|
-
CifsShareCount?: number | undefined;
|
|
3986
|
-
/**
|
|
3987
|
-
* <p>The data transfer protocols (such as NFS) configured for the SVM.</p>
|
|
3988
|
-
* @public
|
|
3989
|
-
*/
|
|
3990
|
-
EnabledProtocols?: string[] | undefined;
|
|
3991
|
-
/**
|
|
3992
|
-
* <p>The storage space that's being used in the SVM.</p>
|
|
3993
|
-
* @public
|
|
3994
|
-
*/
|
|
3995
|
-
TotalCapacityUsed?: number | undefined;
|
|
3996
|
-
/**
|
|
3997
|
-
* <p>The total storage space that's available in the SVM.</p>
|
|
3998
|
-
* @public
|
|
3999
|
-
*/
|
|
4000
|
-
TotalCapacityProvisioned?: number | undefined;
|
|
4001
|
-
/**
|
|
4002
|
-
* <p>The storage space that's being used in the SVM without accounting for compression or
|
|
4003
|
-
* deduplication.</p>
|
|
4004
|
-
* @public
|
|
4005
|
-
*/
|
|
4006
|
-
TotalLogicalCapacityUsed?: number | undefined;
|
|
4007
|
-
/**
|
|
4008
|
-
* <p>The performance data that DataSync Discovery collects about the SVM.</p>
|
|
4009
|
-
* @public
|
|
4010
|
-
*/
|
|
4011
|
-
MaxP95Performance?: MaxP95Performance | undefined;
|
|
4012
|
-
/**
|
|
4013
|
-
* <p>The Amazon Web Services storage services that DataSync Discovery recommends for the SVM. For more
|
|
4014
|
-
* information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html">Recommendations
|
|
4015
|
-
* provided by DataSync Discovery</a>.</p>
|
|
4016
|
-
* @public
|
|
4017
|
-
*/
|
|
4018
|
-
Recommendations?: Recommendation[] | undefined;
|
|
4019
|
-
/**
|
|
4020
|
-
* <p>The number of NFS volumes in the SVM.</p>
|
|
4021
|
-
* @public
|
|
4022
|
-
*/
|
|
4023
|
-
NfsExportedVolumes?: number | undefined;
|
|
4024
|
-
/**
|
|
4025
|
-
* <p>Indicates whether DataSync Discovery recommendations for the SVM are ready to view, incomplete, or
|
|
4026
|
-
* can't be determined.</p>
|
|
4027
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#recommendation-statuses-table">Recommendation statuses</a>.</p>
|
|
4028
|
-
* @public
|
|
4029
|
-
*/
|
|
4030
|
-
RecommendationStatus?: RecommendationStatus | undefined;
|
|
4031
|
-
/**
|
|
4032
|
-
* <p>The amount of storage in the SVM that's being used for snapshots.</p>
|
|
4033
|
-
* @public
|
|
4034
|
-
*/
|
|
4035
|
-
TotalSnapshotCapacityUsed?: number | undefined;
|
|
4036
|
-
/**
|
|
4037
|
-
* <p>The number of LUNs (logical unit numbers) in the SVM.</p>
|
|
4038
|
-
* @public
|
|
4039
|
-
*/
|
|
4040
|
-
LunCount?: number | undefined;
|
|
4041
|
-
}
|
|
4042
|
-
/**
|
|
4043
|
-
* <p>The information that DataSync Discovery collects about a volume in your on-premises storage
|
|
4044
|
-
* system.</p>
|
|
4045
|
-
* @public
|
|
4046
|
-
*/
|
|
4047
|
-
export interface NetAppONTAPVolume {
|
|
4048
|
-
/**
|
|
4049
|
-
* <p>The name of the volume.</p>
|
|
4050
|
-
* @public
|
|
4051
|
-
*/
|
|
4052
|
-
VolumeName?: string | undefined;
|
|
4053
|
-
/**
|
|
4054
|
-
* <p>The universally unique identifier (UUID) of the volume.</p>
|
|
4055
|
-
* @public
|
|
4056
|
-
*/
|
|
4057
|
-
ResourceId?: string | undefined;
|
|
4058
|
-
/**
|
|
4059
|
-
* <p>The number of CIFS shares in the volume.</p>
|
|
4060
|
-
* @public
|
|
4061
|
-
*/
|
|
4062
|
-
CifsShareCount?: number | undefined;
|
|
4063
|
-
/**
|
|
4064
|
-
* <p>The volume's security style (such as Unix or NTFS).</p>
|
|
4065
|
-
* @public
|
|
4066
|
-
*/
|
|
4067
|
-
SecurityStyle?: string | undefined;
|
|
4068
|
-
/**
|
|
4069
|
-
* <p>The UUID of the storage virtual machine (SVM) associated with the volume.</p>
|
|
4070
|
-
* @public
|
|
4071
|
-
*/
|
|
4072
|
-
SvmUuid?: string | undefined;
|
|
4073
|
-
/**
|
|
4074
|
-
* <p>The name of the SVM associated with the volume.</p>
|
|
4075
|
-
* @public
|
|
4076
|
-
*/
|
|
4077
|
-
SvmName?: string | undefined;
|
|
4078
|
-
/**
|
|
4079
|
-
* <p>The storage space that's being used in the volume.</p>
|
|
4080
|
-
* @public
|
|
4081
|
-
*/
|
|
4082
|
-
CapacityUsed?: number | undefined;
|
|
4083
|
-
/**
|
|
4084
|
-
* <p>The total storage space that's available in the volume.</p>
|
|
4085
|
-
* @public
|
|
4086
|
-
*/
|
|
4087
|
-
CapacityProvisioned?: number | undefined;
|
|
4088
|
-
/**
|
|
4089
|
-
* <p>The storage space that's being used in the volume without accounting for compression or
|
|
4090
|
-
* deduplication.</p>
|
|
4091
|
-
* @public
|
|
4092
|
-
*/
|
|
4093
|
-
LogicalCapacityUsed?: number | undefined;
|
|
4094
|
-
/**
|
|
4095
|
-
* <p>The number of NFS volumes in the volume.</p>
|
|
4096
|
-
* @public
|
|
4097
|
-
*/
|
|
4098
|
-
NfsExported?: boolean | undefined;
|
|
4099
|
-
/**
|
|
4100
|
-
* <p>The amount of storage in the volume that's being used for snapshots.</p>
|
|
4101
|
-
* @public
|
|
4102
|
-
*/
|
|
4103
|
-
SnapshotCapacityUsed?: number | undefined;
|
|
4104
|
-
/**
|
|
4105
|
-
* <p>The performance data that DataSync Discovery collects about the volume.</p>
|
|
4106
|
-
* @public
|
|
4107
|
-
*/
|
|
4108
|
-
MaxP95Performance?: MaxP95Performance | undefined;
|
|
4109
|
-
/**
|
|
4110
|
-
* <p>The Amazon Web Services storage services that DataSync Discovery recommends for the volume. For more
|
|
4111
|
-
* information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html">Recommendations
|
|
4112
|
-
* provided by DataSync Discovery</a>.</p>
|
|
4113
|
-
* @public
|
|
4114
|
-
*/
|
|
4115
|
-
Recommendations?: Recommendation[] | undefined;
|
|
4116
|
-
/**
|
|
4117
|
-
* <p>Indicates whether DataSync Discovery recommendations for the volume are ready to view, incomplete,
|
|
4118
|
-
* or can't be determined.</p>
|
|
4119
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#recommendation-statuses-table">Recommendation statuses</a>.</p>
|
|
4120
|
-
* @public
|
|
4121
|
-
*/
|
|
4122
|
-
RecommendationStatus?: RecommendationStatus | undefined;
|
|
4123
|
-
/**
|
|
4124
|
-
* <p>The number of LUNs (logical unit numbers) in the volume.</p>
|
|
4125
|
-
* @public
|
|
4126
|
-
*/
|
|
4127
|
-
LunCount?: number | undefined;
|
|
4128
|
-
}
|
|
4129
|
-
/**
|
|
4130
|
-
* <p>Information provided by DataSync Discovery about the resources in your on-premises storage
|
|
4131
|
-
* system.</p>
|
|
4132
|
-
* @public
|
|
4133
|
-
*/
|
|
4134
|
-
export interface ResourceDetails {
|
|
4135
|
-
/**
|
|
4136
|
-
* <p>The information that DataSync Discovery collects about storage virtual machines (SVMs) in your
|
|
4137
|
-
* on-premises storage system.</p>
|
|
4138
|
-
* @public
|
|
4139
|
-
*/
|
|
4140
|
-
NetAppONTAPSVMs?: NetAppONTAPSVM[] | undefined;
|
|
4141
|
-
/**
|
|
4142
|
-
* <p>The information that DataSync Discovery collects about volumes in your on-premises storage
|
|
4143
|
-
* system.</p>
|
|
4144
|
-
* @public
|
|
4145
|
-
*/
|
|
4146
|
-
NetAppONTAPVolumes?: NetAppONTAPVolume[] | undefined;
|
|
4147
|
-
/**
|
|
4148
|
-
* <p>The information that DataSync Discovery collects about the
|
|
4149
|
-
* cluster
|
|
4150
|
-
* in your on-premises storage system.</p>
|
|
4151
|
-
* @public
|
|
4152
|
-
*/
|
|
4153
|
-
NetAppONTAPClusters?: NetAppONTAPCluster[] | undefined;
|
|
4154
|
-
}
|
|
4155
|
-
/**
|
|
4156
|
-
* @public
|
|
4157
|
-
*/
|
|
4158
|
-
export interface DescribeStorageSystemResourcesResponse {
|
|
4159
|
-
/**
|
|
4160
|
-
* <p>The information collected about your storage system's resources. A response can also
|
|
4161
|
-
* include Amazon Web Services storage service recommendations.</p>
|
|
4162
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-findings.html">storage resource
|
|
4163
|
-
* information</a> collected by and <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html">recommendations</a> provided by DataSync Discovery.</p>
|
|
4164
|
-
* @public
|
|
4165
|
-
*/
|
|
4166
|
-
ResourceDetails?: ResourceDetails | undefined;
|
|
4167
|
-
/**
|
|
4168
|
-
* <p>The opaque string that indicates the position to begin the next list of results in the
|
|
4169
|
-
* response.</p>
|
|
4170
|
-
* @public
|
|
4171
|
-
*/
|
|
4172
|
-
NextToken?: string | undefined;
|
|
4173
|
-
}
|
|
4174
|
-
/**
|
|
4175
|
-
* <p>DescribeTaskRequest</p>
|
|
4176
|
-
* @public
|
|
4177
|
-
*/
|
|
4178
|
-
export interface DescribeTaskRequest {
|
|
4179
|
-
/**
|
|
4180
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the transfer task that you want information
|
|
4181
|
-
* about.</p>
|
|
4182
|
-
* @public
|
|
4183
|
-
*/
|
|
4184
|
-
TaskArn: string | undefined;
|
|
4185
|
-
}
|
|
4186
|
-
/**
|
|
4187
|
-
* @public
|
|
4188
|
-
* @enum
|
|
4189
|
-
*/
|
|
4190
|
-
export declare const ScheduleDisabledBy: {
|
|
4191
|
-
readonly SERVICE: "SERVICE";
|
|
4192
|
-
readonly USER: "USER";
|
|
4193
|
-
};
|
|
4194
|
-
/**
|
|
4195
|
-
* @public
|
|
4196
|
-
*/
|
|
4197
|
-
export type ScheduleDisabledBy = (typeof ScheduleDisabledBy)[keyof typeof ScheduleDisabledBy];
|
|
4198
|
-
/**
|
|
4199
|
-
* <p>Provides information about your DataSync
|
|
4200
|
-
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">task schedule</a>.</p>
|
|
4201
|
-
* @public
|
|
4202
|
-
*/
|
|
4203
|
-
export interface TaskScheduleDetails {
|
|
4204
|
-
/**
|
|
4205
|
-
* <p>Indicates the last time the status of your task schedule changed. For example, if DataSync automatically disables your schedule because of a repeated error, you can see
|
|
4206
|
-
* when the schedule was disabled.</p>
|
|
4207
|
-
* @public
|
|
4208
|
-
*/
|
|
4209
|
-
StatusUpdateTime?: Date | undefined;
|
|
4210
|
-
/**
|
|
4211
|
-
* <p>Provides a reason if the task schedule is disabled.</p>
|
|
4212
|
-
* <p>If your schedule is disabled by <code>USER</code>, you see a <code>Manually disabled by user.</code> message.</p>
|
|
4213
|
-
* <p>If your schedule is disabled by <code>SERVICE</code>, you see an error message to help you
|
|
4214
|
-
* understand why the task keeps failing. For information on resolving DataSync errors,
|
|
4215
|
-
* see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html">Troubleshooting issues with DataSync transfers</a>.</p>
|
|
4216
|
-
* @public
|
|
4217
|
-
*/
|
|
4218
|
-
DisabledReason?: string | undefined;
|
|
4219
|
-
/**
|
|
4220
|
-
* <p>Indicates how your task schedule was disabled.</p>
|
|
4221
|
-
* <ul>
|
|
4222
|
-
* <li>
|
|
4223
|
-
* <p>
|
|
4224
|
-
* <code>USER</code> - Your schedule was manually disabled by using the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_UpdateTask.html">UpdateTask</a> operation or DataSync console.</p>
|
|
4225
|
-
* </li>
|
|
4226
|
-
* <li>
|
|
4227
|
-
* <p>
|
|
4228
|
-
* <code>SERVICE</code> - Your schedule was automatically disabled by DataSync
|
|
4229
|
-
* because the task failed repeatedly with the same error.</p>
|
|
4230
|
-
* </li>
|
|
4231
|
-
* </ul>
|
|
3324
|
+
* <p>Indicates how your task schedule was disabled.</p>
|
|
3325
|
+
* <ul>
|
|
3326
|
+
* <li>
|
|
3327
|
+
* <p>
|
|
3328
|
+
* <code>USER</code> - Your schedule was manually disabled by using the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_UpdateTask.html">UpdateTask</a> operation or DataSync console.</p>
|
|
3329
|
+
* </li>
|
|
3330
|
+
* <li>
|
|
3331
|
+
* <p>
|
|
3332
|
+
* <code>SERVICE</code> - Your schedule was automatically disabled by DataSync
|
|
3333
|
+
* because the task failed repeatedly with the same error.</p>
|
|
3334
|
+
* </li>
|
|
3335
|
+
* </ul>
|
|
4232
3336
|
* @public
|
|
4233
3337
|
*/
|
|
4234
3338
|
DisabledBy?: ScheduleDisabledBy | undefined;
|
|
@@ -4310,14 +3414,16 @@ export interface DescribeTaskResponse {
|
|
|
4310
3414
|
*/
|
|
4311
3415
|
Options?: Options | undefined;
|
|
4312
3416
|
/**
|
|
4313
|
-
* <p>The exclude filters that define the files, objects, and folders in your source location
|
|
4314
|
-
*
|
|
3417
|
+
* <p>The exclude filters that define the files, objects, and folders in your source location
|
|
3418
|
+
* that you don't want DataSync to transfer. For more information and examples, see
|
|
3419
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Specifying what
|
|
3420
|
+
* DataSync transfers by using filters</a>.</p>
|
|
4315
3421
|
* @public
|
|
4316
3422
|
*/
|
|
4317
3423
|
Excludes?: FilterRule[] | undefined;
|
|
4318
3424
|
/**
|
|
4319
3425
|
* <p>The schedule for when you want your task to run. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">Scheduling your
|
|
4320
|
-
*
|
|
3426
|
+
* task</a>.</p>
|
|
4321
3427
|
* @public
|
|
4322
3428
|
*/
|
|
4323
3429
|
Schedule?: TaskSchedule | undefined;
|
|
@@ -4362,7 +3468,8 @@ export interface DescribeTaskResponse {
|
|
|
4362
3468
|
*/
|
|
4363
3469
|
ScheduleDetails?: TaskScheduleDetails | undefined;
|
|
4364
3470
|
/**
|
|
4365
|
-
* <p>The task mode that you're using. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Choosing a task mode for your data
|
|
3471
|
+
* <p>The task mode that you're using. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Choosing a task mode for your data
|
|
3472
|
+
* transfer</a>.</p>
|
|
4366
3473
|
* @public
|
|
4367
3474
|
*/
|
|
4368
3475
|
TaskMode?: TaskMode | undefined;
|
|
@@ -4443,7 +3550,9 @@ export interface TaskExecutionFilesListedDetail {
|
|
|
4443
3550
|
*/
|
|
4444
3551
|
AtSource?: number | undefined;
|
|
4445
3552
|
/**
|
|
4446
|
-
* <p>The number of objects that DataSync finds at your destination location. This
|
|
3553
|
+
* <p>The number of objects that DataSync finds at your destination location. This
|
|
3554
|
+
* counter is only applicable if you <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-file-object-handling">configure your task</a> to delete data in the destination that isn't in the
|
|
3555
|
+
* source.</p>
|
|
4447
3556
|
* @public
|
|
4448
3557
|
*/
|
|
4449
3558
|
AtDestinationForDelete?: number | undefined;
|
|
@@ -4517,7 +3626,7 @@ export interface TaskExecutionResultDetail {
|
|
|
4517
3626
|
* step. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses">Task
|
|
4518
3627
|
* execution statuses</a>.</p>
|
|
4519
3628
|
* <p>For Enhanced mode tasks, the value is always <code>0</code>. For more information, see
|
|
4520
|
-
*
|
|
3629
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-datasync-transfers">How DataSync transfers your data</a>.</p>
|
|
4521
3630
|
* @public
|
|
4522
3631
|
*/
|
|
4523
3632
|
TransferDuration?: number | undefined;
|
|
@@ -4533,7 +3642,8 @@ export interface TaskExecutionResultDetail {
|
|
|
4533
3642
|
* step. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses">Task
|
|
4534
3643
|
* execution statuses</a>.</p>
|
|
4535
3644
|
* <p>For Enhanced mode tasks, the value is always <code>0</code>. For more information, see
|
|
4536
|
-
*
|
|
3645
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-verifying-works">How DataSync verifies your data's
|
|
3646
|
+
* integrity</a>.</p>
|
|
4537
3647
|
* @public
|
|
4538
3648
|
*/
|
|
4539
3649
|
VerifyDuration?: number | undefined;
|
|
@@ -4602,8 +3712,10 @@ export interface DescribeTaskExecutionResponse {
|
|
|
4602
3712
|
* <p>Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You
|
|
4603
3713
|
* also can specify how to verify data integrity, set bandwidth limits for your task, among other
|
|
4604
3714
|
* options.</p>
|
|
4605
|
-
* <p>Each option has a default value. Unless you need to, you don't have to configure any
|
|
4606
|
-
*
|
|
3715
|
+
* <p>Each option has a default value. Unless you need to, you don't have to configure any
|
|
3716
|
+
* option before calling <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
|
|
3717
|
+
* <p>You also can override your task options for each task execution. For example, you might
|
|
3718
|
+
* want to adjust the <code>LogLevel</code> for an individual execution.</p>
|
|
4607
3719
|
* @public
|
|
4608
3720
|
*/
|
|
4609
3721
|
Options?: Options | undefined;
|
|
@@ -4632,7 +3744,8 @@ export interface DescribeTaskExecutionResponse {
|
|
|
4632
3744
|
StartTime?: Date | undefined;
|
|
4633
3745
|
/**
|
|
4634
3746
|
* <p>The number of files, objects, and directories that DataSync expects to
|
|
4635
|
-
* transfer over the network. This value is calculated while DataSync
|
|
3747
|
+
* transfer over the network. This value is calculated while DataSync
|
|
3748
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses">prepares</a> the transfer.</p>
|
|
4636
3749
|
* <p>How this gets calculated depends primarily on your task’s <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-TransferMode">transfer
|
|
4637
3750
|
* mode</a> configuration:</p>
|
|
4638
3751
|
* <ul>
|
|
@@ -4749,7 +3862,8 @@ export interface DescribeTaskExecutionResponse {
|
|
|
4749
3862
|
*/
|
|
4750
3863
|
EstimatedFilesToDelete?: number | undefined;
|
|
4751
3864
|
/**
|
|
4752
|
-
* <p>The task mode that you're using. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Choosing a task mode for your data
|
|
3865
|
+
* <p>The task mode that you're using. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Choosing a task mode for your data
|
|
3866
|
+
* transfer</a>.</p>
|
|
4753
3867
|
* @public
|
|
4754
3868
|
*/
|
|
4755
3869
|
TaskMode?: TaskMode | undefined;
|
|
@@ -4790,50 +3904,6 @@ export interface DescribeTaskExecutionResponse {
|
|
|
4790
3904
|
*/
|
|
4791
3905
|
FilesFailed?: TaskExecutionFilesFailedDetail | undefined;
|
|
4792
3906
|
}
|
|
4793
|
-
/**
|
|
4794
|
-
* <p>The details about a specific DataSync discovery job.</p>
|
|
4795
|
-
* @public
|
|
4796
|
-
*/
|
|
4797
|
-
export interface DiscoveryJobListEntry {
|
|
4798
|
-
/**
|
|
4799
|
-
* <p>The Amazon Resource Name (ARN) of a discovery job.</p>
|
|
4800
|
-
* @public
|
|
4801
|
-
*/
|
|
4802
|
-
DiscoveryJobArn?: string | undefined;
|
|
4803
|
-
/**
|
|
4804
|
-
* <p>The status of a discovery job. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#discovery-job-statuses-table">Discovery job statuses</a>.</p>
|
|
4805
|
-
* @public
|
|
4806
|
-
*/
|
|
4807
|
-
Status?: DiscoveryJobStatus | undefined;
|
|
4808
|
-
}
|
|
4809
|
-
/**
|
|
4810
|
-
* @public
|
|
4811
|
-
*/
|
|
4812
|
-
export interface GenerateRecommendationsRequest {
|
|
4813
|
-
/**
|
|
4814
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the discovery job that collects information
|
|
4815
|
-
* about your on-premises storage system.</p>
|
|
4816
|
-
* @public
|
|
4817
|
-
*/
|
|
4818
|
-
DiscoveryJobArn: string | undefined;
|
|
4819
|
-
/**
|
|
4820
|
-
* <p>Specifies the universally unique identifiers (UUIDs) of the resources in your storage
|
|
4821
|
-
* system that you want recommendations on.</p>
|
|
4822
|
-
* @public
|
|
4823
|
-
*/
|
|
4824
|
-
ResourceIds: string[] | undefined;
|
|
4825
|
-
/**
|
|
4826
|
-
* <p>Specifies the type of resource in your storage system that you want recommendations
|
|
4827
|
-
* on.</p>
|
|
4828
|
-
* @public
|
|
4829
|
-
*/
|
|
4830
|
-
ResourceType: DiscoveryResourceType | undefined;
|
|
4831
|
-
}
|
|
4832
|
-
/**
|
|
4833
|
-
* @public
|
|
4834
|
-
*/
|
|
4835
|
-
export interface GenerateRecommendationsResponse {
|
|
4836
|
-
}
|
|
4837
3907
|
/**
|
|
4838
3908
|
* <p>ListAgentsRequest</p>
|
|
4839
3909
|
* @public
|
|
@@ -4870,45 +3940,6 @@ export interface ListAgentsResponse {
|
|
|
4870
3940
|
*/
|
|
4871
3941
|
NextToken?: string | undefined;
|
|
4872
3942
|
}
|
|
4873
|
-
/**
|
|
4874
|
-
* @public
|
|
4875
|
-
*/
|
|
4876
|
-
export interface ListDiscoveryJobsRequest {
|
|
4877
|
-
/**
|
|
4878
|
-
* <p>Specifies the Amazon Resource Name (ARN) of an on-premises storage system. Use this
|
|
4879
|
-
* parameter if you only want to list the discovery jobs that are associated with a specific
|
|
4880
|
-
* storage system.</p>
|
|
4881
|
-
* @public
|
|
4882
|
-
*/
|
|
4883
|
-
StorageSystemArn?: string | undefined;
|
|
4884
|
-
/**
|
|
4885
|
-
* <p>Specifies how many results you want in the response.</p>
|
|
4886
|
-
* @public
|
|
4887
|
-
*/
|
|
4888
|
-
MaxResults?: number | undefined;
|
|
4889
|
-
/**
|
|
4890
|
-
* <p>Specifies an opaque string that indicates the position to begin the next list of results
|
|
4891
|
-
* in the response.</p>
|
|
4892
|
-
* @public
|
|
4893
|
-
*/
|
|
4894
|
-
NextToken?: string | undefined;
|
|
4895
|
-
}
|
|
4896
|
-
/**
|
|
4897
|
-
* @public
|
|
4898
|
-
*/
|
|
4899
|
-
export interface ListDiscoveryJobsResponse {
|
|
4900
|
-
/**
|
|
4901
|
-
* <p>The discovery jobs that you've run.</p>
|
|
4902
|
-
* @public
|
|
4903
|
-
*/
|
|
4904
|
-
DiscoveryJobs?: DiscoveryJobListEntry[] | undefined;
|
|
4905
|
-
/**
|
|
4906
|
-
* <p>The opaque string that indicates the position to begin the next list of results in the
|
|
4907
|
-
* response.</p>
|
|
4908
|
-
* @public
|
|
4909
|
-
*/
|
|
4910
|
-
NextToken?: string | undefined;
|
|
4911
|
-
}
|
|
4912
3943
|
/**
|
|
4913
3944
|
* @public
|
|
4914
3945
|
* @enum
|
|
@@ -5047,57 +4078,6 @@ export interface ListLocationsResponse {
|
|
|
5047
4078
|
*/
|
|
5048
4079
|
NextToken?: string | undefined;
|
|
5049
4080
|
}
|
|
5050
|
-
/**
|
|
5051
|
-
* @public
|
|
5052
|
-
*/
|
|
5053
|
-
export interface ListStorageSystemsRequest {
|
|
5054
|
-
/**
|
|
5055
|
-
* <p>Specifies how many results you want in the response.</p>
|
|
5056
|
-
* @public
|
|
5057
|
-
*/
|
|
5058
|
-
MaxResults?: number | undefined;
|
|
5059
|
-
/**
|
|
5060
|
-
* <p>Specifies an opaque string that indicates the position to begin the next list of results
|
|
5061
|
-
* in the response. </p>
|
|
5062
|
-
* @public
|
|
5063
|
-
*/
|
|
5064
|
-
NextToken?: string | undefined;
|
|
5065
|
-
}
|
|
5066
|
-
/**
|
|
5067
|
-
* <p>Information that identifies an on-premises storage system that you're using with
|
|
5068
|
-
* DataSync Discovery.</p>
|
|
5069
|
-
* @public
|
|
5070
|
-
*/
|
|
5071
|
-
export interface StorageSystemListEntry {
|
|
5072
|
-
/**
|
|
5073
|
-
* <p>The Amazon Resource Names (ARN) of an on-premises storage system that you added to
|
|
5074
|
-
* DataSync Discovery.</p>
|
|
5075
|
-
* @public
|
|
5076
|
-
*/
|
|
5077
|
-
StorageSystemArn?: string | undefined;
|
|
5078
|
-
/**
|
|
5079
|
-
* <p>The name of an on-premises storage system that you added to DataSync Discovery.</p>
|
|
5080
|
-
* @public
|
|
5081
|
-
*/
|
|
5082
|
-
Name?: string | undefined;
|
|
5083
|
-
}
|
|
5084
|
-
/**
|
|
5085
|
-
* @public
|
|
5086
|
-
*/
|
|
5087
|
-
export interface ListStorageSystemsResponse {
|
|
5088
|
-
/**
|
|
5089
|
-
* <p>The Amazon Resource Names ARNs) of the on-premises storage systems that you're using with
|
|
5090
|
-
* DataSync Discovery.</p>
|
|
5091
|
-
* @public
|
|
5092
|
-
*/
|
|
5093
|
-
StorageSystems?: StorageSystemListEntry[] | undefined;
|
|
5094
|
-
/**
|
|
5095
|
-
* <p>The opaque string that indicates the position to begin the next list of results in the
|
|
5096
|
-
* response.</p>
|
|
5097
|
-
* @public
|
|
5098
|
-
*/
|
|
5099
|
-
NextToken?: string | undefined;
|
|
5100
|
-
}
|
|
5101
4081
|
/**
|
|
5102
4082
|
* <p>ListTagsForResourceRequest</p>
|
|
5103
4083
|
* @public
|
|
@@ -5179,7 +4159,8 @@ export interface TaskExecutionListEntry {
|
|
|
5179
4159
|
*/
|
|
5180
4160
|
Status?: TaskExecutionStatus | undefined;
|
|
5181
4161
|
/**
|
|
5182
|
-
* <p>The task mode that you're using. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Choosing a task mode for your data
|
|
4162
|
+
* <p>The task mode that you're using. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Choosing a task mode for your data
|
|
4163
|
+
* transfer</a>.</p>
|
|
5183
4164
|
* @public
|
|
5184
4165
|
*/
|
|
5185
4166
|
TaskMode?: TaskMode | undefined;
|
|
@@ -5291,7 +4272,8 @@ export interface TaskListEntry {
|
|
|
5291
4272
|
*/
|
|
5292
4273
|
Name?: string | undefined;
|
|
5293
4274
|
/**
|
|
5294
|
-
* <p>The task mode that you're using. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Choosing a task mode for your data
|
|
4275
|
+
* <p>The task mode that you're using. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Choosing a task mode for your data
|
|
4276
|
+
* transfer</a>.</p>
|
|
5295
4277
|
* @public
|
|
5296
4278
|
*/
|
|
5297
4279
|
TaskMode?: TaskMode | undefined;
|
|
@@ -5313,65 +4295,6 @@ export interface ListTasksResponse {
|
|
|
5313
4295
|
*/
|
|
5314
4296
|
NextToken?: string | undefined;
|
|
5315
4297
|
}
|
|
5316
|
-
/**
|
|
5317
|
-
* @public
|
|
5318
|
-
*/
|
|
5319
|
-
export interface RemoveStorageSystemRequest {
|
|
5320
|
-
/**
|
|
5321
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the storage system that you want to
|
|
5322
|
-
* permanently remove from DataSync Discovery.</p>
|
|
5323
|
-
* @public
|
|
5324
|
-
*/
|
|
5325
|
-
StorageSystemArn: string | undefined;
|
|
5326
|
-
}
|
|
5327
|
-
/**
|
|
5328
|
-
* @public
|
|
5329
|
-
*/
|
|
5330
|
-
export interface RemoveStorageSystemResponse {
|
|
5331
|
-
}
|
|
5332
|
-
/**
|
|
5333
|
-
* @public
|
|
5334
|
-
*/
|
|
5335
|
-
export interface StartDiscoveryJobRequest {
|
|
5336
|
-
/**
|
|
5337
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the on-premises storage system that you want
|
|
5338
|
-
* to run the discovery job on.</p>
|
|
5339
|
-
* @public
|
|
5340
|
-
*/
|
|
5341
|
-
StorageSystemArn: string | undefined;
|
|
5342
|
-
/**
|
|
5343
|
-
* <p>Specifies in minutes how long you want the discovery job to run.</p>
|
|
5344
|
-
* <note>
|
|
5345
|
-
* <p>For more accurate recommendations, we recommend a duration of at least 14 days. Longer
|
|
5346
|
-
* durations allow time to collect a sufficient number of data points and provide a realistic
|
|
5347
|
-
* representation of storage performance and utilization.</p>
|
|
5348
|
-
* </note>
|
|
5349
|
-
* @public
|
|
5350
|
-
*/
|
|
5351
|
-
CollectionDurationMinutes: number | undefined;
|
|
5352
|
-
/**
|
|
5353
|
-
* <p>Specifies a client token to make sure requests with this API operation are idempotent. If
|
|
5354
|
-
* you don't specify a client token, DataSync generates one for you automatically.</p>
|
|
5355
|
-
* @public
|
|
5356
|
-
*/
|
|
5357
|
-
ClientToken?: string | undefined;
|
|
5358
|
-
/**
|
|
5359
|
-
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
|
|
5360
|
-
* resources.</p>
|
|
5361
|
-
* @public
|
|
5362
|
-
*/
|
|
5363
|
-
Tags?: TagListEntry[] | undefined;
|
|
5364
|
-
}
|
|
5365
|
-
/**
|
|
5366
|
-
* @public
|
|
5367
|
-
*/
|
|
5368
|
-
export interface StartDiscoveryJobResponse {
|
|
5369
|
-
/**
|
|
5370
|
-
* <p>The ARN of the discovery job that you started.</p>
|
|
5371
|
-
* @public
|
|
5372
|
-
*/
|
|
5373
|
-
DiscoveryJobArn?: string | undefined;
|
|
5374
|
-
}
|
|
5375
4298
|
/**
|
|
5376
4299
|
* <p>StartTaskExecutionRequest</p>
|
|
5377
4300
|
* @public
|
|
@@ -5386,8 +4309,10 @@ export interface StartTaskExecutionRequest {
|
|
|
5386
4309
|
* <p>Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You
|
|
5387
4310
|
* also can specify how to verify data integrity, set bandwidth limits for your task, among other
|
|
5388
4311
|
* options.</p>
|
|
5389
|
-
* <p>Each option has a default value. Unless you need to, you don't have to configure any
|
|
5390
|
-
*
|
|
4312
|
+
* <p>Each option has a default value. Unless you need to, you don't have to configure any
|
|
4313
|
+
* option before calling <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
|
|
4314
|
+
* <p>You also can override your task options for each task execution. For example, you might
|
|
4315
|
+
* want to adjust the <code>LogLevel</code> for an individual execution.</p>
|
|
5391
4316
|
* @public
|
|
5392
4317
|
*/
|
|
5393
4318
|
OverrideOptions?: Options | undefined;
|
|
@@ -5443,22 +4368,6 @@ export interface StartTaskExecutionResponse {
|
|
|
5443
4368
|
*/
|
|
5444
4369
|
TaskExecutionArn?: string | undefined;
|
|
5445
4370
|
}
|
|
5446
|
-
/**
|
|
5447
|
-
* @public
|
|
5448
|
-
*/
|
|
5449
|
-
export interface StopDiscoveryJobRequest {
|
|
5450
|
-
/**
|
|
5451
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the discovery job that you want to stop.
|
|
5452
|
-
* </p>
|
|
5453
|
-
* @public
|
|
5454
|
-
*/
|
|
5455
|
-
DiscoveryJobArn: string | undefined;
|
|
5456
|
-
}
|
|
5457
|
-
/**
|
|
5458
|
-
* @public
|
|
5459
|
-
*/
|
|
5460
|
-
export interface StopDiscoveryJobResponse {
|
|
5461
|
-
}
|
|
5462
4371
|
/**
|
|
5463
4372
|
* <p>TagResourceRequest</p>
|
|
5464
4373
|
* @public
|
|
@@ -5523,28 +4432,6 @@ export interface UpdateAgentRequest {
|
|
|
5523
4432
|
*/
|
|
5524
4433
|
export interface UpdateAgentResponse {
|
|
5525
4434
|
}
|
|
5526
|
-
/**
|
|
5527
|
-
* @public
|
|
5528
|
-
*/
|
|
5529
|
-
export interface UpdateDiscoveryJobRequest {
|
|
5530
|
-
/**
|
|
5531
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the discovery job that you want to
|
|
5532
|
-
* update.</p>
|
|
5533
|
-
* @public
|
|
5534
|
-
*/
|
|
5535
|
-
DiscoveryJobArn: string | undefined;
|
|
5536
|
-
/**
|
|
5537
|
-
* <p>Specifies in minutes how long that you want the discovery job to run. (You can't set this
|
|
5538
|
-
* parameter to less than the number of minutes that the job has already run for.)</p>
|
|
5539
|
-
* @public
|
|
5540
|
-
*/
|
|
5541
|
-
CollectionDurationMinutes: number | undefined;
|
|
5542
|
-
}
|
|
5543
|
-
/**
|
|
5544
|
-
* @public
|
|
5545
|
-
*/
|
|
5546
|
-
export interface UpdateDiscoveryJobResponse {
|
|
5547
|
-
}
|
|
5548
4435
|
/**
|
|
5549
4436
|
* @public
|
|
5550
4437
|
*/
|
|
@@ -5561,12 +4448,15 @@ export interface UpdateLocationAzureBlobRequest {
|
|
|
5561
4448
|
*/
|
|
5562
4449
|
Subdirectory?: string | undefined;
|
|
5563
4450
|
/**
|
|
5564
|
-
* <p>Specifies the authentication method DataSync uses to access your Azure Blob
|
|
4451
|
+
* <p>Specifies the authentication method DataSync uses to access your Azure Blob
|
|
4452
|
+
* Storage. DataSync can access blob storage using a shared access signature
|
|
4453
|
+
* (SAS).</p>
|
|
5565
4454
|
* @public
|
|
5566
4455
|
*/
|
|
5567
4456
|
AuthenticationType?: AzureBlobAuthenticationType | undefined;
|
|
5568
4457
|
/**
|
|
5569
|
-
* <p>Specifies the SAS configuration that allows DataSync to access your Azure Blob
|
|
4458
|
+
* <p>Specifies the SAS configuration that allows DataSync to access your Azure Blob
|
|
4459
|
+
* Storage.</p>
|
|
5570
4460
|
* @public
|
|
5571
4461
|
*/
|
|
5572
4462
|
SasConfiguration?: AzureBlobSasConfiguration | undefined;
|
|
@@ -5578,14 +4468,16 @@ export interface UpdateLocationAzureBlobRequest {
|
|
|
5578
4468
|
*/
|
|
5579
4469
|
BlobType?: AzureBlobType | undefined;
|
|
5580
4470
|
/**
|
|
5581
|
-
* <p>Specifies the access tier that you want your objects or files transferred into. This only
|
|
4471
|
+
* <p>Specifies the access tier that you want your objects or files transferred into. This only
|
|
4472
|
+
* applies when using the location as a transfer destination. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers">Access tiers</a>.</p>
|
|
5582
4473
|
* @public
|
|
5583
4474
|
*/
|
|
5584
4475
|
AccessTier?: AzureAccessTier | undefined;
|
|
5585
4476
|
/**
|
|
5586
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect
|
|
4477
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect
|
|
4478
|
+
* with your Azure Blob Storage container.</p>
|
|
5587
4479
|
* <p>You can specify more than one agent. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html">Using multiple
|
|
5588
|
-
*
|
|
4480
|
+
* agents for your transfer</a>.</p>
|
|
5589
4481
|
* @public
|
|
5590
4482
|
*/
|
|
5591
4483
|
AgentArns?: string[] | undefined;
|
|
@@ -5600,14 +4492,16 @@ export interface UpdateLocationAzureBlobResponse {
|
|
|
5600
4492
|
*/
|
|
5601
4493
|
export interface UpdateLocationEfsRequest {
|
|
5602
4494
|
/**
|
|
5603
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the Amazon EFS transfer location that
|
|
4495
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the Amazon EFS transfer location that
|
|
4496
|
+
* you're updating.</p>
|
|
5604
4497
|
* @public
|
|
5605
4498
|
*/
|
|
5606
4499
|
LocationArn: string | undefined;
|
|
5607
4500
|
/**
|
|
5608
|
-
* <p>Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or
|
|
4501
|
+
* <p>Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or
|
|
4502
|
+
* destination location).</p>
|
|
5609
4503
|
* <p>By default, DataSync uses the root directory (or <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html">access point</a> if you provide one by using
|
|
5610
|
-
*
|
|
4504
|
+
* <code>AccessPointArn</code>). You can also include subdirectories using forward slashes (for
|
|
5611
4505
|
* example, <code>/path/to/folder</code>).</p>
|
|
5612
4506
|
* @public
|
|
5613
4507
|
*/
|
|
@@ -5615,13 +4509,15 @@ export interface UpdateLocationEfsRequest {
|
|
|
5615
4509
|
/**
|
|
5616
4510
|
* <p>Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses
|
|
5617
4511
|
* to mount your Amazon EFS file system.</p>
|
|
5618
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam">Accessing
|
|
4512
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam">Accessing
|
|
4513
|
+
* restricted Amazon EFS file systems</a>.</p>
|
|
5619
4514
|
* @public
|
|
5620
4515
|
*/
|
|
5621
4516
|
AccessPointArn?: string | undefined;
|
|
5622
4517
|
/**
|
|
5623
4518
|
* <p>Specifies an Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.</p>
|
|
5624
|
-
* <p>For information on creating this role, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role">Creating a DataSync
|
|
4519
|
+
* <p>For information on creating this role, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role">Creating a DataSync
|
|
4520
|
+
* IAM role for Amazon EFS file system access</a>.</p>
|
|
5625
4521
|
* @public
|
|
5626
4522
|
*/
|
|
5627
4523
|
FileSystemAccessRoleArn?: string | undefined;
|
|
@@ -5630,7 +4526,7 @@ export interface UpdateLocationEfsRequest {
|
|
|
5630
4526
|
* encryption when it transfers data to or from your Amazon EFS file system.</p>
|
|
5631
4527
|
* <p>If you specify an access point using <code>AccessPointArn</code> or an IAM
|
|
5632
4528
|
* role using <code>FileSystemAccessRoleArn</code>, you must set this parameter to
|
|
5633
|
-
*
|
|
4529
|
+
* <code>TLS1_2</code>.</p>
|
|
5634
4530
|
* @public
|
|
5635
4531
|
*/
|
|
5636
4532
|
InTransitEncryption?: EfsInTransitEncryption | undefined;
|
|
@@ -5645,13 +4541,18 @@ export interface UpdateLocationEfsResponse {
|
|
|
5645
4541
|
*/
|
|
5646
4542
|
export interface UpdateLocationFsxLustreRequest {
|
|
5647
4543
|
/**
|
|
5648
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the FSx for Lustre transfer location
|
|
4544
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the FSx for Lustre transfer location
|
|
4545
|
+
* that you're updating.</p>
|
|
5649
4546
|
* @public
|
|
5650
4547
|
*/
|
|
5651
4548
|
LocationArn: string | undefined;
|
|
5652
4549
|
/**
|
|
5653
|
-
* <p>Specifies a mount path for your FSx for Lustre file system. The path can include
|
|
5654
|
-
*
|
|
4550
|
+
* <p>Specifies a mount path for your FSx for Lustre file system. The path can include
|
|
4551
|
+
* subdirectories.</p>
|
|
4552
|
+
* <p>When the location is used as a source, DataSync reads data from the mount path.
|
|
4553
|
+
* When the location is used as a destination, DataSync writes data to the mount path.
|
|
4554
|
+
* If you don't include this parameter, DataSync uses the file system's root directory
|
|
4555
|
+
* (<code>/</code>).</p>
|
|
5655
4556
|
* @public
|
|
5656
4557
|
*/
|
|
5657
4558
|
Subdirectory?: string | undefined;
|
|
@@ -5662,14 +4563,16 @@ export interface UpdateLocationFsxLustreRequest {
|
|
|
5662
4563
|
export interface UpdateLocationFsxLustreResponse {
|
|
5663
4564
|
}
|
|
5664
4565
|
/**
|
|
5665
|
-
* <p>Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine
|
|
5666
|
-
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access">Providing DataSync access to FSx for ONTAP file systems</a>.</p>
|
|
4566
|
+
* <p>Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine
|
|
4567
|
+
* (SVM). For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access">Providing DataSync access to FSx for ONTAP file systems</a>.</p>
|
|
5667
4568
|
* @public
|
|
5668
4569
|
*/
|
|
5669
4570
|
export interface FsxUpdateProtocolSmb {
|
|
5670
4571
|
/**
|
|
5671
|
-
* <p>Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs
|
|
5672
|
-
*
|
|
4572
|
+
* <p>Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs
|
|
4573
|
+
* to.</p>
|
|
4574
|
+
* <p>If you have multiple Active Directory domains in your environment, configuring this
|
|
4575
|
+
* parameter makes sure that DataSync connects to the right SVM.</p>
|
|
5673
4576
|
* @public
|
|
5674
4577
|
*/
|
|
5675
4578
|
Domain?: string | undefined;
|
|
@@ -5684,18 +4587,21 @@ export interface FsxUpdateProtocolSmb {
|
|
|
5684
4587
|
*/
|
|
5685
4588
|
Password?: string | undefined;
|
|
5686
4589
|
/**
|
|
5687
|
-
* <p>Specifies a user that can mount and access the files, folders, and metadata in your
|
|
5688
|
-
*
|
|
5689
|
-
*
|
|
4590
|
+
* <p>Specifies a user that can mount and access the files, folders, and metadata in your
|
|
4591
|
+
* SVM.</p>
|
|
4592
|
+
* <p>For information about choosing a user with the right level of access for your transfer,
|
|
4593
|
+
* see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb">Using
|
|
4594
|
+
* the SMB protocol</a>.</p>
|
|
5690
4595
|
* @public
|
|
5691
4596
|
*/
|
|
5692
4597
|
User?: string | undefined;
|
|
5693
4598
|
}
|
|
5694
4599
|
/**
|
|
5695
4600
|
* <p>Specifies the data transfer protocol that DataSync uses to access your
|
|
5696
|
-
*
|
|
4601
|
+
* Amazon FSx file system.</p>
|
|
5697
4602
|
* <note>
|
|
5698
|
-
* <p>You can't update the Network File System (NFS) protocol configuration for FSx for ONTAP locations. DataSync currently only supports NFS version 3 with
|
|
4603
|
+
* <p>You can't update the Network File System (NFS) protocol configuration for FSx for ONTAP locations. DataSync currently only supports NFS version 3 with
|
|
4604
|
+
* this location type.</p>
|
|
5699
4605
|
* </note>
|
|
5700
4606
|
* @public
|
|
5701
4607
|
*/
|
|
@@ -5709,7 +4615,8 @@ export interface FsxUpdateProtocol {
|
|
|
5709
4615
|
NFS?: FsxProtocolNfs | undefined;
|
|
5710
4616
|
/**
|
|
5711
4617
|
* <p>Specifies the Server Message Block (SMB) protocol configuration that DataSync
|
|
5712
|
-
* uses to access your FSx for ONTAP file system's storage virtual machine
|
|
4618
|
+
* uses to access your FSx for ONTAP file system's storage virtual machine
|
|
4619
|
+
* (SVM).</p>
|
|
5713
4620
|
* @public
|
|
5714
4621
|
*/
|
|
5715
4622
|
SMB?: FsxUpdateProtocolSmb | undefined;
|
|
@@ -5719,7 +4626,8 @@ export interface FsxUpdateProtocol {
|
|
|
5719
4626
|
*/
|
|
5720
4627
|
export interface UpdateLocationFsxOntapRequest {
|
|
5721
4628
|
/**
|
|
5722
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP transfer location
|
|
4629
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP transfer location
|
|
4630
|
+
* that you're updating.</p>
|
|
5723
4631
|
* @public
|
|
5724
4632
|
*/
|
|
5725
4633
|
LocationArn: string | undefined;
|
|
@@ -5729,10 +4637,11 @@ export interface UpdateLocationFsxOntapRequest {
|
|
|
5729
4637
|
*/
|
|
5730
4638
|
Protocol?: FsxUpdateProtocol | undefined;
|
|
5731
4639
|
/**
|
|
5732
|
-
* <p>Specifies a path to the file share in the storage virtual machine (SVM) where you want to
|
|
4640
|
+
* <p>Specifies a path to the file share in the storage virtual machine (SVM) where you want to
|
|
4641
|
+
* transfer data to or from.</p>
|
|
5733
4642
|
* <p>You can specify a junction path (also known as a mount point), qtree path (for NFS file
|
|
5734
4643
|
* shares), or share name (for SMB file shares). For example, your mount path might be
|
|
5735
|
-
*
|
|
4644
|
+
* <code>/vol1</code>, <code>/vol1/tree1</code>, or <code>/share1</code>.</p>
|
|
5736
4645
|
* <note>
|
|
5737
4646
|
* <p>Don't specify a junction path in the SVM's root volume. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html">Managing FSx for ONTAP storage virtual machines</a> in the <i>Amazon FSx for NetApp ONTAP User Guide</i>.</p>
|
|
5738
4647
|
* </note>
|
|
@@ -5750,7 +4659,8 @@ export interface UpdateLocationFsxOntapResponse {
|
|
|
5750
4659
|
*/
|
|
5751
4660
|
export interface UpdateLocationFsxOpenZfsRequest {
|
|
5752
4661
|
/**
|
|
5753
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the FSx for OpenZFS transfer
|
|
4662
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the FSx for OpenZFS transfer
|
|
4663
|
+
* location that you're updating.</p>
|
|
5754
4664
|
* @public
|
|
5755
4665
|
*/
|
|
5756
4666
|
LocationArn: string | undefined;
|
|
@@ -5761,8 +4671,9 @@ export interface UpdateLocationFsxOpenZfsRequest {
|
|
|
5761
4671
|
*/
|
|
5762
4672
|
Protocol?: FsxProtocol | undefined;
|
|
5763
4673
|
/**
|
|
5764
|
-
* <p>Specifies a subdirectory in the location's path that must begin with <code>/fsx</code>.
|
|
5765
|
-
*
|
|
4674
|
+
* <p>Specifies a subdirectory in the location's path that must begin with <code>/fsx</code>.
|
|
4675
|
+
* DataSync uses this subdirectory to read or write data (depending on whether the
|
|
4676
|
+
* file system is a source or destination location).</p>
|
|
5766
4677
|
* @public
|
|
5767
4678
|
*/
|
|
5768
4679
|
Subdirectory?: string | undefined;
|
|
@@ -5777,26 +4688,31 @@ export interface UpdateLocationFsxOpenZfsResponse {
|
|
|
5777
4688
|
*/
|
|
5778
4689
|
export interface UpdateLocationFsxWindowsRequest {
|
|
5779
4690
|
/**
|
|
5780
|
-
* <p>Specifies the ARN of the FSx for Windows File Server transfer location that you're
|
|
4691
|
+
* <p>Specifies the ARN of the FSx for Windows File Server transfer location that you're
|
|
4692
|
+
* updating.</p>
|
|
5781
4693
|
* @public
|
|
5782
4694
|
*/
|
|
5783
4695
|
LocationArn: string | undefined;
|
|
5784
4696
|
/**
|
|
5785
|
-
* <p>Specifies a mount path for your file system using forward slashes. DataSync uses
|
|
5786
|
-
* system is a source or
|
|
4697
|
+
* <p>Specifies a mount path for your file system using forward slashes. DataSync uses
|
|
4698
|
+
* this subdirectory to read or write data (depending on whether the file system is a source or
|
|
4699
|
+
* destination location).</p>
|
|
5787
4700
|
* @public
|
|
5788
4701
|
*/
|
|
5789
4702
|
Subdirectory?: string | undefined;
|
|
5790
4703
|
/**
|
|
5791
|
-
* <p>Specifies the name of the Windows domain that your FSx for Windows File Server file system
|
|
5792
|
-
*
|
|
4704
|
+
* <p>Specifies the name of the Windows domain that your FSx for Windows File Server file system
|
|
4705
|
+
* belongs to.</p>
|
|
4706
|
+
* <p>If you have multiple Active Directory domains in your environment, configuring this
|
|
4707
|
+
* parameter makes sure that DataSync connects to the right file system.</p>
|
|
5793
4708
|
* @public
|
|
5794
4709
|
*/
|
|
5795
4710
|
Domain?: string | undefined;
|
|
5796
4711
|
/**
|
|
5797
4712
|
* <p>Specifies the user with the permissions to mount and access the files, folders, and file
|
|
5798
4713
|
* metadata in your FSx for Windows File Server file system.</p>
|
|
5799
|
-
* <p>For information about choosing a user with the right level of access for your transfer,
|
|
4714
|
+
* <p>For information about choosing a user with the right level of access for your transfer,
|
|
4715
|
+
* 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>
|
|
5800
4716
|
* @public
|
|
5801
4717
|
*/
|
|
5802
4718
|
User?: string | undefined;
|
|
@@ -5874,8 +4790,7 @@ export interface UpdateLocationHdfsRequest {
|
|
|
5874
4790
|
/**
|
|
5875
4791
|
* <p>The Kerberos key table (keytab) that contains mappings between the defined Kerberos
|
|
5876
4792
|
* principal and the encrypted keys. You can load the keytab from a file by providing the file's
|
|
5877
|
-
* address
|
|
5878
|
-
* provide the base64-encoded text.</p>
|
|
4793
|
+
* address.</p>
|
|
5879
4794
|
* @public
|
|
5880
4795
|
*/
|
|
5881
4796
|
KerberosKeytab?: Uint8Array | undefined;
|
|
@@ -5888,7 +4803,8 @@ export interface UpdateLocationHdfsRequest {
|
|
|
5888
4803
|
*/
|
|
5889
4804
|
KerberosKrb5Conf?: Uint8Array | undefined;
|
|
5890
4805
|
/**
|
|
5891
|
-
* <p>The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your
|
|
4806
|
+
* <p>The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your
|
|
4807
|
+
* HDFS cluster.</p>
|
|
5892
4808
|
* @public
|
|
5893
4809
|
*/
|
|
5894
4810
|
AgentArns?: string[] | undefined;
|
|
@@ -5911,14 +4827,14 @@ export interface UpdateLocationNfsRequest {
|
|
|
5911
4827
|
/**
|
|
5912
4828
|
* <p>Specifies the export path in your NFS file server that you want DataSync to
|
|
5913
4829
|
* mount.</p>
|
|
5914
|
-
* <p>This path (or a subdirectory of the path) is where DataSync transfers data to
|
|
5915
|
-
*
|
|
4830
|
+
* <p>This path (or a subdirectory of the path) is where DataSync transfers data to or
|
|
4831
|
+
* from. For information on configuring an export for DataSync, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs">Accessing NFS file servers</a>.</p>
|
|
5916
4832
|
* @public
|
|
5917
4833
|
*/
|
|
5918
4834
|
Subdirectory?: string | undefined;
|
|
5919
4835
|
/**
|
|
5920
|
-
* <p>Specifies the DNS name or IP version 4 (IPv4) address of the NFS file
|
|
5921
|
-
*
|
|
4836
|
+
* <p>Specifies the DNS name or IP version 4 (IPv4) address of the NFS file server that your
|
|
4837
|
+
* DataSync agent connects to.</p>
|
|
5922
4838
|
* @public
|
|
5923
4839
|
*/
|
|
5924
4840
|
ServerHostname?: string | undefined;
|
|
@@ -5967,8 +4883,8 @@ export interface UpdateLocationObjectStorageRequest {
|
|
|
5967
4883
|
*/
|
|
5968
4884
|
Subdirectory?: string | undefined;
|
|
5969
4885
|
/**
|
|
5970
|
-
* <p>Specifies the domain name or IP version 4 (IPv4) address of the object storage server that
|
|
5971
|
-
* agent connects to.</p>
|
|
4886
|
+
* <p>Specifies the domain name or IP version 4 (IPv4) address of the object storage server that
|
|
4887
|
+
* your DataSync agent connects to.</p>
|
|
5972
4888
|
* @public
|
|
5973
4889
|
*/
|
|
5974
4890
|
ServerHostname?: string | undefined;
|
|
@@ -6012,7 +4928,7 @@ export interface UpdateLocationObjectStorageRequest {
|
|
|
6012
4928
|
* <code>object_storage_certificates.pem</code> file that includes three certificates:</p>
|
|
6013
4929
|
* <p>
|
|
6014
4930
|
* <code>cat object_server_certificate.pem intermediate_certificate.pem
|
|
6015
|
-
*
|
|
4931
|
+
* ca_root_certificate.pem > object_storage_certificates.pem</code>
|
|
6016
4932
|
* </p>
|
|
6017
4933
|
* <p>To use this parameter, configure <code>ServerProtocol</code> to <code>HTTPS</code>.</p>
|
|
6018
4934
|
* <p>Updating this parameter doesn't interfere with tasks that you have in progress.</p>
|
|
@@ -6030,17 +4946,18 @@ export interface UpdateLocationObjectStorageResponse {
|
|
|
6030
4946
|
*/
|
|
6031
4947
|
export interface UpdateLocationS3Request {
|
|
6032
4948
|
/**
|
|
6033
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the Amazon S3 transfer location that
|
|
4949
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the Amazon S3 transfer location that
|
|
4950
|
+
* you're updating.</p>
|
|
6034
4951
|
* @public
|
|
6035
4952
|
*/
|
|
6036
4953
|
LocationArn: string | undefined;
|
|
6037
4954
|
/**
|
|
6038
|
-
* <p>Specifies a prefix in the S3 bucket that DataSync
|
|
4955
|
+
* <p>Specifies a prefix in the S3 bucket that DataSync reads from or writes to
|
|
6039
4956
|
* (depending on whether the bucket is a source or destination location).</p>
|
|
6040
4957
|
* <note>
|
|
6041
|
-
* <p>DataSync can't transfer objects with a prefix that begins with a slash
|
|
6042
|
-
*
|
|
6043
|
-
*
|
|
4958
|
+
* <p>DataSync can't transfer objects with a prefix that begins with a slash (<code>/</code>)
|
|
4959
|
+
* or includes <code>//</code>, <code>/./</code>, or <code>/../</code> patterns. For
|
|
4960
|
+
* example:</p>
|
|
6044
4961
|
* <ul>
|
|
6045
4962
|
* <li>
|
|
6046
4963
|
* <p>
|
|
@@ -6071,16 +4988,17 @@ export interface UpdateLocationS3Request {
|
|
|
6071
4988
|
* <p>Specifies the storage class that you want your objects to use when Amazon S3 is a
|
|
6072
4989
|
* transfer destination.</p>
|
|
6073
4990
|
* <p>For buckets in Amazon Web Services Regions, the storage class defaults to
|
|
6074
|
-
*
|
|
6075
|
-
*
|
|
4991
|
+
* <code>STANDARD</code>. For buckets on Outposts, the storage class defaults to
|
|
4992
|
+
* <code>OUTPOSTS</code>.</p>
|
|
6076
4993
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Storage class
|
|
6077
|
-
*
|
|
4994
|
+
* considerations with Amazon S3 transfers</a>.</p>
|
|
6078
4995
|
* @public
|
|
6079
4996
|
*/
|
|
6080
4997
|
S3StorageClass?: S3StorageClass | undefined;
|
|
6081
4998
|
/**
|
|
6082
4999
|
* <p>Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.</p>
|
|
6083
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access">Providing
|
|
5000
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access">Providing
|
|
5001
|
+
* DataSync access to S3 buckets</a>.</p>
|
|
6084
5002
|
* @public
|
|
6085
5003
|
*/
|
|
6086
5004
|
S3Config?: S3Config | undefined;
|
|
@@ -6102,7 +5020,7 @@ export interface UpdateLocationSmbRequest {
|
|
|
6102
5020
|
/**
|
|
6103
5021
|
* <p>Specifies the name of the share exported by your SMB file server where DataSync
|
|
6104
5022
|
* will read or write data. You can include a subdirectory in the share path (for example,
|
|
6105
|
-
*
|
|
5023
|
+
* <code>/path/to/subdirectory</code>). Make sure that other SMB clients in your network can
|
|
6106
5024
|
* also mount this path.</p>
|
|
6107
5025
|
* <p>To copy all data in the specified subdirectory, DataSync must be able to mount
|
|
6108
5026
|
* 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">Providing DataSync access to SMB file servers</a>.</p>
|
|
@@ -6135,7 +5053,8 @@ export interface UpdateLocationSmbRequest {
|
|
|
6135
5053
|
/**
|
|
6136
5054
|
* <p>Specifies the Windows domain name that your SMB file server belongs to. This parameter
|
|
6137
5055
|
* applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>
|
|
6138
|
-
* <p>If you have multiple domains in your environment, configuring this parameter makes sure
|
|
5056
|
+
* <p>If you have multiple domains in your environment, configuring this parameter makes sure
|
|
5057
|
+
* that DataSync connects to the right file server.</p>
|
|
6139
5058
|
* @public
|
|
6140
5059
|
*/
|
|
6141
5060
|
Domain?: string | undefined;
|
|
@@ -6187,10 +5106,9 @@ export interface UpdateLocationSmbRequest {
|
|
|
6187
5106
|
/**
|
|
6188
5107
|
* <p>Specifies your Kerberos key table (keytab) file, which includes mappings between your
|
|
6189
5108
|
* Kerberos principal and encryption keys.</p>
|
|
6190
|
-
* <p>The file must be base64 encoded. If you're using the CLI, the encoding is
|
|
6191
|
-
* done for you.</p>
|
|
6192
5109
|
* <p>To avoid task execution errors, make sure that the Kerberos principal that you use to
|
|
6193
|
-
* create the keytab file matches exactly what you specify for
|
|
5110
|
+
* create the keytab file matches exactly what you specify for
|
|
5111
|
+
* <code>KerberosPrincipal</code>.</p>
|
|
6194
5112
|
* @public
|
|
6195
5113
|
*/
|
|
6196
5114
|
KerberosKeytab?: Uint8Array | undefined;
|
|
@@ -6208,50 +5126,6 @@ export interface UpdateLocationSmbRequest {
|
|
|
6208
5126
|
*/
|
|
6209
5127
|
export interface UpdateLocationSmbResponse {
|
|
6210
5128
|
}
|
|
6211
|
-
/**
|
|
6212
|
-
* @public
|
|
6213
|
-
*/
|
|
6214
|
-
export interface UpdateStorageSystemRequest {
|
|
6215
|
-
/**
|
|
6216
|
-
* <p>Specifies the ARN of the on-premises storage system that you want reconfigure.</p>
|
|
6217
|
-
* @public
|
|
6218
|
-
*/
|
|
6219
|
-
StorageSystemArn: string | undefined;
|
|
6220
|
-
/**
|
|
6221
|
-
* <p>Specifies the server name and network port required to connect with your on-premises
|
|
6222
|
-
* storage system's management interface.</p>
|
|
6223
|
-
* @public
|
|
6224
|
-
*/
|
|
6225
|
-
ServerConfiguration?: DiscoveryServerConfiguration | undefined;
|
|
6226
|
-
/**
|
|
6227
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads
|
|
6228
|
-
* your on-premises storage system. You can only specify one ARN.</p>
|
|
6229
|
-
* @public
|
|
6230
|
-
*/
|
|
6231
|
-
AgentArns?: string[] | undefined;
|
|
6232
|
-
/**
|
|
6233
|
-
* <p>Specifies a familiar name for your on-premises storage system.</p>
|
|
6234
|
-
* @public
|
|
6235
|
-
*/
|
|
6236
|
-
Name?: string | undefined;
|
|
6237
|
-
/**
|
|
6238
|
-
* <p>Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging
|
|
6239
|
-
* discovery job events.</p>
|
|
6240
|
-
* @public
|
|
6241
|
-
*/
|
|
6242
|
-
CloudWatchLogGroupArn?: string | undefined;
|
|
6243
|
-
/**
|
|
6244
|
-
* <p>Specifies the user name and password for accessing your on-premises storage system's
|
|
6245
|
-
* management interface.</p>
|
|
6246
|
-
* @public
|
|
6247
|
-
*/
|
|
6248
|
-
Credentials?: Credentials | undefined;
|
|
6249
|
-
}
|
|
6250
|
-
/**
|
|
6251
|
-
* @public
|
|
6252
|
-
*/
|
|
6253
|
-
export interface UpdateStorageSystemResponse {
|
|
6254
|
-
}
|
|
6255
5129
|
/**
|
|
6256
5130
|
* <p>UpdateTaskResponse</p>
|
|
6257
5131
|
* @public
|
|
@@ -6266,20 +5140,23 @@ export interface UpdateTaskRequest {
|
|
|
6266
5140
|
* <p>Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You
|
|
6267
5141
|
* also can specify how to verify data integrity, set bandwidth limits for your task, among other
|
|
6268
5142
|
* options.</p>
|
|
6269
|
-
* <p>Each option has a default value. Unless you need to, you don't have to configure any
|
|
6270
|
-
*
|
|
5143
|
+
* <p>Each option has a default value. Unless you need to, you don't have to configure any
|
|
5144
|
+
* option before calling <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
|
|
5145
|
+
* <p>You also can override your task options for each task execution. For example, you might
|
|
5146
|
+
* want to adjust the <code>LogLevel</code> for an individual execution.</p>
|
|
6271
5147
|
* @public
|
|
6272
5148
|
*/
|
|
6273
5149
|
Options?: Options | undefined;
|
|
6274
5150
|
/**
|
|
6275
|
-
* <p>Specifies exclude filters that define the files, objects, and folders in your source
|
|
6276
|
-
*
|
|
5151
|
+
* <p>Specifies exclude filters that define the files, objects, and folders in your source
|
|
5152
|
+
* location that you don't want DataSync to transfer. For more information and
|
|
5153
|
+
* examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Specifying what DataSync transfers by using filters</a>.</p>
|
|
6277
5154
|
* @public
|
|
6278
5155
|
*/
|
|
6279
5156
|
Excludes?: FilterRule[] | undefined;
|
|
6280
5157
|
/**
|
|
6281
5158
|
* <p>Specifies a schedule for when you want your task to run. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">Scheduling your
|
|
6282
|
-
*
|
|
5159
|
+
* task</a>.</p>
|
|
6283
5160
|
* @public
|
|
6284
5161
|
*/
|
|
6285
5162
|
Schedule?: TaskSchedule | undefined;
|
|
@@ -6309,7 +5186,8 @@ export interface UpdateTaskRequest {
|
|
|
6309
5186
|
Includes?: FilterRule[] | undefined;
|
|
6310
5187
|
/**
|
|
6311
5188
|
* <p>Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html">Specifying what DataSync transfers by using a manifest</a>.</p>
|
|
6312
|
-
* <p>When using this parameter, your caller identity (the IAM role that you're
|
|
5189
|
+
* <p>When using this parameter, your caller identity (the IAM role that you're
|
|
5190
|
+
* using DataSync with) must have the <code>iam:PassRole</code> permission. The <a href="https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess">AWSDataSyncFullAccess</a> policy includes this permission.</p>
|
|
6313
5191
|
* <p>To remove a manifest configuration, specify this parameter as empty.</p>
|
|
6314
5192
|
* @public
|
|
6315
5193
|
*/
|
|
@@ -6318,7 +5196,8 @@ export interface UpdateTaskRequest {
|
|
|
6318
5196
|
* <p>Specifies how you want to configure a task report, which provides detailed information
|
|
6319
5197
|
* about your DataSync transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">Monitoring your DataSync
|
|
6320
5198
|
* transfers with task reports</a>.</p>
|
|
6321
|
-
* <p>When using this parameter, your caller identity (the IAM role that you're
|
|
5199
|
+
* <p>When using this parameter, your caller identity (the IAM role that you're
|
|
5200
|
+
* using DataSync with) must have the <code>iam:PassRole</code> permission. The <a href="https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess">AWSDataSyncFullAccess</a> policy includes this permission.</p>
|
|
6322
5201
|
* <p>To remove a task report configuration, specify this parameter as empty.</p>
|
|
6323
5202
|
* @public
|
|
6324
5203
|
*/
|
|
@@ -6343,8 +5222,10 @@ export interface UpdateTaskExecutionRequest {
|
|
|
6343
5222
|
* <p>Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You
|
|
6344
5223
|
* also can specify how to verify data integrity, set bandwidth limits for your task, among other
|
|
6345
5224
|
* options.</p>
|
|
6346
|
-
* <p>Each option has a default value. Unless you need to, you don't have to configure any
|
|
6347
|
-
*
|
|
5225
|
+
* <p>Each option has a default value. Unless you need to, you don't have to configure any
|
|
5226
|
+
* option before calling <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
|
|
5227
|
+
* <p>You also can override your task options for each task execution. For example, you might
|
|
5228
|
+
* want to adjust the <code>LogLevel</code> for an individual execution.</p>
|
|
6348
5229
|
* @public
|
|
6349
5230
|
*/
|
|
6350
5231
|
Options: Options | undefined;
|
|
@@ -6354,14 +5235,6 @@ export interface UpdateTaskExecutionRequest {
|
|
|
6354
5235
|
*/
|
|
6355
5236
|
export interface UpdateTaskExecutionResponse {
|
|
6356
5237
|
}
|
|
6357
|
-
/**
|
|
6358
|
-
* @internal
|
|
6359
|
-
*/
|
|
6360
|
-
export declare const CredentialsFilterSensitiveLog: (obj: Credentials) => any;
|
|
6361
|
-
/**
|
|
6362
|
-
* @internal
|
|
6363
|
-
*/
|
|
6364
|
-
export declare const AddStorageSystemRequestFilterSensitiveLog: (obj: AddStorageSystemRequest) => any;
|
|
6365
5238
|
/**
|
|
6366
5239
|
* @internal
|
|
6367
5240
|
*/
|
|
@@ -6438,7 +5311,3 @@ export declare const UpdateLocationObjectStorageRequestFilterSensitiveLog: (obj:
|
|
|
6438
5311
|
* @internal
|
|
6439
5312
|
*/
|
|
6440
5313
|
export declare const UpdateLocationSmbRequestFilterSensitiveLog: (obj: UpdateLocationSmbRequest) => any;
|
|
6441
|
-
/**
|
|
6442
|
-
* @internal
|
|
6443
|
-
*/
|
|
6444
|
-
export declare const UpdateStorageSystemRequestFilterSensitiveLog: (obj: UpdateStorageSystemRequest) => any;
|