@aws-sdk/client-datasync 3.679.0 → 3.683.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 +1 -1
- package/dist-cjs/index.js +11 -0
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/protocols/Aws_json1_1.js +5 -0
- package/dist-types/commands/CreateAgentCommand.d.ts +4 -19
- package/dist-types/commands/CreateTaskCommand.d.ts +1 -0
- package/dist-types/commands/DescribeTaskCommand.d.ts +1 -0
- package/dist-types/commands/DescribeTaskExecutionCommand.d.ts +19 -2
- package/dist-types/commands/ListTaskExecutionsCommand.d.ts +1 -0
- package/dist-types/commands/ListTasksCommand.d.ts +1 -0
- package/dist-types/commands/StartTaskExecutionCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +377 -128
- package/dist-types/ts3.4/models/models_0.d.ts +23 -0
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -19,7 +19,7 @@ Guide</a>
|
|
|
19
19
|
|
|
20
20
|
## Installing
|
|
21
21
|
|
|
22
|
-
To install
|
|
22
|
+
To install this package, simply type add or install @aws-sdk/client-datasync
|
|
23
23
|
using your favorite package manager:
|
|
24
24
|
|
|
25
25
|
- `npm install @aws-sdk/client-datasync`
|
package/dist-cjs/index.js
CHANGED
|
@@ -130,6 +130,7 @@ __export(src_exports, {
|
|
|
130
130
|
TagResourceCommand: () => TagResourceCommand,
|
|
131
131
|
TaskExecutionStatus: () => TaskExecutionStatus,
|
|
132
132
|
TaskFilterName: () => TaskFilterName,
|
|
133
|
+
TaskMode: () => TaskMode,
|
|
133
134
|
TaskQueueing: () => TaskQueueing,
|
|
134
135
|
TaskStatus: () => TaskStatus,
|
|
135
136
|
TransferMode: () => TransferMode,
|
|
@@ -504,6 +505,10 @@ var ScheduleStatus = {
|
|
|
504
505
|
DISABLED: "DISABLED",
|
|
505
506
|
ENABLED: "ENABLED"
|
|
506
507
|
};
|
|
508
|
+
var TaskMode = {
|
|
509
|
+
BASIC: "BASIC",
|
|
510
|
+
ENHANCED: "ENHANCED"
|
|
511
|
+
};
|
|
507
512
|
var ObjectVersionIds = {
|
|
508
513
|
INCLUDE: "INCLUDE",
|
|
509
514
|
NONE: "NONE"
|
|
@@ -2209,6 +2214,9 @@ var de_DescribeTaskExecutionResponse = /* @__PURE__ */ __name((output, context)
|
|
|
2209
2214
|
EstimatedFilesToTransfer: import_smithy_client.expectLong,
|
|
2210
2215
|
Excludes: import_smithy_client._json,
|
|
2211
2216
|
FilesDeleted: import_smithy_client.expectLong,
|
|
2217
|
+
FilesFailed: import_smithy_client._json,
|
|
2218
|
+
FilesListed: import_smithy_client._json,
|
|
2219
|
+
FilesPrepared: import_smithy_client.expectLong,
|
|
2212
2220
|
FilesSkipped: import_smithy_client.expectLong,
|
|
2213
2221
|
FilesTransferred: import_smithy_client.expectLong,
|
|
2214
2222
|
FilesVerified: import_smithy_client.expectLong,
|
|
@@ -2220,6 +2228,7 @@ var de_DescribeTaskExecutionResponse = /* @__PURE__ */ __name((output, context)
|
|
|
2220
2228
|
StartTime: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
|
|
2221
2229
|
Status: import_smithy_client.expectString,
|
|
2222
2230
|
TaskExecutionArn: import_smithy_client.expectString,
|
|
2231
|
+
TaskMode: import_smithy_client.expectString,
|
|
2223
2232
|
TaskReportConfig: import_smithy_client._json
|
|
2224
2233
|
});
|
|
2225
2234
|
}, "de_DescribeTaskExecutionResponse");
|
|
@@ -2243,6 +2252,7 @@ var de_DescribeTaskResponse = /* @__PURE__ */ __name((output, context) => {
|
|
|
2243
2252
|
SourceNetworkInterfaceArns: import_smithy_client._json,
|
|
2244
2253
|
Status: import_smithy_client.expectString,
|
|
2245
2254
|
TaskArn: import_smithy_client.expectString,
|
|
2255
|
+
TaskMode: import_smithy_client.expectString,
|
|
2246
2256
|
TaskReportConfig: import_smithy_client._json
|
|
2247
2257
|
});
|
|
2248
2258
|
}, "de_DescribeTaskResponse");
|
|
@@ -3475,6 +3485,7 @@ var paginateListTasks = (0, import_core.createPaginator)(DataSyncClient, ListTas
|
|
|
3475
3485
|
Uid,
|
|
3476
3486
|
VerifyMode,
|
|
3477
3487
|
ScheduleStatus,
|
|
3488
|
+
TaskMode,
|
|
3478
3489
|
ObjectVersionIds,
|
|
3479
3490
|
ReportOutputType,
|
|
3480
3491
|
ReportLevel,
|
|
@@ -168,6 +168,10 @@ export const ScheduleStatus = {
|
|
|
168
168
|
DISABLED: "DISABLED",
|
|
169
169
|
ENABLED: "ENABLED",
|
|
170
170
|
};
|
|
171
|
+
export const TaskMode = {
|
|
172
|
+
BASIC: "BASIC",
|
|
173
|
+
ENHANCED: "ENHANCED",
|
|
174
|
+
};
|
|
171
175
|
export const ObjectVersionIds = {
|
|
172
176
|
INCLUDE: "INCLUDE",
|
|
173
177
|
NONE: "NONE",
|
|
@@ -1542,6 +1542,9 @@ const de_DescribeTaskExecutionResponse = (output, context) => {
|
|
|
1542
1542
|
EstimatedFilesToTransfer: __expectLong,
|
|
1543
1543
|
Excludes: _json,
|
|
1544
1544
|
FilesDeleted: __expectLong,
|
|
1545
|
+
FilesFailed: _json,
|
|
1546
|
+
FilesListed: _json,
|
|
1547
|
+
FilesPrepared: __expectLong,
|
|
1545
1548
|
FilesSkipped: __expectLong,
|
|
1546
1549
|
FilesTransferred: __expectLong,
|
|
1547
1550
|
FilesVerified: __expectLong,
|
|
@@ -1553,6 +1556,7 @@ const de_DescribeTaskExecutionResponse = (output, context) => {
|
|
|
1553
1556
|
StartTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
1554
1557
|
Status: __expectString,
|
|
1555
1558
|
TaskExecutionArn: __expectString,
|
|
1559
|
+
TaskMode: __expectString,
|
|
1556
1560
|
TaskReportConfig: _json,
|
|
1557
1561
|
});
|
|
1558
1562
|
};
|
|
@@ -1576,6 +1580,7 @@ const de_DescribeTaskResponse = (output, context) => {
|
|
|
1576
1580
|
SourceNetworkInterfaceArns: _json,
|
|
1577
1581
|
Status: __expectString,
|
|
1578
1582
|
TaskArn: __expectString,
|
|
1583
|
+
TaskMode: __expectString,
|
|
1579
1584
|
TaskReportConfig: _json,
|
|
1580
1585
|
});
|
|
1581
1586
|
};
|
|
@@ -27,25 +27,10 @@ declare const CreateAgentCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Activates an DataSync agent that you
|
|
31
|
-
*
|
|
32
|
-
* <p>If you haven't deployed an agent yet, see
|
|
33
|
-
*
|
|
34
|
-
* <li>
|
|
35
|
-
* <p>
|
|
36
|
-
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/agent-requirements.html">Agent requirements</a>
|
|
37
|
-
* </p>
|
|
38
|
-
* </li>
|
|
39
|
-
* <li>
|
|
40
|
-
* <p>
|
|
41
|
-
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-agent.html">Create an agent</a>
|
|
42
|
-
* </p>
|
|
43
|
-
* </li>
|
|
44
|
-
* </ul>
|
|
45
|
-
* <note>
|
|
46
|
-
* <p>If you're transferring between Amazon Web Services storage services, you don't need a
|
|
47
|
-
* DataSync agent. </p>
|
|
48
|
-
* </note>
|
|
30
|
+
* <p>Activates an DataSync agent that you deploy in your storage environment.
|
|
31
|
+
* The activation process associates the agent with your Amazon Web Services account.</p>
|
|
32
|
+
* <p>If you haven't deployed an agent yet, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html">Do I need a DataSync agent?</a>
|
|
33
|
+
* </p>
|
|
49
34
|
* @example
|
|
50
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
51
36
|
* ```javascript
|
|
@@ -28,8 +28,13 @@ declare const DescribeTaskExecutionCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Provides information about an execution of your DataSync task. You can
|
|
31
|
-
* use this operation to help monitor the progress of an ongoing transfer or check the
|
|
32
|
-
* the transfer.</p>
|
|
31
|
+
* use this operation to help monitor the progress of an ongoing data transfer or check the
|
|
32
|
+
* results of the transfer.</p>
|
|
33
|
+
* <note>
|
|
34
|
+
* <p>Some <code>DescribeTaskExecution</code> response elements are only relevant to a
|
|
35
|
+
* specific task mode. For information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences">Understanding task mode differences</a> and <a href="https://docs.aws.amazon.com/datasync/latest/userguide/transfer-performance-metrics.html">Understanding data
|
|
36
|
+
* transfer performance metrics</a>.</p>
|
|
37
|
+
* </note>
|
|
33
38
|
* @example
|
|
34
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
40
|
* ```javascript
|
|
@@ -138,6 +143,18 @@ declare const DescribeTaskExecutionCommand_base: {
|
|
|
138
143
|
* // ErrorDetail: "STRING_VALUE",
|
|
139
144
|
* // },
|
|
140
145
|
* // EstimatedFilesToDelete: Number("long"),
|
|
146
|
+
* // TaskMode: "BASIC" || "ENHANCED",
|
|
147
|
+
* // FilesPrepared: Number("long"),
|
|
148
|
+
* // FilesListed: { // TaskExecutionFilesListedDetail
|
|
149
|
+
* // AtSource: Number("long"),
|
|
150
|
+
* // AtDestinationForDelete: Number("long"),
|
|
151
|
+
* // },
|
|
152
|
+
* // FilesFailed: { // TaskExecutionFilesFailedDetail
|
|
153
|
+
* // Prepare: Number("long"),
|
|
154
|
+
* // Transfer: Number("long"),
|
|
155
|
+
* // Verify: Number("long"),
|
|
156
|
+
* // Delete: Number("long"),
|
|
157
|
+
* // },
|
|
141
158
|
* // };
|
|
142
159
|
*
|
|
143
160
|
* ```
|
|
@@ -46,6 +46,7 @@ declare const ListTaskExecutionsCommand_base: {
|
|
|
46
46
|
* // { // TaskExecutionListEntry
|
|
47
47
|
* // TaskExecutionArn: "STRING_VALUE",
|
|
48
48
|
* // Status: "QUEUED" || "CANCELLING" || "LAUNCHING" || "PREPARING" || "TRANSFERRING" || "VERIFYING" || "SUCCESS" || "ERROR",
|
|
49
|
+
* // TaskMode: "BASIC" || "ENHANCED",
|
|
49
50
|
* // },
|
|
50
51
|
* // ],
|
|
51
52
|
* // NextToken: "STRING_VALUE",
|
|
@@ -55,6 +55,7 @@ declare const ListTasksCommand_base: {
|
|
|
55
55
|
* // TaskArn: "STRING_VALUE",
|
|
56
56
|
* // Status: "AVAILABLE" || "CREATING" || "QUEUED" || "RUNNING" || "UNAVAILABLE",
|
|
57
57
|
* // Name: "STRING_VALUE",
|
|
58
|
+
* // TaskMode: "BASIC" || "ENHANCED",
|
|
58
59
|
* // },
|
|
59
60
|
* // ],
|
|
60
61
|
* // NextToken: "STRING_VALUE",
|
|
@@ -29,7 +29,7 @@ declare const StartTaskExecutionCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Starts an DataSync transfer task. For each task, you can only run one task
|
|
31
31
|
* execution at a time.</p>
|
|
32
|
-
* <p>There are several
|
|
32
|
+
* <p>There are several steps to a task execution. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#understand-task-execution-statuses">Task execution statuses</a>.</p>
|
|
33
33
|
* <important>
|
|
34
34
|
* <p>If you're planning to transfer data to or from an Amazon S3 location, review
|
|
35
35
|
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests">how
|
|
@@ -342,13 +342,13 @@ export interface Capacity {
|
|
|
342
342
|
export interface CreateAgentRequest {
|
|
343
343
|
/**
|
|
344
344
|
* <p>Specifies your DataSync agent's activation key. If you don't have an
|
|
345
|
-
* activation key, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html">
|
|
345
|
+
* activation key, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html">Activating your agent</a>.</p>
|
|
346
346
|
* @public
|
|
347
347
|
*/
|
|
348
348
|
ActivationKey: string | undefined;
|
|
349
349
|
/**
|
|
350
|
-
* <p>Specifies a name for your agent.
|
|
351
|
-
*
|
|
350
|
+
* <p>Specifies a name for your agent. We recommend specifying a name that you can
|
|
351
|
+
* remember.</p>
|
|
352
352
|
* @public
|
|
353
353
|
*/
|
|
354
354
|
AgentName?: string;
|
|
@@ -359,27 +359,24 @@ export interface CreateAgentRequest {
|
|
|
359
359
|
*/
|
|
360
360
|
Tags?: TagListEntry[];
|
|
361
361
|
/**
|
|
362
|
-
* <p>Specifies the ID of the VPC endpoint that you
|
|
363
|
-
* a VPC endpoint ID looks like <code>vpce-01234d5aff67890e1</code>.</p>
|
|
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 endpoint</a> that you're using. For
|
|
363
|
+
* example, a VPC endpoint ID looks like <code>vpce-01234d5aff67890e1</code>.</p>
|
|
364
364
|
* <important>
|
|
365
|
-
* <p>The VPC endpoint you use must include the DataSync service name (for
|
|
366
|
-
*
|
|
365
|
+
* <p>The VPC service endpoint you use must include the DataSync service name (for
|
|
366
|
+
* example, <code>com.amazonaws.us-east-2.datasync</code>).</p>
|
|
367
367
|
* </important>
|
|
368
368
|
* @public
|
|
369
369
|
*/
|
|
370
370
|
VpcEndpointId?: string;
|
|
371
371
|
/**
|
|
372
|
-
* <p>Specifies the ARN of the subnet where
|
|
373
|
-
*
|
|
374
|
-
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">network
|
|
375
|
-
* interfaces</a> for your transfer. You can only specify one ARN.</p>
|
|
372
|
+
* <p>Specifies the ARN of the subnet where your VPC service endpoint is located. You can only
|
|
373
|
+
* specify one ARN.</p>
|
|
376
374
|
* @public
|
|
377
375
|
*/
|
|
378
376
|
SubnetArns?: string[];
|
|
379
377
|
/**
|
|
380
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the security group that
|
|
381
|
-
*
|
|
382
|
-
* interfaces</a> when <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc">using a virtual private cloud (VPC) endpoint</a>. You can only specify one ARN.</p>
|
|
378
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the security group that allows traffic between
|
|
379
|
+
* your agent and VPC service endpoint. You can only specify one ARN.</p>
|
|
383
380
|
* @public
|
|
384
381
|
*/
|
|
385
382
|
SecurityGroupArns?: string[];
|
|
@@ -457,7 +454,8 @@ export interface CreateLocationAzureBlobResponse {
|
|
|
457
454
|
LocationArn?: string;
|
|
458
455
|
}
|
|
459
456
|
/**
|
|
460
|
-
* <p>The subnet and security groups that DataSync uses to
|
|
457
|
+
* <p>The subnet and security groups that DataSync uses to connect to one of your
|
|
458
|
+
* Amazon EFS file system's <a href="https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html">mount targets</a>.</p>
|
|
461
459
|
* @public
|
|
462
460
|
*/
|
|
463
461
|
export interface Ec2Config {
|
|
@@ -504,23 +502,22 @@ export type EfsInTransitEncryption = (typeof EfsInTransitEncryption)[keyof typeo
|
|
|
504
502
|
*/
|
|
505
503
|
export interface CreateLocationEfsRequest {
|
|
506
504
|
/**
|
|
507
|
-
* <p>Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location)
|
|
508
|
-
*
|
|
509
|
-
*
|
|
510
|
-
*
|
|
511
|
-
*
|
|
512
|
-
* <code>/path/to/folder</code>).</p>
|
|
513
|
-
* </note>
|
|
505
|
+
* <p>Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location)
|
|
506
|
+
* on your file system.</p>
|
|
507
|
+
* <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
|
|
508
|
+
* <code>AccessPointArn</code>). You can also include subdirectories using forward slashes (for
|
|
509
|
+
* example, <code>/path/to/folder</code>).</p>
|
|
514
510
|
* @public
|
|
515
511
|
*/
|
|
516
512
|
Subdirectory?: string;
|
|
517
513
|
/**
|
|
518
|
-
* <p>Specifies the ARN for
|
|
514
|
+
* <p>Specifies the ARN for your Amazon EFS file system.</p>
|
|
519
515
|
* @public
|
|
520
516
|
*/
|
|
521
517
|
EfsFilesystemArn: string | undefined;
|
|
522
518
|
/**
|
|
523
|
-
* <p>Specifies the subnet and security groups DataSync uses to
|
|
519
|
+
* <p>Specifies the subnet and security groups DataSync uses to connect to one of
|
|
520
|
+
* your Amazon EFS file system's <a href="https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html">mount targets</a>.</p>
|
|
524
521
|
* @public
|
|
525
522
|
*/
|
|
526
523
|
Ec2Config: Ec2Config | undefined;
|
|
@@ -533,19 +530,20 @@ export interface CreateLocationEfsRequest {
|
|
|
533
530
|
Tags?: TagListEntry[];
|
|
534
531
|
/**
|
|
535
532
|
* <p>Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses
|
|
536
|
-
* to
|
|
533
|
+
* to mount your Amazon EFS file system.</p>
|
|
534
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam">Accessing restricted file systems</a>.</p>
|
|
537
535
|
* @public
|
|
538
536
|
*/
|
|
539
537
|
AccessPointArn?: string;
|
|
540
538
|
/**
|
|
541
|
-
* <p>Specifies an Identity and Access Management (IAM) role that DataSync
|
|
542
|
-
*
|
|
539
|
+
* <p>Specifies an Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.</p>
|
|
540
|
+
* <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 IAM role for file system access</a>.</p>
|
|
543
541
|
* @public
|
|
544
542
|
*/
|
|
545
543
|
FileSystemAccessRoleArn?: string;
|
|
546
544
|
/**
|
|
547
545
|
* <p>Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2
|
|
548
|
-
* encryption when it
|
|
546
|
+
* encryption when it transfers data to or from your Amazon EFS file system.</p>
|
|
549
547
|
* <p>If you specify an access point using <code>AccessPointArn</code> or an IAM
|
|
550
548
|
* role using <code>FileSystemAccessRoleArn</code>, you must set this parameter to
|
|
551
549
|
* <code>TLS1_2</code>.</p>
|
|
@@ -911,8 +909,12 @@ export interface CreateLocationFsxWindowsRequest {
|
|
|
911
909
|
*/
|
|
912
910
|
FsxFilesystemArn: string | undefined;
|
|
913
911
|
/**
|
|
914
|
-
* <p>Specifies the ARNs of the security groups that provide access to your file system's
|
|
915
|
-
*
|
|
912
|
+
* <p>Specifies the ARNs of the Amazon EC2 security groups that provide access to your file system's preferred subnet.</p>
|
|
913
|
+
* <p>The security groups that you specify must be able to communicate with your file system's
|
|
914
|
+
* security groups. For information about configuring security groups for file system access, see
|
|
915
|
+
* the <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html">
|
|
916
|
+
* <i>Amazon FSx for Windows File Server User Guide</i>
|
|
917
|
+
* </a>.</p>
|
|
916
918
|
* <note>
|
|
917
919
|
* <p>If you choose a security group that doesn't allow connections from within itself, do one
|
|
918
920
|
* of the following:</p>
|
|
@@ -1142,8 +1144,7 @@ export interface CreateLocationHdfsRequest {
|
|
|
1142
1144
|
*/
|
|
1143
1145
|
KerberosKrb5Conf?: Uint8Array;
|
|
1144
1146
|
/**
|
|
1145
|
-
* <p>The Amazon Resource Names (ARNs) of the agents that
|
|
1146
|
-
* cluster.</p>
|
|
1147
|
+
* <p>The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.</p>
|
|
1147
1148
|
* @public
|
|
1148
1149
|
*/
|
|
1149
1150
|
AgentArns: string[] | undefined;
|
|
@@ -1159,20 +1160,21 @@ export interface CreateLocationHdfsRequest {
|
|
|
1159
1160
|
*/
|
|
1160
1161
|
export interface CreateLocationHdfsResponse {
|
|
1161
1162
|
/**
|
|
1162
|
-
* <p>The ARN of the source HDFS cluster location that
|
|
1163
|
+
* <p>The ARN of the source HDFS cluster location that you create.</p>
|
|
1163
1164
|
* @public
|
|
1164
1165
|
*/
|
|
1165
1166
|
LocationArn?: string;
|
|
1166
1167
|
}
|
|
1167
1168
|
/**
|
|
1168
|
-
* <p>The DataSync agents that
|
|
1169
|
-
*
|
|
1169
|
+
* <p>The DataSync agents that can connect to your Network File System (NFS)
|
|
1170
|
+
* file server.</p>
|
|
1170
1171
|
* @public
|
|
1171
1172
|
*/
|
|
1172
1173
|
export interface OnPremConfig {
|
|
1173
1174
|
/**
|
|
1174
|
-
* <p>The Amazon Resource Names (ARNs) of the agents
|
|
1175
|
-
*
|
|
1175
|
+
* <p>The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your NFS file server.</p>
|
|
1176
|
+
* <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
|
|
1177
|
+
* agents</a>.</p>
|
|
1176
1178
|
* @public
|
|
1177
1179
|
*/
|
|
1178
1180
|
AgentArns: string[] | undefined;
|
|
@@ -1197,10 +1199,10 @@ export interface CreateLocationNfsRequest {
|
|
|
1197
1199
|
*/
|
|
1198
1200
|
ServerHostname: string | undefined;
|
|
1199
1201
|
/**
|
|
1200
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent that
|
|
1202
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent that can
|
|
1201
1203
|
* connect to your NFS file server.</p>
|
|
1202
|
-
* <p>You can specify more than one agent. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents
|
|
1203
|
-
* agents
|
|
1204
|
+
* <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
|
|
1205
|
+
* agents</a>.</p>
|
|
1204
1206
|
* @public
|
|
1205
1207
|
*/
|
|
1206
1208
|
OnPremConfig: OnPremConfig | undefined;
|
|
@@ -1288,7 +1290,7 @@ export interface CreateLocationObjectStorageRequest {
|
|
|
1288
1290
|
SecretKey?: string;
|
|
1289
1291
|
/**
|
|
1290
1292
|
* <p>Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can
|
|
1291
|
-
*
|
|
1293
|
+
* connect with your object storage system.</p>
|
|
1292
1294
|
* @public
|
|
1293
1295
|
*/
|
|
1294
1296
|
AgentArns: string[] | undefined;
|
|
@@ -1509,8 +1511,8 @@ export interface CreateLocationSmbRequest {
|
|
|
1509
1511
|
*/
|
|
1510
1512
|
Password: string | undefined;
|
|
1511
1513
|
/**
|
|
1512
|
-
* <p>Specifies the DataSync agent (or agents)
|
|
1513
|
-
*
|
|
1514
|
+
* <p>Specifies the DataSync agent (or agents) that can connect to your SMB file
|
|
1515
|
+
* server. You specify an agent by using its Amazon Resource Name (ARN).</p>
|
|
1514
1516
|
* @public
|
|
1515
1517
|
*/
|
|
1516
1518
|
AgentArns: string[] | undefined;
|
|
@@ -1835,15 +1837,19 @@ export type VerifyMode = (typeof VerifyMode)[keyof typeof VerifyMode];
|
|
|
1835
1837
|
*/
|
|
1836
1838
|
export interface Options {
|
|
1837
1839
|
/**
|
|
1838
|
-
* <p>Specifies
|
|
1839
|
-
* transfer.</p>
|
|
1840
|
+
* <p>Specifies if and how DataSync checks the integrity of your data at the end of
|
|
1841
|
+
* your transfer.</p>
|
|
1840
1842
|
* <ul>
|
|
1841
1843
|
* <li>
|
|
1842
1844
|
* <p>
|
|
1843
1845
|
* <code>ONLY_FILES_TRANSFERRED</code> (recommended) - DataSync calculates
|
|
1844
|
-
* the checksum of transferred
|
|
1845
|
-
* transfer, DataSync then compares this checksum to the checksum calculated
|
|
1846
|
-
*
|
|
1846
|
+
* the checksum of transferred data (including metadata) at the source location. At the end
|
|
1847
|
+
* of the transfer, DataSync then compares this checksum to the checksum calculated
|
|
1848
|
+
* on that data at the destination.</p>
|
|
1849
|
+
* <note>
|
|
1850
|
+
* <p>This is the default option for <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Enhanced mode
|
|
1851
|
+
* tasks</a>.</p>
|
|
1852
|
+
* </note>
|
|
1847
1853
|
* <p>We recommend this option when transferring to S3 Glacier Flexible Retrieval
|
|
1848
1854
|
* or S3 Glacier Deep Archive storage classes. For more information, see
|
|
1849
1855
|
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Storage
|
|
@@ -1851,9 +1857,12 @@ export interface Options {
|
|
|
1851
1857
|
* </li>
|
|
1852
1858
|
* <li>
|
|
1853
1859
|
* <p>
|
|
1854
|
-
* <code>POINT_IN_TIME_CONSISTENT</code>
|
|
1855
|
-
*
|
|
1856
|
-
*
|
|
1860
|
+
* <code>POINT_IN_TIME_CONSISTENT</code> - At the end of the transfer, DataSync checks the entire source and destination to verify that both locations are
|
|
1861
|
+
* fully synchronized.</p>
|
|
1862
|
+
* <note>
|
|
1863
|
+
* <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
|
|
1864
|
+
* isn't currently supported with Enhanced mode tasks.</p>
|
|
1865
|
+
* </note>
|
|
1857
1866
|
* <p>If you use a <a href="https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html">manifest</a>, DataSync only scans and
|
|
1858
1867
|
* verifies what's listed in the manifest.</p>
|
|
1859
1868
|
* <p>You can't use this option when transferring to S3 Glacier Flexible Retrieval
|
|
@@ -1863,9 +1872,9 @@ export interface Options {
|
|
|
1863
1872
|
* </li>
|
|
1864
1873
|
* <li>
|
|
1865
1874
|
* <p>
|
|
1866
|
-
* <code>NONE</code> - DataSync
|
|
1867
|
-
*
|
|
1868
|
-
*
|
|
1875
|
+
* <code>NONE</code> - DataSync performs data integrity checks only during
|
|
1876
|
+
* your transfer. Unlike other options, there's no additional verification at the end of your
|
|
1877
|
+
* transfer.</p>
|
|
1869
1878
|
* </li>
|
|
1870
1879
|
* </ul>
|
|
1871
1880
|
* @public
|
|
@@ -1905,7 +1914,7 @@ export interface Options {
|
|
|
1905
1914
|
* <p>
|
|
1906
1915
|
* <code>BEST_EFFORT</code> (default) - DataSync attempts to preserve the
|
|
1907
1916
|
* original <code>Atime</code> attribute on all source files (that is, the version before the
|
|
1908
|
-
* <code>PREPARING</code>
|
|
1917
|
+
* <code>PREPARING</code> steps of the task execution). This option is
|
|
1909
1918
|
* recommended.</p>
|
|
1910
1919
|
* </li>
|
|
1911
1920
|
* <li>
|
|
@@ -1924,8 +1933,8 @@ export interface Options {
|
|
|
1924
1933
|
Atime?: Atime;
|
|
1925
1934
|
/**
|
|
1926
1935
|
* <p>Specifies whether to preserve metadata indicating the last time that a file was written
|
|
1927
|
-
* to before the <code>PREPARING</code>
|
|
1928
|
-
*
|
|
1936
|
+
* to before the <code>PREPARING</code> step of your task execution. This option is required when
|
|
1937
|
+
* you need to run the a task more than once.</p>
|
|
1929
1938
|
* <ul>
|
|
1930
1939
|
* <li>
|
|
1931
1940
|
* <p>
|
|
@@ -1976,7 +1985,7 @@ export interface Options {
|
|
|
1976
1985
|
* <code>NONE</code> - Ignores UID and GID.</p>
|
|
1977
1986
|
* </li>
|
|
1978
1987
|
* </ul>
|
|
1979
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/
|
|
1988
|
+
* <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 metadata</a>.</p>
|
|
1980
1989
|
* @public
|
|
1981
1990
|
*/
|
|
1982
1991
|
Gid?: Gid;
|
|
@@ -2031,7 +2040,7 @@ export interface Options {
|
|
|
2031
2040
|
/**
|
|
2032
2041
|
* <p>Specifies which users or groups can access a file for a specific purpose such as reading,
|
|
2033
2042
|
* writing, or execution of the file.</p>
|
|
2034
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/
|
|
2043
|
+
* <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 metadata</a>.</p>
|
|
2035
2044
|
* <ul>
|
|
2036
2045
|
* <li>
|
|
2037
2046
|
* <p>
|
|
@@ -2053,6 +2062,10 @@ export interface Options {
|
|
|
2053
2062
|
* <p>Limits the bandwidth used by a DataSync task. For example, if you want
|
|
2054
2063
|
* DataSync to use a maximum of 1 MB, set this value to <code>1048576</code>
|
|
2055
2064
|
* (<code>=1024*1024</code>).</p>
|
|
2065
|
+
* <note>
|
|
2066
|
+
* <p>Not applicable to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Enhanced mode
|
|
2067
|
+
* tasks</a>.</p>
|
|
2068
|
+
* </note>
|
|
2056
2069
|
* @public
|
|
2057
2070
|
*/
|
|
2058
2071
|
BytesPerSecond?: number;
|
|
@@ -2085,14 +2098,16 @@ export interface Options {
|
|
|
2085
2098
|
*/
|
|
2086
2099
|
LogLevel?: LogLevel;
|
|
2087
2100
|
/**
|
|
2088
|
-
* <p>
|
|
2089
|
-
* between
|
|
2090
|
-
*
|
|
2101
|
+
* <p>Specifies whether DataSync transfers only the data (including metadata) that
|
|
2102
|
+
* differs between locations following an initial copy or transfers all data every time you run
|
|
2103
|
+
* the task. If you're planning on recurring transfers, you might only want to transfer what's
|
|
2104
|
+
* changed since your previous task execution.</p>
|
|
2091
2105
|
* <ul>
|
|
2092
2106
|
* <li>
|
|
2093
2107
|
* <p>
|
|
2094
|
-
* <code>CHANGED</code> (default) -
|
|
2095
|
-
*
|
|
2108
|
+
* <code>CHANGED</code> (default) - After your initial full transfer, DataSync
|
|
2109
|
+
* copies only the data and metadata that differs between the source and destination
|
|
2110
|
+
* location.</p>
|
|
2096
2111
|
* </li>
|
|
2097
2112
|
* <li>
|
|
2098
2113
|
* <p>
|
|
@@ -2107,7 +2122,7 @@ export interface Options {
|
|
|
2107
2122
|
* <p>Specifies which components of the SMB security descriptor are copied from source to
|
|
2108
2123
|
* destination objects. </p>
|
|
2109
2124
|
* <p>This value is only used for transfers between SMB and Amazon FSx for Windows File Server
|
|
2110
|
-
* locations or between two FSx for Windows File Server locations. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/
|
|
2125
|
+
* 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 DataSync handles file and object metadata</a>.</p>
|
|
2111
2126
|
* <ul>
|
|
2112
2127
|
* <li>
|
|
2113
2128
|
* <p>
|
|
@@ -2183,10 +2198,20 @@ export type ScheduleStatus = (typeof ScheduleStatus)[keyof typeof ScheduleStatus
|
|
|
2183
2198
|
*/
|
|
2184
2199
|
export interface TaskSchedule {
|
|
2185
2200
|
/**
|
|
2186
|
-
* <p>Specifies your task schedule by using a cron
|
|
2187
|
-
*
|
|
2188
|
-
*
|
|
2189
|
-
*
|
|
2201
|
+
* <p>Specifies your task schedule by using a cron or rate expression.</p>
|
|
2202
|
+
* <p>Use cron expressions for task schedules that run on a specific time and day. For example,
|
|
2203
|
+
* the following cron expression creates a task schedule that runs at 8 AM on the first Wednesday
|
|
2204
|
+
* of every month:</p>
|
|
2205
|
+
* <p>
|
|
2206
|
+
* <code>cron(0 8 * * 3#1)</code>
|
|
2207
|
+
* </p>
|
|
2208
|
+
* <p>Use rate expressions for task schedules that run on a regular interval. For example, the
|
|
2209
|
+
* following rate expression creates a task schedule that runs every 12 hours:</p>
|
|
2210
|
+
* <p>
|
|
2211
|
+
* <code>rate(12 hours)</code>
|
|
2212
|
+
* </p>
|
|
2213
|
+
* <p>For information about cron and rate expression syntax, see the <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html">
|
|
2214
|
+
* <i>Amazon EventBridge User Guide</i>
|
|
2190
2215
|
* </a>.</p>
|
|
2191
2216
|
* @public
|
|
2192
2217
|
*/
|
|
@@ -2202,6 +2227,18 @@ export interface TaskSchedule {
|
|
|
2202
2227
|
*/
|
|
2203
2228
|
Status?: ScheduleStatus;
|
|
2204
2229
|
}
|
|
2230
|
+
/**
|
|
2231
|
+
* @public
|
|
2232
|
+
* @enum
|
|
2233
|
+
*/
|
|
2234
|
+
export declare const TaskMode: {
|
|
2235
|
+
readonly BASIC: "BASIC";
|
|
2236
|
+
readonly ENHANCED: "ENHANCED";
|
|
2237
|
+
};
|
|
2238
|
+
/**
|
|
2239
|
+
* @public
|
|
2240
|
+
*/
|
|
2241
|
+
export type TaskMode = (typeof TaskMode)[keyof typeof TaskMode];
|
|
2205
2242
|
/**
|
|
2206
2243
|
* <p>Specifies the Amazon S3 bucket where DataSync uploads your <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">task report</a>.</p>
|
|
2207
2244
|
* @public
|
|
@@ -2391,6 +2428,8 @@ export interface CreateTaskRequest {
|
|
|
2391
2428
|
/**
|
|
2392
2429
|
* <p>Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for
|
|
2393
2430
|
* monitoring your task.</p>
|
|
2431
|
+
* <p>For Enhanced mode tasks, you don't need to specify anything. DataSync
|
|
2432
|
+
* automatically sends logs to a CloudWatch log group named <code>/aws/datasync</code>.</p>
|
|
2394
2433
|
* @public
|
|
2395
2434
|
*/
|
|
2396
2435
|
CloudWatchLogGroupArn?: string;
|
|
@@ -2426,8 +2465,10 @@ export interface CreateTaskRequest {
|
|
|
2426
2465
|
*/
|
|
2427
2466
|
Tags?: TagListEntry[];
|
|
2428
2467
|
/**
|
|
2429
|
-
* <p>Specifies include filters define the files, objects, and folders in your source
|
|
2430
|
-
* that you want DataSync to transfer. For more information and examples, see
|
|
2468
|
+
* <p>Specifies include filters that define the files, objects, and folders in your source
|
|
2469
|
+
* location that you want DataSync to transfer. For more information and examples, see
|
|
2470
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Specifying what
|
|
2471
|
+
* DataSync transfers by using filters</a>.</p>
|
|
2431
2472
|
* @public
|
|
2432
2473
|
*/
|
|
2433
2474
|
Includes?: FilterRule[];
|
|
@@ -2445,6 +2486,29 @@ export interface CreateTaskRequest {
|
|
|
2445
2486
|
* @public
|
|
2446
2487
|
*/
|
|
2447
2488
|
TaskReportConfig?: TaskReportConfig;
|
|
2489
|
+
/**
|
|
2490
|
+
* <p>Specifies one of the following task modes for your data transfer:</p>
|
|
2491
|
+
* <ul>
|
|
2492
|
+
* <li>
|
|
2493
|
+
* <p>
|
|
2494
|
+
* <code>ENHANCED</code> - Transfer virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. Currently available for transfers between Amazon S3 locations.</p>
|
|
2495
|
+
* <note>
|
|
2496
|
+
* <p>To create an Enhanced mode task, the IAM role that you use to call
|
|
2497
|
+
* the <code>CreateTask</code> operation must have the
|
|
2498
|
+
* <code>iam:CreateServiceLinkedRole</code> permission.</p>
|
|
2499
|
+
* </note>
|
|
2500
|
+
* </li>
|
|
2501
|
+
* <li>
|
|
2502
|
+
* <p>
|
|
2503
|
+
* <code>BASIC</code> (default) - Transfer files or objects between Amazon Web Services
|
|
2504
|
+
* storage and on-premises, edge, or other cloud storage. DataSync
|
|
2505
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-limits.html">quotas</a> apply.</p>
|
|
2506
|
+
* </li>
|
|
2507
|
+
* </ul>
|
|
2508
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences">Understanding task mode differences</a>.</p>
|
|
2509
|
+
* @public
|
|
2510
|
+
*/
|
|
2511
|
+
TaskMode?: TaskMode;
|
|
2448
2512
|
}
|
|
2449
2513
|
/**
|
|
2450
2514
|
* <p>CreateTaskResponse</p>
|
|
@@ -2543,7 +2607,7 @@ export interface PrivateLinkConfig {
|
|
|
2543
2607
|
*/
|
|
2544
2608
|
VpcEndpointId?: string;
|
|
2545
2609
|
/**
|
|
2546
|
-
* <p>Specifies the VPC endpoint provided by <a href="https://docs.aws.amazon.com/vpc/latest/
|
|
2610
|
+
* <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
|
|
2547
2611
|
* your agent connects to.</p>
|
|
2548
2612
|
* @public
|
|
2549
2613
|
*/
|
|
@@ -2763,7 +2827,8 @@ export interface DescribeLocationEfsResponse {
|
|
|
2763
2827
|
*/
|
|
2764
2828
|
LocationUri?: string;
|
|
2765
2829
|
/**
|
|
2766
|
-
* <p>The subnet and security groups that DataSync uses to
|
|
2830
|
+
* <p>The subnet and security groups that DataSync uses to connect to one of your
|
|
2831
|
+
* Amazon EFS file system's <a href="https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html">mount targets</a>.</p>
|
|
2767
2832
|
* @public
|
|
2768
2833
|
*/
|
|
2769
2834
|
Ec2Config?: Ec2Config;
|
|
@@ -2775,18 +2840,20 @@ export interface DescribeLocationEfsResponse {
|
|
|
2775
2840
|
/**
|
|
2776
2841
|
* <p>The ARN of the access point that DataSync uses to access the Amazon EFS
|
|
2777
2842
|
* file system.</p>
|
|
2843
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam">Accessing restricted file systems</a>.</p>
|
|
2778
2844
|
* @public
|
|
2779
2845
|
*/
|
|
2780
2846
|
AccessPointArn?: string;
|
|
2781
2847
|
/**
|
|
2782
|
-
* <p>The Identity and Access Management (IAM) role that DataSync
|
|
2783
|
-
*
|
|
2848
|
+
* <p>The Identity and Access Management (IAM) role that allows DataSync to
|
|
2849
|
+
* access your Amazon EFS file system.</p>
|
|
2850
|
+
* <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 IAM role for file system access</a>.</p>
|
|
2784
2851
|
* @public
|
|
2785
2852
|
*/
|
|
2786
2853
|
FileSystemAccessRoleArn?: string;
|
|
2787
2854
|
/**
|
|
2788
|
-
* <p>
|
|
2789
|
-
*
|
|
2855
|
+
* <p>Indicates whether DataSync uses Transport Layer Security (TLS) encryption when
|
|
2856
|
+
* transferring data to or from the Amazon EFS file system.</p>
|
|
2790
2857
|
* @public
|
|
2791
2858
|
*/
|
|
2792
2859
|
InTransitEncryption?: EfsInTransitEncryption;
|
|
@@ -2953,8 +3020,11 @@ export interface DescribeLocationFsxWindowsResponse {
|
|
|
2953
3020
|
*/
|
|
2954
3021
|
LocationUri?: string;
|
|
2955
3022
|
/**
|
|
2956
|
-
* <p>The ARNs of the security groups that
|
|
2957
|
-
* system.</p>
|
|
3023
|
+
* <p>The ARNs of the Amazon EC2 security groups that provide access to your file
|
|
3024
|
+
* system's preferred subnet.</p>
|
|
3025
|
+
* <p>For information about configuring security groups for file system access, see the <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html">
|
|
3026
|
+
* <i>Amazon FSx for Windows File Server User Guide</i>
|
|
3027
|
+
* </a>.</p>
|
|
2958
3028
|
* @public
|
|
2959
3029
|
*/
|
|
2960
3030
|
SecurityGroupArns?: string[];
|
|
@@ -3083,8 +3153,8 @@ export interface DescribeLocationNfsResponse {
|
|
|
3083
3153
|
*/
|
|
3084
3154
|
LocationUri?: string;
|
|
3085
3155
|
/**
|
|
3086
|
-
* <p>The DataSync agents that
|
|
3087
|
-
*
|
|
3156
|
+
* <p>The DataSync agents that can connect to your Network File System (NFS)
|
|
3157
|
+
* file server.</p>
|
|
3088
3158
|
* @public
|
|
3089
3159
|
*/
|
|
3090
3160
|
OnPremConfig?: OnPremConfig;
|
|
@@ -4129,8 +4199,8 @@ export interface DescribeTaskResponse {
|
|
|
4129
4199
|
/**
|
|
4130
4200
|
* <p>The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your
|
|
4131
4201
|
* task.</p>
|
|
4132
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/
|
|
4133
|
-
*
|
|
4202
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html">Monitoring data transfers with
|
|
4203
|
+
* CloudWatch Logs</a>.</p>
|
|
4134
4204
|
* @public
|
|
4135
4205
|
*/
|
|
4136
4206
|
CloudWatchLogGroupArn?: string;
|
|
@@ -4204,6 +4274,11 @@ export interface DescribeTaskResponse {
|
|
|
4204
4274
|
* @public
|
|
4205
4275
|
*/
|
|
4206
4276
|
ScheduleDetails?: TaskScheduleDetails;
|
|
4277
|
+
/**
|
|
4278
|
+
* <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 transfer</a>.</p>
|
|
4279
|
+
* @public
|
|
4280
|
+
*/
|
|
4281
|
+
TaskMode?: TaskMode;
|
|
4207
4282
|
}
|
|
4208
4283
|
/**
|
|
4209
4284
|
* <p>DescribeTaskExecutionRequest</p>
|
|
@@ -4217,6 +4292,75 @@ export interface DescribeTaskExecutionRequest {
|
|
|
4217
4292
|
*/
|
|
4218
4293
|
TaskExecutionArn: string | undefined;
|
|
4219
4294
|
}
|
|
4295
|
+
/**
|
|
4296
|
+
* <p>The number of objects that DataSync fails to prepare, transfer, verify, and
|
|
4297
|
+
* delete during your task execution.</p>
|
|
4298
|
+
* <note>
|
|
4299
|
+
* <p>Applies only to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Enhanced mode
|
|
4300
|
+
* tasks</a>.</p>
|
|
4301
|
+
* </note>
|
|
4302
|
+
* @public
|
|
4303
|
+
*/
|
|
4304
|
+
export interface TaskExecutionFilesFailedDetail {
|
|
4305
|
+
/**
|
|
4306
|
+
* <p>The number of objects that DataSync fails to prepare during your task
|
|
4307
|
+
* execution.</p>
|
|
4308
|
+
* @public
|
|
4309
|
+
*/
|
|
4310
|
+
Prepare?: number;
|
|
4311
|
+
/**
|
|
4312
|
+
* <p>The number of objects that DataSync fails to transfer during your task
|
|
4313
|
+
* execution.</p>
|
|
4314
|
+
* @public
|
|
4315
|
+
*/
|
|
4316
|
+
Transfer?: number;
|
|
4317
|
+
/**
|
|
4318
|
+
* <p>The number of objects that DataSync fails to verify during your task
|
|
4319
|
+
* execution.</p>
|
|
4320
|
+
* @public
|
|
4321
|
+
*/
|
|
4322
|
+
Verify?: number;
|
|
4323
|
+
/**
|
|
4324
|
+
* <p>The number of objects that DataSync fails to delete during your task
|
|
4325
|
+
* execution.</p>
|
|
4326
|
+
* @public
|
|
4327
|
+
*/
|
|
4328
|
+
Delete?: number;
|
|
4329
|
+
}
|
|
4330
|
+
/**
|
|
4331
|
+
* <p>The number of objects that DataSync finds at your locations.</p>
|
|
4332
|
+
* <note>
|
|
4333
|
+
* <p>Applies only to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Enhanced mode
|
|
4334
|
+
* tasks</a>.</p>
|
|
4335
|
+
* </note>
|
|
4336
|
+
* @public
|
|
4337
|
+
*/
|
|
4338
|
+
export interface TaskExecutionFilesListedDetail {
|
|
4339
|
+
/**
|
|
4340
|
+
* <p>The number of objects that DataSync finds at your source location.</p>
|
|
4341
|
+
* <ul>
|
|
4342
|
+
* <li>
|
|
4343
|
+
* <p>With a <a href="https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html">manifest</a>, DataSync
|
|
4344
|
+
* lists only what's in your manifest (and not everything at your source location).</p>
|
|
4345
|
+
* </li>
|
|
4346
|
+
* <li>
|
|
4347
|
+
* <p>With an include <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">filter</a>, DataSync lists only what
|
|
4348
|
+
* matches the filter at your source location.</p>
|
|
4349
|
+
* </li>
|
|
4350
|
+
* <li>
|
|
4351
|
+
* <p>With an exclude filter, DataSync lists everything at your source location before applying
|
|
4352
|
+
* the filter.</p>
|
|
4353
|
+
* </li>
|
|
4354
|
+
* </ul>
|
|
4355
|
+
* @public
|
|
4356
|
+
*/
|
|
4357
|
+
AtSource?: number;
|
|
4358
|
+
/**
|
|
4359
|
+
* <p>The number of objects that DataSync finds at your destination location. This metric 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 source.</p>
|
|
4360
|
+
* @public
|
|
4361
|
+
*/
|
|
4362
|
+
AtDestinationForDelete?: number;
|
|
4363
|
+
}
|
|
4220
4364
|
/**
|
|
4221
4365
|
* @public
|
|
4222
4366
|
* @enum
|
|
@@ -4255,60 +4399,75 @@ export interface ReportResult {
|
|
|
4255
4399
|
ErrorDetail?: string;
|
|
4256
4400
|
}
|
|
4257
4401
|
/**
|
|
4258
|
-
* <p>
|
|
4259
|
-
*
|
|
4260
|
-
* the errors encountered.</p>
|
|
4402
|
+
* <p>Provides detailed information about the result of your DataSync task
|
|
4403
|
+
* execution.</p>
|
|
4261
4404
|
* @public
|
|
4262
4405
|
*/
|
|
4263
4406
|
export interface TaskExecutionResultDetail {
|
|
4264
4407
|
/**
|
|
4265
|
-
* <p>The
|
|
4266
|
-
*
|
|
4408
|
+
* <p>The time in milliseconds that your task execution was in the <code>PREPARING</code>
|
|
4409
|
+
* step. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses">Task
|
|
4410
|
+
* execution statuses</a>.</p>
|
|
4411
|
+
* <p>For Enhanced mode tasks, the value is always <code>0</code>. For more information, see
|
|
4412
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-datasync-prepares">How DataSync prepares your data transfer</a>.</p>
|
|
4267
4413
|
* @public
|
|
4268
4414
|
*/
|
|
4269
4415
|
PrepareDuration?: number;
|
|
4270
4416
|
/**
|
|
4271
|
-
* <p>The status of the PREPARING
|
|
4417
|
+
* <p>The status of the <code>PREPARING</code> step for your task execution. For more
|
|
4418
|
+
* information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses">Task
|
|
4419
|
+
* execution statuses</a>.</p>
|
|
4272
4420
|
* @public
|
|
4273
4421
|
*/
|
|
4274
4422
|
PrepareStatus?: PhaseStatus;
|
|
4275
4423
|
/**
|
|
4276
|
-
* <p>The
|
|
4277
|
-
* the source to the destination location.</p>
|
|
4424
|
+
* <p>The time in milliseconds that your task execution ran.</p>
|
|
4278
4425
|
* @public
|
|
4279
4426
|
*/
|
|
4280
4427
|
TotalDuration?: number;
|
|
4281
4428
|
/**
|
|
4282
|
-
* <p>The
|
|
4283
|
-
*
|
|
4429
|
+
* <p>The time in milliseconds that your task execution was in the <code>TRANSFERRING</code>
|
|
4430
|
+
* step. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses">Task
|
|
4431
|
+
* execution statuses</a>.</p>
|
|
4432
|
+
* <p>For Enhanced mode tasks, the value is always <code>0</code>. For more information, see
|
|
4433
|
+
* <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>
|
|
4284
4434
|
* @public
|
|
4285
4435
|
*/
|
|
4286
4436
|
TransferDuration?: number;
|
|
4287
4437
|
/**
|
|
4288
|
-
* <p>The status of the TRANSFERRING
|
|
4438
|
+
* <p>The status of the <code>TRANSFERRING</code> step for your task execution. For more
|
|
4439
|
+
* information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses">Task
|
|
4440
|
+
* execution statuses</a>.</p>
|
|
4289
4441
|
* @public
|
|
4290
4442
|
*/
|
|
4291
4443
|
TransferStatus?: PhaseStatus;
|
|
4292
4444
|
/**
|
|
4293
|
-
* <p>The
|
|
4294
|
-
*
|
|
4445
|
+
* <p>The time in milliseconds that your task execution was in the <code>VERIFYING</code>
|
|
4446
|
+
* step. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses">Task
|
|
4447
|
+
* execution statuses</a>.</p>
|
|
4448
|
+
* <p>For Enhanced mode tasks, the value is always <code>0</code>. For more information, see
|
|
4449
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-verifying-works">How DataSync verifies your data's integrity</a>.</p>
|
|
4295
4450
|
* @public
|
|
4296
4451
|
*/
|
|
4297
4452
|
VerifyDuration?: number;
|
|
4298
4453
|
/**
|
|
4299
|
-
* <p>The status of the VERIFYING
|
|
4454
|
+
* <p>The status of the <code>VERIFYING</code> step for your task execution. For more
|
|
4455
|
+
* information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses">Task
|
|
4456
|
+
* execution statuses</a>.</p>
|
|
4300
4457
|
* @public
|
|
4301
4458
|
*/
|
|
4302
4459
|
VerifyStatus?: PhaseStatus;
|
|
4303
4460
|
/**
|
|
4304
|
-
* <p>
|
|
4305
|
-
*
|
|
4461
|
+
* <p>An error that DataSync encountered during your task execution. You can use
|
|
4462
|
+
* this information to help <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html">troubleshoot
|
|
4463
|
+
* issues</a>.</p>
|
|
4306
4464
|
* @public
|
|
4307
4465
|
*/
|
|
4308
4466
|
ErrorCode?: string;
|
|
4309
4467
|
/**
|
|
4310
|
-
* <p>
|
|
4311
|
-
* can use this information to help
|
|
4468
|
+
* <p>The detailed description of an error that DataSync encountered during your
|
|
4469
|
+
* task execution. You can use this information to help <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html">troubleshoot
|
|
4470
|
+
* issues</a>. </p>
|
|
4312
4471
|
* @public
|
|
4313
4472
|
*/
|
|
4314
4473
|
ErrorDetail?: string;
|
|
@@ -4385,46 +4544,79 @@ export interface DescribeTaskExecutionResponse {
|
|
|
4385
4544
|
*/
|
|
4386
4545
|
StartTime?: Date;
|
|
4387
4546
|
/**
|
|
4388
|
-
* <p>The
|
|
4547
|
+
* <p>The number of files, objects, and directories that DataSync expects to
|
|
4389
4548
|
* transfer over the network. This value is calculated during the task execution's
|
|
4390
|
-
* <code>PREPARING</code>
|
|
4391
|
-
*
|
|
4392
|
-
*
|
|
4549
|
+
* <code>PREPARING</code>
|
|
4550
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses">step</a> before the <code>TRANSFERRING</code> step.</p>
|
|
4551
|
+
* <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
|
|
4552
|
+
* mode</a> configuration:</p>
|
|
4553
|
+
* <ul>
|
|
4554
|
+
* <li>
|
|
4555
|
+
* <p>If <code>TranserMode</code> is set to <code>CHANGED</code> - The calculation is based
|
|
4556
|
+
* on comparing the content of the source and destination locations and determining the
|
|
4557
|
+
* difference that needs to be transferred. The difference can include:</p>
|
|
4558
|
+
* <ul>
|
|
4559
|
+
* <li>
|
|
4560
|
+
* <p>Anything that's added or modified at the source location.</p>
|
|
4561
|
+
* </li>
|
|
4562
|
+
* <li>
|
|
4563
|
+
* <p>Anything that's in both locations and modified at the destination after an initial
|
|
4564
|
+
* transfer (unless <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-OverwriteMode">OverwriteMode</a> is set to <code>NEVER</code>).</p>
|
|
4565
|
+
* </li>
|
|
4566
|
+
* <li>
|
|
4567
|
+
* <p>
|
|
4568
|
+
* <b>(Basic task mode only)</b> The number of items that
|
|
4569
|
+
* DataSync expects to delete (if <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-PreserveDeletedFiles">PreserveDeletedFiles</a> is set to
|
|
4570
|
+
* <code>REMOVE</code>).</p>
|
|
4571
|
+
* </li>
|
|
4572
|
+
* </ul>
|
|
4573
|
+
* </li>
|
|
4574
|
+
* <li>
|
|
4575
|
+
* <p>If <code>TranserMode</code> is set to <code>ALL</code> - The calculation is based only
|
|
4576
|
+
* on the items that DataSync finds at the source location.</p>
|
|
4577
|
+
* </li>
|
|
4578
|
+
* </ul>
|
|
4393
4579
|
* @public
|
|
4394
4580
|
*/
|
|
4395
4581
|
EstimatedFilesToTransfer?: number;
|
|
4396
4582
|
/**
|
|
4397
|
-
* <p>The
|
|
4583
|
+
* <p>The number of logical bytes that DataSync expects to write to the destination
|
|
4584
|
+
* location.</p>
|
|
4398
4585
|
* @public
|
|
4399
4586
|
*/
|
|
4400
4587
|
EstimatedBytesToTransfer?: number;
|
|
4401
4588
|
/**
|
|
4402
|
-
* <p>The
|
|
4403
|
-
*
|
|
4404
|
-
* <code>TRANSFERRING</code>
|
|
4405
|
-
*
|
|
4589
|
+
* <p>The number of files, objects, and directories that DataSync actually
|
|
4590
|
+
* transfers over the network. This value is updated periodically during the task execution's
|
|
4591
|
+
* <code>TRANSFERRING</code>
|
|
4592
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses">step</a> when something is read from the source and sent over the network.</p>
|
|
4406
4593
|
* <p>If DataSync fails to transfer something, this value can be less than
|
|
4407
4594
|
* <code>EstimatedFilesToTransfer</code>. In some cases, this value can also be greater than
|
|
4408
4595
|
* <code>EstimatedFilesToTransfer</code>. This element is implementation-specific for some
|
|
4409
|
-
* location types, so don't use it as an exact indication of what
|
|
4596
|
+
* location types, so don't use it as an exact indication of what's transferring or to monitor
|
|
4597
|
+
* your task execution.</p>
|
|
4410
4598
|
* @public
|
|
4411
4599
|
*/
|
|
4412
4600
|
FilesTransferred?: number;
|
|
4413
4601
|
/**
|
|
4414
|
-
* <p>The number of logical bytes
|
|
4602
|
+
* <p>The number of logical bytes that DataSync actually writes to the destination
|
|
4603
|
+
* location.</p>
|
|
4415
4604
|
* @public
|
|
4416
4605
|
*/
|
|
4417
4606
|
BytesWritten?: number;
|
|
4418
4607
|
/**
|
|
4419
|
-
* <p>The
|
|
4420
|
-
*
|
|
4608
|
+
* <p>The number of bytes that DataSync sends to the network before compression (if
|
|
4609
|
+
* compression is possible). For the number of bytes transferred over the network, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-BytesCompressed">BytesCompressed</a>. </p>
|
|
4421
4610
|
* @public
|
|
4422
4611
|
*/
|
|
4423
4612
|
BytesTransferred?: number;
|
|
4424
4613
|
/**
|
|
4425
|
-
* <p>The
|
|
4426
|
-
*
|
|
4427
|
-
*
|
|
4614
|
+
* <p>The number of physical bytes that DataSync transfers over the network after
|
|
4615
|
+
* compression (if compression is possible). This number is typically less than <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-BytesTransferred">BytesTransferred</a> unless the data isn't compressible.</p>
|
|
4616
|
+
* <note>
|
|
4617
|
+
* <p>Not currently supported with <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Enhanced mode
|
|
4618
|
+
* tasks</a>.</p>
|
|
4619
|
+
* </note>
|
|
4428
4620
|
* @public
|
|
4429
4621
|
*/
|
|
4430
4622
|
BytesCompressed?: number;
|
|
@@ -4440,21 +4632,21 @@ export interface DescribeTaskExecutionResponse {
|
|
|
4440
4632
|
*/
|
|
4441
4633
|
TaskReportConfig?: TaskReportConfig;
|
|
4442
4634
|
/**
|
|
4443
|
-
* <p>The number of files, objects, and directories that DataSync
|
|
4444
|
-
* destination location. If you don't <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html">configure your task</a> to
|
|
4635
|
+
* <p>The number of files, objects, and directories that DataSync actually deletes in
|
|
4636
|
+
* your destination location. If you don't <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html">configure your task</a> to
|
|
4445
4637
|
* delete data in the destination that isn't in the source, the value is always
|
|
4446
4638
|
* <code>0</code>.</p>
|
|
4447
4639
|
* @public
|
|
4448
4640
|
*/
|
|
4449
4641
|
FilesDeleted?: number;
|
|
4450
4642
|
/**
|
|
4451
|
-
* <p>The number of files, objects, and directories that DataSync
|
|
4643
|
+
* <p>The number of files, objects, and directories that DataSync skips during your
|
|
4452
4644
|
* transfer.</p>
|
|
4453
4645
|
* @public
|
|
4454
4646
|
*/
|
|
4455
4647
|
FilesSkipped?: number;
|
|
4456
4648
|
/**
|
|
4457
|
-
* <p>The number of files, objects, and directories that DataSync
|
|
4649
|
+
* <p>The number of files, objects, and directories that DataSync verifies during your
|
|
4458
4650
|
* transfer.</p>
|
|
4459
4651
|
* <note>
|
|
4460
4652
|
* <p>When you configure your task to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-data-verification-options.html">verify only the
|
|
@@ -4471,13 +4663,52 @@ export interface DescribeTaskExecutionResponse {
|
|
|
4471
4663
|
*/
|
|
4472
4664
|
ReportResult?: ReportResult;
|
|
4473
4665
|
/**
|
|
4474
|
-
* <p>The
|
|
4475
|
-
*
|
|
4666
|
+
* <p>The number of files, objects, and directories that DataSync expects to delete in
|
|
4667
|
+
* your destination location. If you don't <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html">configure your task</a> to
|
|
4476
4668
|
* delete data in the destination that isn't in the source, the value is always
|
|
4477
4669
|
* <code>0</code>.</p>
|
|
4478
4670
|
* @public
|
|
4479
4671
|
*/
|
|
4480
4672
|
EstimatedFilesToDelete?: number;
|
|
4673
|
+
/**
|
|
4674
|
+
* <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 transfer</a>.</p>
|
|
4675
|
+
* @public
|
|
4676
|
+
*/
|
|
4677
|
+
TaskMode?: TaskMode;
|
|
4678
|
+
/**
|
|
4679
|
+
* <p>The number of objects that DataSync will attempt to transfer after comparing
|
|
4680
|
+
* your source and destination locations.</p>
|
|
4681
|
+
* <note>
|
|
4682
|
+
* <p>Applies only to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Enhanced mode
|
|
4683
|
+
* tasks</a>.</p>
|
|
4684
|
+
* </note>
|
|
4685
|
+
* <p>This metric isn't applicable if you configure your task to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-transfer-mode">transfer all data</a>. In that scenario, DataSync copies everything from the source to the destination without comparing differences between the locations.</p>
|
|
4686
|
+
* @public
|
|
4687
|
+
*/
|
|
4688
|
+
FilesPrepared?: number;
|
|
4689
|
+
/**
|
|
4690
|
+
* <p>The number of
|
|
4691
|
+
* objects
|
|
4692
|
+
* that DataSync
|
|
4693
|
+
* finds
|
|
4694
|
+
* at your locations.</p>
|
|
4695
|
+
* <note>
|
|
4696
|
+
* <p>Applies only to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Enhanced mode
|
|
4697
|
+
* tasks</a>.</p>
|
|
4698
|
+
* </note>
|
|
4699
|
+
* @public
|
|
4700
|
+
*/
|
|
4701
|
+
FilesListed?: TaskExecutionFilesListedDetail;
|
|
4702
|
+
/**
|
|
4703
|
+
* <p>The number of objects that DataSync fails to prepare, transfer, verify, and
|
|
4704
|
+
* delete during your task execution.</p>
|
|
4705
|
+
* <note>
|
|
4706
|
+
* <p>Applies only to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Enhanced mode
|
|
4707
|
+
* tasks</a>.</p>
|
|
4708
|
+
* </note>
|
|
4709
|
+
* @public
|
|
4710
|
+
*/
|
|
4711
|
+
FilesFailed?: TaskExecutionFilesFailedDetail;
|
|
4481
4712
|
}
|
|
4482
4713
|
/**
|
|
4483
4714
|
* <p>The details about a specific DataSync discovery job.</p>
|
|
@@ -4867,6 +5098,11 @@ export interface TaskExecutionListEntry {
|
|
|
4867
5098
|
* @public
|
|
4868
5099
|
*/
|
|
4869
5100
|
Status?: TaskExecutionStatus;
|
|
5101
|
+
/**
|
|
5102
|
+
* <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 transfer</a>.</p>
|
|
5103
|
+
* @public
|
|
5104
|
+
*/
|
|
5105
|
+
TaskMode?: TaskMode;
|
|
4870
5106
|
}
|
|
4871
5107
|
/**
|
|
4872
5108
|
* <p>ListTaskExecutionsResponse</p>
|
|
@@ -4974,6 +5210,11 @@ export interface TaskListEntry {
|
|
|
4974
5210
|
* @public
|
|
4975
5211
|
*/
|
|
4976
5212
|
Name?: string;
|
|
5213
|
+
/**
|
|
5214
|
+
* <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 transfer</a>.</p>
|
|
5215
|
+
* @public
|
|
5216
|
+
*/
|
|
5217
|
+
TaskMode?: TaskMode;
|
|
4977
5218
|
}
|
|
4978
5219
|
/**
|
|
4979
5220
|
* <p>ListTasksResponse</p>
|
|
@@ -5350,7 +5591,7 @@ export interface UpdateLocationHdfsRequest {
|
|
|
5350
5591
|
*/
|
|
5351
5592
|
KerberosKrb5Conf?: Uint8Array;
|
|
5352
5593
|
/**
|
|
5353
|
-
* <p>The ARNs of the agents that
|
|
5594
|
+
* <p>The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.</p>
|
|
5354
5595
|
* @public
|
|
5355
5596
|
*/
|
|
5356
5597
|
AgentArns?: string[];
|
|
@@ -5379,8 +5620,8 @@ export interface UpdateLocationNfsRequest {
|
|
|
5379
5620
|
*/
|
|
5380
5621
|
Subdirectory?: string;
|
|
5381
5622
|
/**
|
|
5382
|
-
* <p>The DataSync agents that
|
|
5383
|
-
*
|
|
5623
|
+
* <p>The DataSync agents that can connect to your Network File System (NFS)
|
|
5624
|
+
* file server.</p>
|
|
5384
5625
|
* @public
|
|
5385
5626
|
*/
|
|
5386
5627
|
OnPremConfig?: OnPremConfig;
|
|
@@ -5436,7 +5677,7 @@ export interface UpdateLocationObjectStorageRequest {
|
|
|
5436
5677
|
SecretKey?: string;
|
|
5437
5678
|
/**
|
|
5438
5679
|
* <p>Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can
|
|
5439
|
-
*
|
|
5680
|
+
* connect with your object storage system.</p>
|
|
5440
5681
|
* @public
|
|
5441
5682
|
*/
|
|
5442
5683
|
AgentArns?: string[];
|
|
@@ -5517,7 +5758,8 @@ export interface UpdateLocationSmbRequest {
|
|
|
5517
5758
|
*/
|
|
5518
5759
|
Password?: string;
|
|
5519
5760
|
/**
|
|
5520
|
-
* <p>Specifies the DataSync agent (or agents)
|
|
5761
|
+
* <p>Specifies the DataSync agent (or agents) that can connect to your SMB file
|
|
5762
|
+
* server. You specify an agent by using its Amazon Resource Name (ARN).</p>
|
|
5521
5763
|
* @public
|
|
5522
5764
|
*/
|
|
5523
5765
|
AgentArns?: string[];
|
|
@@ -5615,6 +5857,13 @@ export interface UpdateTaskRequest {
|
|
|
5615
5857
|
/**
|
|
5616
5858
|
* <p>Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for
|
|
5617
5859
|
* monitoring your task.</p>
|
|
5860
|
+
* <p>For Enhanced mode tasks, you must use <code>/aws/datasync</code> as your log group
|
|
5861
|
+
* name. For example:</p>
|
|
5862
|
+
* <p>
|
|
5863
|
+
* <code>arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync:*</code>
|
|
5864
|
+
* </p>
|
|
5865
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html">Monitoring data transfers with
|
|
5866
|
+
* CloudWatch Logs</a>.</p>
|
|
5618
5867
|
* @public
|
|
5619
5868
|
*/
|
|
5620
5869
|
CloudWatchLogGroupArn?: string;
|
|
@@ -470,6 +470,11 @@ export interface TaskSchedule {
|
|
|
470
470
|
ScheduleExpression: string | undefined;
|
|
471
471
|
Status?: ScheduleStatus;
|
|
472
472
|
}
|
|
473
|
+
export declare const TaskMode: {
|
|
474
|
+
readonly BASIC: "BASIC";
|
|
475
|
+
readonly ENHANCED: "ENHANCED";
|
|
476
|
+
};
|
|
477
|
+
export type TaskMode = (typeof TaskMode)[keyof typeof TaskMode];
|
|
473
478
|
export interface ReportDestinationS3 {
|
|
474
479
|
Subdirectory?: string;
|
|
475
480
|
S3BucketArn: string | undefined;
|
|
@@ -523,6 +528,7 @@ export interface CreateTaskRequest {
|
|
|
523
528
|
Includes?: FilterRule[];
|
|
524
529
|
ManifestConfig?: ManifestConfig;
|
|
525
530
|
TaskReportConfig?: TaskReportConfig;
|
|
531
|
+
TaskMode?: TaskMode;
|
|
526
532
|
}
|
|
527
533
|
export interface CreateTaskResponse {
|
|
528
534
|
TaskArn?: string;
|
|
@@ -923,10 +929,21 @@ export interface DescribeTaskResponse {
|
|
|
923
929
|
ManifestConfig?: ManifestConfig;
|
|
924
930
|
TaskReportConfig?: TaskReportConfig;
|
|
925
931
|
ScheduleDetails?: TaskScheduleDetails;
|
|
932
|
+
TaskMode?: TaskMode;
|
|
926
933
|
}
|
|
927
934
|
export interface DescribeTaskExecutionRequest {
|
|
928
935
|
TaskExecutionArn: string | undefined;
|
|
929
936
|
}
|
|
937
|
+
export interface TaskExecutionFilesFailedDetail {
|
|
938
|
+
Prepare?: number;
|
|
939
|
+
Transfer?: number;
|
|
940
|
+
Verify?: number;
|
|
941
|
+
Delete?: number;
|
|
942
|
+
}
|
|
943
|
+
export interface TaskExecutionFilesListedDetail {
|
|
944
|
+
AtSource?: number;
|
|
945
|
+
AtDestinationForDelete?: number;
|
|
946
|
+
}
|
|
930
947
|
export declare const PhaseStatus: {
|
|
931
948
|
readonly ERROR: "ERROR";
|
|
932
949
|
readonly PENDING: "PENDING";
|
|
@@ -982,6 +999,10 @@ export interface DescribeTaskExecutionResponse {
|
|
|
982
999
|
FilesVerified?: number;
|
|
983
1000
|
ReportResult?: ReportResult;
|
|
984
1001
|
EstimatedFilesToDelete?: number;
|
|
1002
|
+
TaskMode?: TaskMode;
|
|
1003
|
+
FilesPrepared?: number;
|
|
1004
|
+
FilesListed?: TaskExecutionFilesListedDetail;
|
|
1005
|
+
FilesFailed?: TaskExecutionFilesFailedDetail;
|
|
985
1006
|
}
|
|
986
1007
|
export interface DiscoveryJobListEntry {
|
|
987
1008
|
DiscoveryJobArn?: string;
|
|
@@ -1077,6 +1098,7 @@ export interface ListTaskExecutionsRequest {
|
|
|
1077
1098
|
export interface TaskExecutionListEntry {
|
|
1078
1099
|
TaskExecutionArn?: string;
|
|
1079
1100
|
Status?: TaskExecutionStatus;
|
|
1101
|
+
TaskMode?: TaskMode;
|
|
1080
1102
|
}
|
|
1081
1103
|
export interface ListTaskExecutionsResponse {
|
|
1082
1104
|
TaskExecutions?: TaskExecutionListEntry[];
|
|
@@ -1102,6 +1124,7 @@ export interface TaskListEntry {
|
|
|
1102
1124
|
TaskArn?: string;
|
|
1103
1125
|
Status?: TaskStatus;
|
|
1104
1126
|
Name?: string;
|
|
1127
|
+
TaskMode?: TaskMode;
|
|
1105
1128
|
}
|
|
1106
1129
|
export interface ListTasksResponse {
|
|
1107
1130
|
Tasks?: TaskListEntry[];
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-datasync",
|
|
3
3
|
"description": "AWS SDK for JavaScript Datasync Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.683.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-datasync",
|
|
@@ -20,19 +20,19 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
23
|
-
"@aws-sdk/client-sso-oidc": "3.
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
23
|
+
"@aws-sdk/client-sso-oidc": "3.682.0",
|
|
24
|
+
"@aws-sdk/client-sts": "3.682.0",
|
|
25
25
|
"@aws-sdk/core": "3.679.0",
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.682.0",
|
|
27
27
|
"@aws-sdk/middleware-host-header": "3.679.0",
|
|
28
28
|
"@aws-sdk/middleware-logger": "3.679.0",
|
|
29
29
|
"@aws-sdk/middleware-recursion-detection": "3.679.0",
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.682.0",
|
|
31
31
|
"@aws-sdk/region-config-resolver": "3.679.0",
|
|
32
32
|
"@aws-sdk/types": "3.679.0",
|
|
33
33
|
"@aws-sdk/util-endpoints": "3.679.0",
|
|
34
34
|
"@aws-sdk/util-user-agent-browser": "3.679.0",
|
|
35
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
35
|
+
"@aws-sdk/util-user-agent-node": "3.682.0",
|
|
36
36
|
"@smithy/config-resolver": "^3.0.9",
|
|
37
37
|
"@smithy/core": "^2.4.8",
|
|
38
38
|
"@smithy/fetch-http-handler": "^3.2.9",
|