@aws-sdk/client-datasync 3.507.0 → 3.509.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +12 -0
- package/dist-es/models/models_0.js +6 -0
- package/dist-es/protocols/Aws_json1_1.js +2 -0
- package/dist-types/commands/CreateLocationAzureBlobCommand.d.ts +3 -1
- package/dist-types/commands/CreateLocationEfsCommand.d.ts +6 -2
- package/dist-types/commands/CreateLocationFsxLustreCommand.d.ts +5 -1
- package/dist-types/commands/CreateLocationFsxOntapCommand.d.ts +4 -2
- package/dist-types/commands/CreateLocationFsxOpenZfsCommand.d.ts +5 -1
- package/dist-types/commands/CreateLocationFsxWindowsCommand.d.ts +6 -2
- package/dist-types/commands/CreateLocationHdfsCommand.d.ts +6 -1
- package/dist-types/commands/CreateLocationNfsCommand.d.ts +6 -3
- package/dist-types/commands/CreateLocationObjectStorageCommand.d.ts +4 -3
- package/dist-types/commands/CreateLocationS3Command.d.ts +4 -3
- package/dist-types/commands/CreateLocationSmbCommand.d.ts +5 -2
- package/dist-types/commands/CreateTaskCommand.d.ts +12 -0
- package/dist-types/commands/DeleteLocationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteTaskCommand.d.ts +1 -1
- package/dist-types/commands/DescribeLocationEfsCommand.d.ts +1 -2
- package/dist-types/commands/DescribeLocationFsxLustreCommand.d.ts +1 -1
- package/dist-types/commands/DescribeLocationFsxOntapCommand.d.ts +1 -1
- package/dist-types/commands/DescribeLocationFsxOpenZfsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeLocationFsxWindowsCommand.d.ts +1 -2
- package/dist-types/commands/DescribeLocationHdfsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeLocationObjectStorageCommand.d.ts +2 -2
- package/dist-types/commands/DescribeLocationS3Command.d.ts +2 -1
- package/dist-types/commands/DescribeLocationSmbCommand.d.ts +2 -1
- package/dist-types/commands/DescribeTaskCommand.d.ts +12 -0
- package/dist-types/commands/DescribeTaskExecutionCommand.d.ts +13 -1
- package/dist-types/commands/ListTaskExecutionsCommand.d.ts +1 -1
- package/dist-types/commands/StartTaskExecutionCommand.d.ts +17 -5
- package/dist-types/commands/UpdateTaskCommand.d.ts +13 -1
- package/dist-types/models/models_0.d.ts +484 -276
- package/dist-types/ts3.4/models/models_0.d.ts +31 -2
- package/package.json +2 -2
|
@@ -174,7 +174,7 @@ export interface Platform {
|
|
|
174
174
|
* @public
|
|
175
175
|
* <p>The version of the DataSync agent.</p>
|
|
176
176
|
* <important>
|
|
177
|
-
* <p>
|
|
177
|
+
* <p>On December 7, 2023, we discontinued version 1 DataSync agents. Check the DataSync console to see if you have affected agents. If you do, <a href="https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html">replace</a> those agents or <a href="https://docs.aws.amazon.com/datasync/latest/userguide/deleting-agent.html">delete</a> them if they aren't in use. If you need more help, contact <a href="https://aws.amazon.com/contact-us/">Amazon Web Services Support</a>.</p>
|
|
178
178
|
* </important>
|
|
179
179
|
*/
|
|
180
180
|
Version?: string;
|
|
@@ -745,6 +745,8 @@ export interface FsxProtocolSmb {
|
|
|
745
745
|
* @public
|
|
746
746
|
* <p>Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that
|
|
747
747
|
* your storage virtual machine (SVM) belongs to.</p>
|
|
748
|
+
* <p>If you have multiple domains in your environment, configuring this setting makes sure that
|
|
749
|
+
* DataSync connects to the right SVM.</p>
|
|
748
750
|
*/
|
|
749
751
|
Domain?: string;
|
|
750
752
|
/**
|
|
@@ -759,35 +761,9 @@ export interface FsxProtocolSmb {
|
|
|
759
761
|
Password: string | undefined;
|
|
760
762
|
/**
|
|
761
763
|
* @public
|
|
762
|
-
* <p>Specifies a user
|
|
763
|
-
*
|
|
764
|
-
*
|
|
765
|
-
* <ul>
|
|
766
|
-
* <li>
|
|
767
|
-
* <p>If you're using Directory Service for Microsoft Active Directory, the user must be a member of the
|
|
768
|
-
* Amazon Web Services Delegated FSx Administrators group.</p>
|
|
769
|
-
* </li>
|
|
770
|
-
* <li>
|
|
771
|
-
* <p>If you're using a self-managed Active Directory, the user must be a member of either
|
|
772
|
-
* the Domain Admins group or a custom group that you specified for file system
|
|
773
|
-
* administration when you created your file system.</p>
|
|
774
|
-
* </li>
|
|
775
|
-
* </ul>
|
|
776
|
-
* <p>Make sure that the user has the permissions it needs to copy the data you want:</p>
|
|
777
|
-
* <ul>
|
|
778
|
-
* <li>
|
|
779
|
-
* <p>
|
|
780
|
-
* <code>SE_TCB_NAME</code>: Required to set object ownership and file metadata. With
|
|
781
|
-
* this privilege, you also can copy NTFS discretionary access lists (DACLs).</p>
|
|
782
|
-
* </li>
|
|
783
|
-
* <li>
|
|
784
|
-
* <p>
|
|
785
|
-
* <code>SE_SECURITY_NAME</code>: May be needed to copy NTFS system access control lists
|
|
786
|
-
* (SACLs). This operation specifically requires the Windows privilege, which is granted to
|
|
787
|
-
* members of the Domain Admins group. If you configure your task to copy SACLs, make sure
|
|
788
|
-
* that the user has the required privileges. For information about copying SACLs, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions">Ownership and permissions-related options</a>.</p>
|
|
789
|
-
* </li>
|
|
790
|
-
* </ul>
|
|
764
|
+
* <p>Specifies a user that can mount and access the files, folders, and metadata in your SVM.</p>
|
|
765
|
+
* <p>For information about choosing a user with the right level of access for your transfer, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb">Using
|
|
766
|
+
* the SMB protocol</a>.</p>
|
|
791
767
|
*/
|
|
792
768
|
User: string | undefined;
|
|
793
769
|
}
|
|
@@ -964,24 +940,22 @@ export interface CreateLocationFsxWindowsRequest {
|
|
|
964
940
|
Tags?: TagListEntry[];
|
|
965
941
|
/**
|
|
966
942
|
* @public
|
|
967
|
-
* <p>Specifies the user
|
|
968
|
-
* file system.</p>
|
|
943
|
+
* <p>Specifies the user with the permissions to mount and access the files, folders, and file
|
|
944
|
+
* metadata in your FSx for Windows File Server file system.</p>
|
|
969
945
|
* <p>For information about choosing a user with the right level of access for your transfer, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions">required permissions</a> for FSx for Windows File Server locations.</p>
|
|
970
946
|
*/
|
|
971
947
|
User: string | undefined;
|
|
972
948
|
/**
|
|
973
949
|
* @public
|
|
974
|
-
* <p>Specifies the name of the
|
|
975
|
-
*
|
|
976
|
-
*
|
|
977
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions">required permissions</a> for FSx for Windows File Server locations.</p>
|
|
950
|
+
* <p>Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.</p>
|
|
951
|
+
* <p>If you have multiple Active Directory domains in your environment, configuring this
|
|
952
|
+
* parameter makes sure that DataSync connects to the right file system.</p>
|
|
978
953
|
*/
|
|
979
954
|
Domain?: string;
|
|
980
955
|
/**
|
|
981
956
|
* @public
|
|
982
|
-
* <p>Specifies the password of the user
|
|
983
|
-
*
|
|
984
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions">required permissions</a> for FSx for Windows File Server locations.</p>
|
|
957
|
+
* <p>Specifies the password of the user with the permissions to mount and access the files,
|
|
958
|
+
* folders, and file metadata in your FSx for Windows File Server file system.</p>
|
|
985
959
|
*/
|
|
986
960
|
Password: string | undefined;
|
|
987
961
|
}
|
|
@@ -1365,15 +1339,15 @@ export interface CreateLocationObjectStorageResponse {
|
|
|
1365
1339
|
}
|
|
1366
1340
|
/**
|
|
1367
1341
|
* @public
|
|
1368
|
-
* <p>
|
|
1369
|
-
*
|
|
1370
|
-
*
|
|
1371
|
-
* Amazon S3 in the <i>DataSync User Guide</i>.</p>
|
|
1342
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.</p>
|
|
1343
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access">Accessing
|
|
1344
|
+
* S3 buckets</a>.</p>
|
|
1372
1345
|
*/
|
|
1373
1346
|
export interface S3Config {
|
|
1374
1347
|
/**
|
|
1375
1348
|
* @public
|
|
1376
|
-
* <p>
|
|
1349
|
+
* <p>Specifies the ARN of the IAM role that DataSync uses to access
|
|
1350
|
+
* your S3 bucket.</p>
|
|
1377
1351
|
*/
|
|
1378
1352
|
BucketAccessRoleArn: string | undefined;
|
|
1379
1353
|
}
|
|
@@ -1402,46 +1376,76 @@ export type S3StorageClass = (typeof S3StorageClass)[keyof typeof S3StorageClass
|
|
|
1402
1376
|
export interface CreateLocationS3Request {
|
|
1403
1377
|
/**
|
|
1404
1378
|
* @public
|
|
1405
|
-
* <p>
|
|
1406
|
-
*
|
|
1379
|
+
* <p>Specifies a prefix in the S3 bucket that DataSync reads from or writes to
|
|
1380
|
+
* (depending on whether the bucket is a source or destination location).</p>
|
|
1381
|
+
* <note>
|
|
1382
|
+
* <p>DataSync can't transfer objects with a prefix that begins with a slash
|
|
1383
|
+
* (<code>/</code>) or includes <code>//</code>, <code>/./</code>, or
|
|
1384
|
+
* <code>/../</code> patterns. For example:</p>
|
|
1385
|
+
* <ul>
|
|
1386
|
+
* <li>
|
|
1387
|
+
* <p>
|
|
1388
|
+
* <code>/photos</code>
|
|
1389
|
+
* </p>
|
|
1390
|
+
* </li>
|
|
1391
|
+
* <li>
|
|
1392
|
+
* <p>
|
|
1393
|
+
* <code>photos//2006/January</code>
|
|
1394
|
+
* </p>
|
|
1395
|
+
* </li>
|
|
1396
|
+
* <li>
|
|
1397
|
+
* <p>
|
|
1398
|
+
* <code>photos/./2006/February</code>
|
|
1399
|
+
* </p>
|
|
1400
|
+
* </li>
|
|
1401
|
+
* <li>
|
|
1402
|
+
* <p>
|
|
1403
|
+
* <code>photos/../2006/March</code>
|
|
1404
|
+
* </p>
|
|
1405
|
+
* </li>
|
|
1406
|
+
* </ul>
|
|
1407
|
+
* </note>
|
|
1407
1408
|
*/
|
|
1408
1409
|
Subdirectory?: string;
|
|
1409
1410
|
/**
|
|
1410
1411
|
* @public
|
|
1411
|
-
* <p>
|
|
1412
|
-
* this
|
|
1412
|
+
* <p>Specifies the ARN of the S3 bucket that you want to use as a location. (When creating
|
|
1413
|
+
* your DataSync task later, you specify whether this location is a transfer source or
|
|
1414
|
+
* destination.) </p>
|
|
1415
|
+
* <p>If your S3 bucket is located on an Outposts resource, you must specify an Amazon S3 access
|
|
1416
|
+
* point. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html">Managing data access with Amazon S3 access points</a> in the
|
|
1417
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1413
1418
|
*/
|
|
1414
1419
|
S3BucketArn: string | undefined;
|
|
1415
1420
|
/**
|
|
1416
1421
|
* @public
|
|
1417
|
-
* <p>
|
|
1418
|
-
*
|
|
1419
|
-
*
|
|
1420
|
-
*
|
|
1421
|
-
*
|
|
1422
|
-
*
|
|
1422
|
+
* <p>Specifies the storage class that you want your objects to use when Amazon S3 is a
|
|
1423
|
+
* transfer destination.</p>
|
|
1424
|
+
* <p>For buckets in Amazon Web Services Regions, the storage class defaults to
|
|
1425
|
+
* <code>STANDARD</code>. For buckets on Outposts, the storage class defaults to
|
|
1426
|
+
* <code>OUTPOSTS</code>.</p>
|
|
1427
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Storage class
|
|
1428
|
+
* considerations with Amazon S3 transfers</a>.</p>
|
|
1423
1429
|
*/
|
|
1424
1430
|
S3StorageClass?: S3StorageClass;
|
|
1425
1431
|
/**
|
|
1426
1432
|
* @public
|
|
1427
|
-
* <p>
|
|
1428
|
-
*
|
|
1429
|
-
*
|
|
1430
|
-
* Amazon S3 in the <i>DataSync User Guide</i>.</p>
|
|
1433
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.</p>
|
|
1434
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access">Accessing
|
|
1435
|
+
* S3 buckets</a>.</p>
|
|
1431
1436
|
*/
|
|
1432
1437
|
S3Config: S3Config | undefined;
|
|
1433
1438
|
/**
|
|
1434
1439
|
* @public
|
|
1435
|
-
* <p>
|
|
1436
|
-
*
|
|
1437
|
-
* launching a DataSync agent on an Amazon Web Services Outpost, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent">Deploy your DataSync agent
|
|
1440
|
+
* <p>(Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of the DataSync agent on your Outpost.</p>
|
|
1441
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent">Deploy your DataSync agent
|
|
1438
1442
|
* on Outposts</a>.</p>
|
|
1439
1443
|
*/
|
|
1440
1444
|
AgentArns?: string[];
|
|
1441
1445
|
/**
|
|
1442
1446
|
* @public
|
|
1443
|
-
* <p>
|
|
1444
|
-
*
|
|
1447
|
+
* <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
|
|
1448
|
+
* We recommend creating at least a name tag for your transfer location.</p>
|
|
1445
1449
|
*/
|
|
1446
1450
|
Tags?: TagListEntry[];
|
|
1447
1451
|
}
|
|
@@ -1452,8 +1456,7 @@ export interface CreateLocationS3Request {
|
|
|
1452
1456
|
export interface CreateLocationS3Response {
|
|
1453
1457
|
/**
|
|
1454
1458
|
* @public
|
|
1455
|
-
* <p>The
|
|
1456
|
-
* created.</p>
|
|
1459
|
+
* <p>The ARN of the S3 location that you created.</p>
|
|
1457
1460
|
*/
|
|
1458
1461
|
LocationArn?: string;
|
|
1459
1462
|
}
|
|
@@ -1468,8 +1471,8 @@ export interface CreateLocationSmbRequest {
|
|
|
1468
1471
|
* will read or write data. You can include a subdirectory in the share path (for example,
|
|
1469
1472
|
* <code>/path/to/subdirectory</code>). Make sure that other SMB clients in your network can
|
|
1470
1473
|
* also mount this path.</p>
|
|
1471
|
-
* <p>To copy all data in the
|
|
1472
|
-
*
|
|
1474
|
+
* <p>To copy all data in the subdirectory, DataSync must be able to mount the SMB
|
|
1475
|
+
* share and access all of its data. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">required permissions</a> for SMB locations.</p>
|
|
1473
1476
|
*/
|
|
1474
1477
|
Subdirectory: string | undefined;
|
|
1475
1478
|
/**
|
|
@@ -1483,17 +1486,17 @@ export interface CreateLocationSmbRequest {
|
|
|
1483
1486
|
ServerHostname: string | undefined;
|
|
1484
1487
|
/**
|
|
1485
1488
|
* @public
|
|
1486
|
-
* <p>Specifies the user
|
|
1487
|
-
*
|
|
1489
|
+
* <p>Specifies the user that can mount and access the files, folders, and file metadata in your
|
|
1490
|
+
* SMB file server.</p>
|
|
1488
1491
|
* <p>For information about choosing a user with the right level of access for your transfer,
|
|
1489
1492
|
* see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">required permissions</a> for SMB locations.</p>
|
|
1490
1493
|
*/
|
|
1491
1494
|
User: string | undefined;
|
|
1492
1495
|
/**
|
|
1493
1496
|
* @public
|
|
1494
|
-
* <p>Specifies the
|
|
1495
|
-
* <p>If you have multiple domains in your environment, configuring this
|
|
1496
|
-
*
|
|
1497
|
+
* <p>Specifies the name of the Active Directory domain that your SMB file server belongs to. </p>
|
|
1498
|
+
* <p>If you have multiple Active Directory domains in your environment, configuring this
|
|
1499
|
+
* parameter makes sure that DataSync connects to the right file server.</p>
|
|
1497
1500
|
*/
|
|
1498
1501
|
Domain?: string;
|
|
1499
1502
|
/**
|
|
@@ -1565,6 +1568,98 @@ export interface FilterRule {
|
|
|
1565
1568
|
*/
|
|
1566
1569
|
Value?: string;
|
|
1567
1570
|
}
|
|
1571
|
+
/**
|
|
1572
|
+
* @public
|
|
1573
|
+
* @enum
|
|
1574
|
+
*/
|
|
1575
|
+
export declare const ManifestAction: {
|
|
1576
|
+
readonly TRANSFER: "TRANSFER";
|
|
1577
|
+
};
|
|
1578
|
+
/**
|
|
1579
|
+
* @public
|
|
1580
|
+
*/
|
|
1581
|
+
export type ManifestAction = (typeof ManifestAction)[keyof typeof ManifestAction];
|
|
1582
|
+
/**
|
|
1583
|
+
* @public
|
|
1584
|
+
* @enum
|
|
1585
|
+
*/
|
|
1586
|
+
export declare const ManifestFormat: {
|
|
1587
|
+
readonly CSV: "CSV";
|
|
1588
|
+
};
|
|
1589
|
+
/**
|
|
1590
|
+
* @public
|
|
1591
|
+
*/
|
|
1592
|
+
export type ManifestFormat = (typeof ManifestFormat)[keyof typeof ManifestFormat];
|
|
1593
|
+
/**
|
|
1594
|
+
* @public
|
|
1595
|
+
* <p>Specifies the S3 bucket where you're hosting the manifest that you want DataSync to use. 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>
|
|
1596
|
+
*/
|
|
1597
|
+
export interface S3ManifestConfig {
|
|
1598
|
+
/**
|
|
1599
|
+
* @public
|
|
1600
|
+
* <p>Specifies the Amazon S3 object key of your manifest. This can include a prefix
|
|
1601
|
+
* (for example, <code>prefix/my-manifest.csv</code>).</p>
|
|
1602
|
+
*/
|
|
1603
|
+
ManifestObjectPath: string | undefined;
|
|
1604
|
+
/**
|
|
1605
|
+
* @public
|
|
1606
|
+
* <p>Specifies the Identity and Access Management (IAM) role that allows DataSync to access your
|
|
1607
|
+
* 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>
|
|
1608
|
+
*/
|
|
1609
|
+
BucketAccessRoleArn: string | undefined;
|
|
1610
|
+
/**
|
|
1611
|
+
* @public
|
|
1612
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.</p>
|
|
1613
|
+
*/
|
|
1614
|
+
S3BucketArn: string | undefined;
|
|
1615
|
+
/**
|
|
1616
|
+
* @public
|
|
1617
|
+
* <p>Specifies the object version ID of the manifest that you want DataSync to use.
|
|
1618
|
+
* If you don't set this, DataSync uses the latest version of the object.</p>
|
|
1619
|
+
*/
|
|
1620
|
+
ManifestObjectVersionId?: string;
|
|
1621
|
+
}
|
|
1622
|
+
/**
|
|
1623
|
+
* @public
|
|
1624
|
+
* <p>Specifies the manifest that you want DataSync to use and where it's hosted.
|
|
1625
|
+
* 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>
|
|
1626
|
+
*/
|
|
1627
|
+
export interface SourceManifestConfig {
|
|
1628
|
+
/**
|
|
1629
|
+
* @public
|
|
1630
|
+
* <p>Specifies the S3 bucket where you're hosting your manifest.</p>
|
|
1631
|
+
*/
|
|
1632
|
+
S3: S3ManifestConfig | undefined;
|
|
1633
|
+
}
|
|
1634
|
+
/**
|
|
1635
|
+
* @public
|
|
1636
|
+
* <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>
|
|
1637
|
+
*/
|
|
1638
|
+
export interface ManifestConfig {
|
|
1639
|
+
/**
|
|
1640
|
+
* @public
|
|
1641
|
+
* <p>Specifies what DataSync uses the manifest for.</p>
|
|
1642
|
+
*/
|
|
1643
|
+
Action?: ManifestAction;
|
|
1644
|
+
/**
|
|
1645
|
+
* @public
|
|
1646
|
+
* <p>Specifies the file format of your manifest. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-create">Creating a manifest</a>.</p>
|
|
1647
|
+
*/
|
|
1648
|
+
Format?: ManifestFormat;
|
|
1649
|
+
/**
|
|
1650
|
+
* @public
|
|
1651
|
+
* <p>Specifies the manifest that you want DataSync to use and where it's
|
|
1652
|
+
* hosted.</p>
|
|
1653
|
+
* <note>
|
|
1654
|
+
* <p>You must specify this parameter if you're configuring a new manifest on or after February 7,
|
|
1655
|
+
* 2024.</p>
|
|
1656
|
+
* <p>If you don't, you'll get a 400 status code and <code>ValidationException</code> error
|
|
1657
|
+
* stating that you're missing the IAM role for DataSync to access the
|
|
1658
|
+
* 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>
|
|
1659
|
+
* </note>
|
|
1660
|
+
*/
|
|
1661
|
+
Source?: SourceManifestConfig;
|
|
1662
|
+
}
|
|
1568
1663
|
/**
|
|
1569
1664
|
* @public
|
|
1570
1665
|
* @enum
|
|
@@ -1740,60 +1835,81 @@ export interface Options {
|
|
|
1740
1835
|
/**
|
|
1741
1836
|
* @public
|
|
1742
1837
|
* <p>Specifies how and when DataSync checks the integrity of your data during a
|
|
1743
|
-
* transfer
|
|
1744
|
-
* <
|
|
1745
|
-
*
|
|
1746
|
-
*
|
|
1747
|
-
*
|
|
1748
|
-
*
|
|
1749
|
-
*
|
|
1750
|
-
*
|
|
1751
|
-
*
|
|
1752
|
-
*
|
|
1753
|
-
*
|
|
1754
|
-
*
|
|
1755
|
-
*
|
|
1756
|
-
* <
|
|
1757
|
-
*
|
|
1758
|
-
*
|
|
1759
|
-
*
|
|
1760
|
-
*
|
|
1761
|
-
*
|
|
1762
|
-
*
|
|
1763
|
-
*
|
|
1764
|
-
*
|
|
1765
|
-
*
|
|
1766
|
-
*
|
|
1838
|
+
* transfer.</p>
|
|
1839
|
+
* <ul>
|
|
1840
|
+
* <li>
|
|
1841
|
+
* <p>
|
|
1842
|
+
* <code>ONLY_FILES_TRANSFERRED</code> (recommended) - DataSync calculates
|
|
1843
|
+
* the checksum of transferred files and metadata at the source location. At the end of the
|
|
1844
|
+
* transfer, DataSync then compares this checksum to the checksum calculated on
|
|
1845
|
+
* those files at the destination.</p>
|
|
1846
|
+
* <p>We recommend this option when transferring to S3 Glacier Flexible Retrieval
|
|
1847
|
+
* or S3 Glacier Deep Archive storage classes. For more information, see
|
|
1848
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Storage
|
|
1849
|
+
* class considerations with Amazon S3 locations</a>.</p>
|
|
1850
|
+
* </li>
|
|
1851
|
+
* <li>
|
|
1852
|
+
* <p>
|
|
1853
|
+
* <code>POINT_IN_TIME_CONSISTENT</code> (default) - At the end of the transfer,
|
|
1854
|
+
* DataSync scans the entire source and destination to verify that both locations
|
|
1855
|
+
* are fully synchronized.</p>
|
|
1856
|
+
* <p>You can't use this option when transferring to S3 Glacier Flexible Retrieval
|
|
1857
|
+
* or S3 Glacier Deep Archive storage classes. For more information, see
|
|
1858
|
+
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Storage
|
|
1859
|
+
* class considerations with Amazon S3 locations</a>.</p>
|
|
1860
|
+
* </li>
|
|
1861
|
+
* <li>
|
|
1862
|
+
* <p>
|
|
1863
|
+
* <code>NONE</code> - DataSync doesn't run additional verification at the
|
|
1864
|
+
* end of the transfer. All data transmissions are still integrity-checked with checksum
|
|
1865
|
+
* verification during the transfer.</p>
|
|
1866
|
+
* </li>
|
|
1867
|
+
* </ul>
|
|
1767
1868
|
*/
|
|
1768
1869
|
VerifyMode?: VerifyMode;
|
|
1769
1870
|
/**
|
|
1770
1871
|
* @public
|
|
1771
|
-
* <p>Specifies whether
|
|
1772
|
-
*
|
|
1773
|
-
*
|
|
1774
|
-
*
|
|
1775
|
-
*
|
|
1776
|
-
*
|
|
1777
|
-
*
|
|
1778
|
-
*
|
|
1872
|
+
* <p>Specifies whether DataSync should modify or preserve data at the destination
|
|
1873
|
+
* location.</p>
|
|
1874
|
+
* <ul>
|
|
1875
|
+
* <li>
|
|
1876
|
+
* <p>
|
|
1877
|
+
* <code>ALWAYS</code> (default) - DataSync modifies data in the destination
|
|
1878
|
+
* location when source data (including metadata) has changed.</p>
|
|
1879
|
+
* <p>If DataSync overwrites objects, you might incur additional charges for
|
|
1880
|
+
* certain Amazon S3 storage classes (for example, for retrieval or early deletion).
|
|
1881
|
+
* For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Storage
|
|
1882
|
+
* class considerations with Amazon S3 transfers</a>.</p>
|
|
1883
|
+
* </li>
|
|
1884
|
+
* <li>
|
|
1885
|
+
* <p>
|
|
1886
|
+
* <code>NEVER</code> - DataSync doesn't overwrite data in the destination
|
|
1887
|
+
* location even if the source data has changed. You can use this option to protect against
|
|
1888
|
+
* overwriting changes made to files or objects in the destination.</p>
|
|
1889
|
+
* </li>
|
|
1890
|
+
* </ul>
|
|
1779
1891
|
*/
|
|
1780
1892
|
OverwriteMode?: OverwriteMode;
|
|
1781
1893
|
/**
|
|
1782
1894
|
* @public
|
|
1783
1895
|
* <p>Specifies whether to preserve metadata indicating the last time a file was read or
|
|
1784
|
-
* written to
|
|
1785
|
-
* attempts to preserve the original <code>Atime</code> attribute on all source files (that is,
|
|
1786
|
-
* the version before the <code>PREPARING</code> phase of the task execution).</p>
|
|
1896
|
+
* written to.</p>
|
|
1787
1897
|
* <note>
|
|
1788
1898
|
* <p>The behavior of <code>Atime</code> isn't fully standard across platforms, so DataSync can only do this on a best-effort basis.</p>
|
|
1789
1899
|
* </note>
|
|
1790
|
-
* <
|
|
1791
|
-
*
|
|
1792
|
-
*
|
|
1793
|
-
*
|
|
1794
|
-
*
|
|
1795
|
-
*
|
|
1796
|
-
*
|
|
1900
|
+
* <ul>
|
|
1901
|
+
* <li>
|
|
1902
|
+
* <p>
|
|
1903
|
+
* <code>BEST_EFFORT</code> (default) - DataSync attempts to preserve the
|
|
1904
|
+
* original <code>Atime</code> attribute on all source files (that is, the version before the
|
|
1905
|
+
* <code>PREPARING</code> phase of the task execution). This option is
|
|
1906
|
+
* recommended.</p>
|
|
1907
|
+
* </li>
|
|
1908
|
+
* <li>
|
|
1909
|
+
* <p>
|
|
1910
|
+
* <code>NONE</code> - Ignores <code>Atime</code>.</p>
|
|
1911
|
+
* </li>
|
|
1912
|
+
* </ul>
|
|
1797
1913
|
* <note>
|
|
1798
1914
|
* <p>If <code>Atime</code> is set to <code>BEST_EFFORT</code>, <code>Mtime</code> must be set
|
|
1799
1915
|
* to <code>PRESERVE</code>. </p>
|
|
@@ -1807,12 +1923,17 @@ export interface Options {
|
|
|
1807
1923
|
* <p>Specifies whether to preserve metadata indicating the last time that a file was written
|
|
1808
1924
|
* to before the <code>PREPARING</code> phase of your task execution. This option is required
|
|
1809
1925
|
* when you need to run the a task more than once.</p>
|
|
1810
|
-
* <
|
|
1811
|
-
*
|
|
1812
|
-
*
|
|
1813
|
-
*
|
|
1814
|
-
*
|
|
1815
|
-
*
|
|
1926
|
+
* <ul>
|
|
1927
|
+
* <li>
|
|
1928
|
+
* <p>
|
|
1929
|
+
* <code>PRESERVE</code> (default) - Preserves original <code>Mtime</code>, which is
|
|
1930
|
+
* recommended.</p>
|
|
1931
|
+
* </li>
|
|
1932
|
+
* <li>
|
|
1933
|
+
* <p>
|
|
1934
|
+
* <code>NONE</code> - Ignores <code>Mtime</code>.</p>
|
|
1935
|
+
* </li>
|
|
1936
|
+
* </ul>
|
|
1816
1937
|
* <note>
|
|
1817
1938
|
* <p>If <code>Mtime</code> is set to <code>PRESERVE</code>, <code>Atime</code> must be set to
|
|
1818
1939
|
* <code>BEST_EFFORT</code>.</p>
|
|
@@ -1824,25 +1945,35 @@ export interface Options {
|
|
|
1824
1945
|
/**
|
|
1825
1946
|
* @public
|
|
1826
1947
|
* <p>Specifies the POSIX user ID (UID) of the file's owner.</p>
|
|
1948
|
+
* <ul>
|
|
1949
|
+
* <li>
|
|
1950
|
+
* <p>
|
|
1951
|
+
* <code>INT_VALUE</code> (default) - Preserves the integer value of UID and group ID
|
|
1952
|
+
* (GID), which is recommended.</p>
|
|
1953
|
+
* </li>
|
|
1954
|
+
* <li>
|
|
1955
|
+
* <p>
|
|
1956
|
+
* <code>NONE</code> - Ignores UID and GID. </p>
|
|
1957
|
+
* </li>
|
|
1958
|
+
* </ul>
|
|
1827
1959
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata copied by DataSync</a>.</p>
|
|
1828
|
-
* <p>Default value: <code>INT_VALUE</code>. This preserves the integer value of the ID.</p>
|
|
1829
|
-
* <p>
|
|
1830
|
-
* <code>INT_VALUE</code>: Preserve the integer value of UID and group ID (GID)
|
|
1831
|
-
* (recommended).</p>
|
|
1832
|
-
* <p>
|
|
1833
|
-
* <code>NONE</code>: Ignore UID and GID. </p>
|
|
1834
1960
|
*/
|
|
1835
1961
|
Uid?: Uid;
|
|
1836
1962
|
/**
|
|
1837
1963
|
* @public
|
|
1838
1964
|
* <p>Specifies the POSIX group ID (GID) of the file's owners.</p>
|
|
1965
|
+
* <ul>
|
|
1966
|
+
* <li>
|
|
1967
|
+
* <p>
|
|
1968
|
+
* <code>INT_VALUE</code> (default) - Preserves the integer value of user ID (UID) and
|
|
1969
|
+
* GID, which is recommended.</p>
|
|
1970
|
+
* </li>
|
|
1971
|
+
* <li>
|
|
1972
|
+
* <p>
|
|
1973
|
+
* <code>NONE</code> - Ignores UID and GID.</p>
|
|
1974
|
+
* </li>
|
|
1975
|
+
* </ul>
|
|
1839
1976
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata copied by DataSync</a>.</p>
|
|
1840
|
-
* <p>Default value: <code>INT_VALUE</code>. This preserves the integer value of the ID.</p>
|
|
1841
|
-
* <p>
|
|
1842
|
-
* <code>INT_VALUE</code>: Preserve the integer value of user ID (UID) and GID
|
|
1843
|
-
* (recommended).</p>
|
|
1844
|
-
* <p>
|
|
1845
|
-
* <code>NONE</code>: Ignore UID and GID.</p>
|
|
1846
1977
|
*/
|
|
1847
1978
|
Gid?: Gid;
|
|
1848
1979
|
/**
|
|
@@ -1852,13 +1983,18 @@ export interface Options {
|
|
|
1852
1983
|
* deletes objects, you might incur minimum storage duration charges for certain storage classes.
|
|
1853
1984
|
* For detailed information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Considerations
|
|
1854
1985
|
* when working with Amazon S3 storage classes in DataSync</a>.</p>
|
|
1855
|
-
* <
|
|
1856
|
-
*
|
|
1857
|
-
*
|
|
1858
|
-
*
|
|
1859
|
-
*
|
|
1860
|
-
*
|
|
1861
|
-
*
|
|
1986
|
+
* <ul>
|
|
1987
|
+
* <li>
|
|
1988
|
+
* <p>
|
|
1989
|
+
* <code>PRESERVE</code> (default) - Ignores such destination files, which is
|
|
1990
|
+
* recommended. </p>
|
|
1991
|
+
* </li>
|
|
1992
|
+
* <li>
|
|
1993
|
+
* <p>
|
|
1994
|
+
* <code>REMOVE</code> - Deletes destination files that aren’t present in the
|
|
1995
|
+
* source.</p>
|
|
1996
|
+
* </li>
|
|
1997
|
+
* </ul>
|
|
1862
1998
|
* <note>
|
|
1863
1999
|
* <p>If you set this parameter to <code>REMOVE</code>, you can't set
|
|
1864
2000
|
* <code>TransferMode</code> to <code>ALL</code>. When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete.</p>
|
|
@@ -1875,13 +2011,17 @@ export interface Options {
|
|
|
1875
2011
|
* <p>DataSync can't copy the actual contents of these devices because they're
|
|
1876
2012
|
* nonterminal and don't return an end-of-file (EOF) marker.</p>
|
|
1877
2013
|
* </note>
|
|
1878
|
-
* <
|
|
1879
|
-
*
|
|
1880
|
-
*
|
|
1881
|
-
*
|
|
1882
|
-
*
|
|
1883
|
-
* <
|
|
1884
|
-
*
|
|
2014
|
+
* <ul>
|
|
2015
|
+
* <li>
|
|
2016
|
+
* <p>
|
|
2017
|
+
* <code>NONE</code> (default) - Ignores special devices (recommended).</p>
|
|
2018
|
+
* </li>
|
|
2019
|
+
* <li>
|
|
2020
|
+
* <p>
|
|
2021
|
+
* <code>PRESERVE</code> - Preserves character and block device metadata. This option
|
|
2022
|
+
* currently isn't supported for Amazon EFS.</p>
|
|
2023
|
+
* </li>
|
|
2024
|
+
* </ul>
|
|
1885
2025
|
*/
|
|
1886
2026
|
PreserveDevices?: PreserveDevices;
|
|
1887
2027
|
/**
|
|
@@ -1889,12 +2029,17 @@ export interface Options {
|
|
|
1889
2029
|
* <p>Specifies which users or groups can access a file for a specific purpose such as reading,
|
|
1890
2030
|
* writing, or execution of the file.</p>
|
|
1891
2031
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata copied by DataSync</a>.</p>
|
|
1892
|
-
* <
|
|
1893
|
-
*
|
|
1894
|
-
*
|
|
1895
|
-
*
|
|
1896
|
-
*
|
|
1897
|
-
*
|
|
2032
|
+
* <ul>
|
|
2033
|
+
* <li>
|
|
2034
|
+
* <p>
|
|
2035
|
+
* <code>PRESERVE</code> (default) - Preserves POSIX-style permissions, which is
|
|
2036
|
+
* recommended.</p>
|
|
2037
|
+
* </li>
|
|
2038
|
+
* <li>
|
|
2039
|
+
* <p>
|
|
2040
|
+
* <code>NONE</code> - Ignores POSIX-style permissions. </p>
|
|
2041
|
+
* </li>
|
|
2042
|
+
* </ul>
|
|
1898
2043
|
* <note>
|
|
1899
2044
|
* <p>DataSync can preserve extant permissions of a source location.</p>
|
|
1900
2045
|
* </note>
|
|
@@ -1918,10 +2063,21 @@ export interface Options {
|
|
|
1918
2063
|
* @public
|
|
1919
2064
|
* <p>Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs
|
|
1920
2065
|
* log group. To specify the log group, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn">CloudWatchLogGroupArn</a>.</p>
|
|
1921
|
-
* <
|
|
1922
|
-
*
|
|
1923
|
-
*
|
|
1924
|
-
*
|
|
2066
|
+
* <ul>
|
|
2067
|
+
* <li>
|
|
2068
|
+
* <p>
|
|
2069
|
+
* <code>BASIC</code> - Publishes logs with only basic information (such as transfer
|
|
2070
|
+
* errors).</p>
|
|
2071
|
+
* </li>
|
|
2072
|
+
* <li>
|
|
2073
|
+
* <p>
|
|
2074
|
+
* <code>TRANSFER</code> - Publishes logs for all files or objects that your DataSync task transfers and performs data-integrity checks on.</p>
|
|
2075
|
+
* </li>
|
|
2076
|
+
* <li>
|
|
2077
|
+
* <p>
|
|
2078
|
+
* <code>OFF</code> - No logs are published.</p>
|
|
2079
|
+
* </li>
|
|
2080
|
+
* </ul>
|
|
1925
2081
|
*/
|
|
1926
2082
|
LogLevel?: LogLevel;
|
|
1927
2083
|
/**
|
|
@@ -1929,12 +2085,18 @@ export interface Options {
|
|
|
1929
2085
|
* <p>Determines whether DataSync transfers only the data and metadata that differ
|
|
1930
2086
|
* between the source and the destination location or transfers all the content from the source
|
|
1931
2087
|
* (without comparing what's in the destination).</p>
|
|
1932
|
-
* <
|
|
1933
|
-
* <
|
|
1934
|
-
*
|
|
1935
|
-
*
|
|
1936
|
-
*
|
|
1937
|
-
*
|
|
2088
|
+
* <ul>
|
|
2089
|
+
* <li>
|
|
2090
|
+
* <p>
|
|
2091
|
+
* <code>CHANGED</code> (default) - DataSync copies only data or metadata that
|
|
2092
|
+
* is new or different content from the source location to the destination location.</p>
|
|
2093
|
+
* </li>
|
|
2094
|
+
* <li>
|
|
2095
|
+
* <p>
|
|
2096
|
+
* <code>ALL</code> - DataSync copies everything in the source to the
|
|
2097
|
+
* destination without comparing differences between the locations.</p>
|
|
2098
|
+
* </li>
|
|
2099
|
+
* </ul>
|
|
1938
2100
|
*/
|
|
1939
2101
|
TransferMode?: TransferMode;
|
|
1940
2102
|
/**
|
|
@@ -1943,54 +2105,58 @@ export interface Options {
|
|
|
1943
2105
|
* destination objects. </p>
|
|
1944
2106
|
* <p>This value is only used for transfers between SMB and Amazon FSx for Windows File Server
|
|
1945
2107
|
* locations or between two FSx for Windows File Server locations. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html">how DataSync handles metadata</a>.</p>
|
|
1946
|
-
* <p>Default value: <code>OWNER_DACL</code>
|
|
1947
|
-
* </p>
|
|
1948
|
-
* <p>
|
|
1949
|
-
* <code>OWNER_DACL</code>: For each copied object, DataSync copies the following
|
|
1950
|
-
* metadata:</p>
|
|
1951
|
-
* <ul>
|
|
1952
|
-
* <li>
|
|
1953
|
-
* <p>The object owner.</p>
|
|
1954
|
-
* </li>
|
|
1955
|
-
* <li>
|
|
1956
|
-
* <p>NTFS discretionary access control lists (DACLs), which determine whether to grant
|
|
1957
|
-
* access to an object.</p>
|
|
1958
|
-
* <p>DataSync won't copy NTFS system access control lists (SACLs) with this
|
|
1959
|
-
* option.</p>
|
|
1960
|
-
* </li>
|
|
1961
|
-
* </ul>
|
|
1962
|
-
* <p>
|
|
1963
|
-
* <code>OWNER_DACL_SACL</code>: For each copied object, DataSync copies the
|
|
1964
|
-
* following metadata:</p>
|
|
1965
2108
|
* <ul>
|
|
1966
2109
|
* <li>
|
|
1967
|
-
* <p>
|
|
2110
|
+
* <p>
|
|
2111
|
+
* <code>OWNER_DACL</code> (default) - For each copied object, DataSync copies
|
|
2112
|
+
* the following metadata:</p>
|
|
2113
|
+
* <ul>
|
|
2114
|
+
* <li>
|
|
2115
|
+
* <p>The object owner.</p>
|
|
2116
|
+
* </li>
|
|
2117
|
+
* <li>
|
|
2118
|
+
* <p>NTFS discretionary access control lists (DACLs), which determine whether to grant
|
|
2119
|
+
* access to an object.</p>
|
|
2120
|
+
* <p>DataSync won't copy NTFS system access control lists (SACLs) with this
|
|
2121
|
+
* option.</p>
|
|
2122
|
+
* </li>
|
|
2123
|
+
* </ul>
|
|
1968
2124
|
* </li>
|
|
1969
2125
|
* <li>
|
|
1970
|
-
* <p>
|
|
1971
|
-
*
|
|
2126
|
+
* <p>
|
|
2127
|
+
* <code>OWNER_DACL_SACL</code> - For each copied object, DataSync copies the
|
|
2128
|
+
* following metadata:</p>
|
|
2129
|
+
* <ul>
|
|
2130
|
+
* <li>
|
|
2131
|
+
* <p>The object owner.</p>
|
|
2132
|
+
* </li>
|
|
2133
|
+
* <li>
|
|
2134
|
+
* <p>NTFS discretionary access control lists (DACLs), which determine whether to grant
|
|
2135
|
+
* access to an object.</p>
|
|
2136
|
+
* </li>
|
|
2137
|
+
* <li>
|
|
2138
|
+
* <p>SACLs, which are used by administrators to log attempts to access a secured
|
|
2139
|
+
* object.</p>
|
|
2140
|
+
* <p>Copying SACLs requires granting additional permissions to the Windows user that
|
|
2141
|
+
* DataSync uses to access your SMB location. For information about choosing
|
|
2142
|
+
* 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
|
|
2143
|
+
* on the type of location in your transfer).</p>
|
|
2144
|
+
* </li>
|
|
2145
|
+
* </ul>
|
|
1972
2146
|
* </li>
|
|
1973
2147
|
* <li>
|
|
1974
|
-
* <p>
|
|
1975
|
-
*
|
|
1976
|
-
*
|
|
1977
|
-
*
|
|
1978
|
-
* user that ensures sufficient permissions to files, folders, and metadata, see <a href="create-smb-location.html#SMBuser">user</a>.</p>
|
|
2148
|
+
* <p>
|
|
2149
|
+
* <code>NONE</code> - None of the SMB security descriptor components are copied.
|
|
2150
|
+
* Destination objects are owned by the user that was provided for accessing the destination
|
|
2151
|
+
* location. DACLs and SACLs are set based on the destination server’s configuration. </p>
|
|
1979
2152
|
* </li>
|
|
1980
2153
|
* </ul>
|
|
1981
|
-
* <p>
|
|
1982
|
-
* <code>NONE</code>: None of the SMB security descriptor components are copied. Destination
|
|
1983
|
-
* objects are owned by the user that was provided for accessing the destination location. DACLs
|
|
1984
|
-
* and SACLs are set based on the destination server’s configuration. </p>
|
|
1985
2154
|
*/
|
|
1986
2155
|
SecurityDescriptorCopyFlags?: SmbSecurityDescriptorCopyFlags;
|
|
1987
2156
|
/**
|
|
1988
2157
|
* @public
|
|
1989
|
-
* <p>Specifies whether
|
|
1990
|
-
* systems. If you want your DataSync task to ignore object tags, specify the
|
|
1991
|
-
* <code>NONE</code> value.</p>
|
|
1992
|
-
* <p>Default Value: <code>PRESERVE</code>
|
|
1993
|
-
* </p>
|
|
2158
|
+
* <p>Specifies whether you want DataSync to <code>PRESERVE</code> object tags
|
|
2159
|
+
* (default behavior) when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the <code>NONE</code> value.</p>
|
|
1994
2160
|
*/
|
|
1995
2161
|
ObjectTags?: ObjectTags;
|
|
1996
2162
|
}
|
|
@@ -2025,7 +2191,7 @@ export interface ReportDestinationS3 {
|
|
|
2025
2191
|
S3BucketArn: string | undefined;
|
|
2026
2192
|
/**
|
|
2027
2193
|
* @public
|
|
2028
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/
|
|
2194
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">Allowing DataSync to upload a task report to an Amazon S3 bucket</a>.</p>
|
|
2029
2195
|
*/
|
|
2030
2196
|
BucketAccessRoleArn: string | undefined;
|
|
2031
2197
|
}
|
|
@@ -2243,10 +2409,18 @@ export interface CreateTaskRequest {
|
|
|
2243
2409
|
* information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
|
|
2244
2410
|
*/
|
|
2245
2411
|
Includes?: FilterRule[];
|
|
2412
|
+
/**
|
|
2413
|
+
* @public
|
|
2414
|
+
* <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>
|
|
2415
|
+
* <p>When using this parameter, your caller identity (the role that you're 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>
|
|
2416
|
+
*/
|
|
2417
|
+
ManifestConfig?: ManifestConfig;
|
|
2246
2418
|
/**
|
|
2247
2419
|
* @public
|
|
2248
2420
|
* <p>Specifies how you want to configure a task report, which provides detailed information
|
|
2249
|
-
* about
|
|
2421
|
+
* about your DataSync transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">Monitoring your DataSync
|
|
2422
|
+
* transfers with task reports</a>.</p>
|
|
2423
|
+
* <p>When using this parameter, your caller identity (the role that you're 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>
|
|
2250
2424
|
*/
|
|
2251
2425
|
TaskReportConfig?: TaskReportConfig;
|
|
2252
2426
|
}
|
|
@@ -2738,8 +2912,7 @@ export interface DescribeLocationFsxOpenZfsResponse {
|
|
|
2738
2912
|
export interface DescribeLocationFsxWindowsRequest {
|
|
2739
2913
|
/**
|
|
2740
2914
|
* @public
|
|
2741
|
-
* <p>
|
|
2742
|
-
* describe.</p>
|
|
2915
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the FSx for Windows File Server location.</p>
|
|
2743
2916
|
*/
|
|
2744
2917
|
LocationArn: string | undefined;
|
|
2745
2918
|
}
|
|
@@ -2749,19 +2922,18 @@ export interface DescribeLocationFsxWindowsRequest {
|
|
|
2749
2922
|
export interface DescribeLocationFsxWindowsResponse {
|
|
2750
2923
|
/**
|
|
2751
2924
|
* @public
|
|
2752
|
-
* <p>The
|
|
2753
|
-
* described.</p>
|
|
2925
|
+
* <p>The ARN of the FSx for Windows File Server location.</p>
|
|
2754
2926
|
*/
|
|
2755
2927
|
LocationArn?: string;
|
|
2756
2928
|
/**
|
|
2757
2929
|
* @public
|
|
2758
|
-
* <p>The
|
|
2930
|
+
* <p>The uniform resource identifier (URI) of the FSx for Windows File Server location.</p>
|
|
2759
2931
|
*/
|
|
2760
2932
|
LocationUri?: string;
|
|
2761
2933
|
/**
|
|
2762
2934
|
* @public
|
|
2763
|
-
* <p>The
|
|
2764
|
-
*
|
|
2935
|
+
* <p>The ARNs of the security groups that are configured for the FSx for Windows File Server file
|
|
2936
|
+
* system.</p>
|
|
2765
2937
|
*/
|
|
2766
2938
|
SecurityGroupArns?: string[];
|
|
2767
2939
|
/**
|
|
@@ -2771,13 +2943,14 @@ export interface DescribeLocationFsxWindowsResponse {
|
|
|
2771
2943
|
CreationTime?: Date;
|
|
2772
2944
|
/**
|
|
2773
2945
|
* @public
|
|
2774
|
-
* <p>The user
|
|
2775
|
-
*
|
|
2946
|
+
* <p>The user with the permissions to mount and access the FSx for Windows File Server file
|
|
2947
|
+
* system.</p>
|
|
2776
2948
|
*/
|
|
2777
2949
|
User?: string;
|
|
2778
2950
|
/**
|
|
2779
2951
|
* @public
|
|
2780
|
-
* <p>The name of the
|
|
2952
|
+
* <p>The name of the Microsoft Active Directory domain that the FSx for Windows File Server file
|
|
2953
|
+
* system belongs to.</p>
|
|
2781
2954
|
*/
|
|
2782
2955
|
Domain?: string;
|
|
2783
2956
|
}
|
|
@@ -2787,7 +2960,7 @@ export interface DescribeLocationFsxWindowsResponse {
|
|
|
2787
2960
|
export interface DescribeLocationHdfsRequest {
|
|
2788
2961
|
/**
|
|
2789
2962
|
* @public
|
|
2790
|
-
* <p>
|
|
2963
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the HDFS location.</p>
|
|
2791
2964
|
*/
|
|
2792
2965
|
LocationArn: string | undefined;
|
|
2793
2966
|
}
|
|
@@ -2797,17 +2970,17 @@ export interface DescribeLocationHdfsRequest {
|
|
|
2797
2970
|
export interface DescribeLocationHdfsResponse {
|
|
2798
2971
|
/**
|
|
2799
2972
|
* @public
|
|
2800
|
-
* <p>The ARN of the HDFS
|
|
2973
|
+
* <p>The ARN of the HDFS location.</p>
|
|
2801
2974
|
*/
|
|
2802
2975
|
LocationArn?: string;
|
|
2803
2976
|
/**
|
|
2804
2977
|
* @public
|
|
2805
|
-
* <p>The URI of the HDFS
|
|
2978
|
+
* <p>The URI of the HDFS location.</p>
|
|
2806
2979
|
*/
|
|
2807
2980
|
LocationUri?: string;
|
|
2808
2981
|
/**
|
|
2809
2982
|
* @public
|
|
2810
|
-
* <p>The NameNode that
|
|
2983
|
+
* <p>The NameNode that manages the HDFS namespace. </p>
|
|
2811
2984
|
*/
|
|
2812
2985
|
NameNodes?: HdfsNameNode[];
|
|
2813
2986
|
/**
|
|
@@ -2827,9 +3000,8 @@ export interface DescribeLocationHdfsResponse {
|
|
|
2827
3000
|
KmsKeyProviderUri?: string;
|
|
2828
3001
|
/**
|
|
2829
3002
|
* @public
|
|
2830
|
-
* <p>The Quality of Protection (QOP) configuration specifies the Remote Procedure Call
|
|
2831
|
-
* and data transfer protection settings configured on the
|
|
2832
|
-
* cluster. </p>
|
|
3003
|
+
* <p>The Quality of Protection (QOP) configuration, which specifies the Remote Procedure Call
|
|
3004
|
+
* (RPC) and data transfer protection settings configured on the HDFS cluster. </p>
|
|
2833
3005
|
*/
|
|
2834
3006
|
QopConfiguration?: QopConfiguration;
|
|
2835
3007
|
/**
|
|
@@ -2839,8 +3011,8 @@ export interface DescribeLocationHdfsResponse {
|
|
|
2839
3011
|
AuthenticationType?: HdfsAuthenticationType;
|
|
2840
3012
|
/**
|
|
2841
3013
|
* @public
|
|
2842
|
-
* <p>The user name
|
|
2843
|
-
*
|
|
3014
|
+
* <p>The user name to identify the client on the host operating system. This parameter is used
|
|
3015
|
+
* if the <code>AuthenticationType</code> is defined as <code>SIMPLE</code>.</p>
|
|
2844
3016
|
*/
|
|
2845
3017
|
SimpleUser?: string;
|
|
2846
3018
|
/**
|
|
@@ -2852,7 +3024,7 @@ export interface DescribeLocationHdfsResponse {
|
|
|
2852
3024
|
KerberosPrincipal?: string;
|
|
2853
3025
|
/**
|
|
2854
3026
|
* @public
|
|
2855
|
-
* <p>The ARNs of the agents that
|
|
3027
|
+
* <p>The ARNs of the DataSync agents that can connect with your HDFS cluster.</p>
|
|
2856
3028
|
*/
|
|
2857
3029
|
AgentArns?: string[];
|
|
2858
3030
|
/**
|
|
@@ -2885,7 +3057,7 @@ export interface DescribeLocationNfsResponse {
|
|
|
2885
3057
|
LocationArn?: string;
|
|
2886
3058
|
/**
|
|
2887
3059
|
* @public
|
|
2888
|
-
* <p>The
|
|
3060
|
+
* <p>The URI of the NFS location.</p>
|
|
2889
3061
|
*/
|
|
2890
3062
|
LocationUri?: string;
|
|
2891
3063
|
/**
|
|
@@ -2912,8 +3084,7 @@ export interface DescribeLocationNfsResponse {
|
|
|
2912
3084
|
export interface DescribeLocationObjectStorageRequest {
|
|
2913
3085
|
/**
|
|
2914
3086
|
* @public
|
|
2915
|
-
* <p>
|
|
2916
|
-
* information about.</p>
|
|
3087
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the object storage system location.</p>
|
|
2917
3088
|
*/
|
|
2918
3089
|
LocationArn: string | undefined;
|
|
2919
3090
|
}
|
|
@@ -2929,7 +3100,7 @@ export interface DescribeLocationObjectStorageResponse {
|
|
|
2929
3100
|
LocationArn?: string;
|
|
2930
3101
|
/**
|
|
2931
3102
|
* @public
|
|
2932
|
-
* <p>The
|
|
3103
|
+
* <p>The URI of the object storage system location.</p>
|
|
2933
3104
|
*/
|
|
2934
3105
|
LocationUri?: string;
|
|
2935
3106
|
/**
|
|
@@ -2951,8 +3122,8 @@ export interface DescribeLocationObjectStorageResponse {
|
|
|
2951
3122
|
ServerProtocol?: ObjectStorageServerProtocol;
|
|
2952
3123
|
/**
|
|
2953
3124
|
* @public
|
|
2954
|
-
* <p>The ARNs of the DataSync agents that can
|
|
2955
|
-
*
|
|
3125
|
+
* <p>The ARNs of the DataSync agents that can connect with your object storage
|
|
3126
|
+
* system.</p>
|
|
2956
3127
|
*/
|
|
2957
3128
|
AgentArns?: string[];
|
|
2958
3129
|
/**
|
|
@@ -2974,7 +3145,7 @@ export interface DescribeLocationObjectStorageResponse {
|
|
|
2974
3145
|
export interface DescribeLocationS3Request {
|
|
2975
3146
|
/**
|
|
2976
3147
|
* @public
|
|
2977
|
-
* <p>
|
|
3148
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the Amazon S3 location.</p>
|
|
2978
3149
|
*/
|
|
2979
3150
|
LocationArn: string | undefined;
|
|
2980
3151
|
}
|
|
@@ -2985,7 +3156,7 @@ export interface DescribeLocationS3Request {
|
|
|
2985
3156
|
export interface DescribeLocationS3Response {
|
|
2986
3157
|
/**
|
|
2987
3158
|
* @public
|
|
2988
|
-
* <p>The
|
|
3159
|
+
* <p>The ARN of the Amazon S3 location.</p>
|
|
2989
3160
|
*/
|
|
2990
3161
|
LocationArn?: string;
|
|
2991
3162
|
/**
|
|
@@ -2995,32 +3166,31 @@ export interface DescribeLocationS3Response {
|
|
|
2995
3166
|
LocationUri?: string;
|
|
2996
3167
|
/**
|
|
2997
3168
|
* @public
|
|
2998
|
-
* <p>
|
|
2999
|
-
*
|
|
3000
|
-
*
|
|
3001
|
-
*
|
|
3002
|
-
*
|
|
3169
|
+
* <p>When Amazon S3 is a destination location, this is the storage class that you chose
|
|
3170
|
+
* for your objects.</p>
|
|
3171
|
+
* <p>Some storage classes have behaviors that can affect your Amazon S3 storage costs.
|
|
3172
|
+
* For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Storage class
|
|
3173
|
+
* considerations with Amazon S3 transfers</a>.</p>
|
|
3003
3174
|
*/
|
|
3004
3175
|
S3StorageClass?: S3StorageClass;
|
|
3005
3176
|
/**
|
|
3006
3177
|
* @public
|
|
3007
|
-
* <p>
|
|
3008
|
-
*
|
|
3009
|
-
*
|
|
3010
|
-
* Amazon S3 in the <i>DataSync User Guide</i>.</p>
|
|
3178
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.</p>
|
|
3179
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access">Accessing
|
|
3180
|
+
* S3 buckets</a>.</p>
|
|
3011
3181
|
*/
|
|
3012
3182
|
S3Config?: S3Config;
|
|
3013
3183
|
/**
|
|
3014
3184
|
* @public
|
|
3015
|
-
* <p>
|
|
3016
|
-
*
|
|
3017
|
-
*
|
|
3185
|
+
* <p>The ARNs of the DataSync agents deployed on your Outpost when using working with
|
|
3186
|
+
* Amazon S3 on Outposts.</p>
|
|
3187
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent">Deploy your DataSync agent
|
|
3018
3188
|
* on Outposts</a>.</p>
|
|
3019
3189
|
*/
|
|
3020
3190
|
AgentArns?: string[];
|
|
3021
3191
|
/**
|
|
3022
3192
|
* @public
|
|
3023
|
-
* <p>The time that the Amazon S3
|
|
3193
|
+
* <p>The time that the Amazon S3 location was created.</p>
|
|
3024
3194
|
*/
|
|
3025
3195
|
CreationTime?: Date;
|
|
3026
3196
|
}
|
|
@@ -3031,7 +3201,8 @@ export interface DescribeLocationS3Response {
|
|
|
3031
3201
|
export interface DescribeLocationSmbRequest {
|
|
3032
3202
|
/**
|
|
3033
3203
|
* @public
|
|
3034
|
-
* <p>
|
|
3204
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the SMB location that you want information
|
|
3205
|
+
* about.</p>
|
|
3035
3206
|
*/
|
|
3036
3207
|
LocationArn: string | undefined;
|
|
3037
3208
|
}
|
|
@@ -3042,34 +3213,35 @@ export interface DescribeLocationSmbRequest {
|
|
|
3042
3213
|
export interface DescribeLocationSmbResponse {
|
|
3043
3214
|
/**
|
|
3044
3215
|
* @public
|
|
3045
|
-
* <p>The
|
|
3216
|
+
* <p>The ARN of the SMB location.</p>
|
|
3046
3217
|
*/
|
|
3047
3218
|
LocationArn?: string;
|
|
3048
3219
|
/**
|
|
3049
3220
|
* @public
|
|
3050
|
-
* <p>The
|
|
3221
|
+
* <p>The URI of the SMB location.</p>
|
|
3051
3222
|
*/
|
|
3052
3223
|
LocationUri?: string;
|
|
3053
3224
|
/**
|
|
3054
3225
|
* @public
|
|
3055
|
-
* <p>The
|
|
3056
|
-
*
|
|
3226
|
+
* <p>The ARNs of the DataSync agents that can connect with your SMB file
|
|
3227
|
+
* server.</p>
|
|
3057
3228
|
*/
|
|
3058
3229
|
AgentArns?: string[];
|
|
3059
3230
|
/**
|
|
3060
3231
|
* @public
|
|
3061
|
-
* <p>The user
|
|
3062
|
-
*
|
|
3232
|
+
* <p>The user that can mount and access the files, folders, and file metadata in your SMB file
|
|
3233
|
+
* server.</p>
|
|
3063
3234
|
*/
|
|
3064
3235
|
User?: string;
|
|
3065
3236
|
/**
|
|
3066
3237
|
* @public
|
|
3067
|
-
* <p>The name of the
|
|
3238
|
+
* <p>The name of the Microsoft Active Directory domain that the SMB file server belongs
|
|
3239
|
+
* to.</p>
|
|
3068
3240
|
*/
|
|
3069
3241
|
Domain?: string;
|
|
3070
3242
|
/**
|
|
3071
3243
|
* @public
|
|
3072
|
-
* <p>The
|
|
3244
|
+
* <p>The protocol that DataSync use to access your SMB file.</p>
|
|
3073
3245
|
*/
|
|
3074
3246
|
MountOptions?: SmbMountOptions;
|
|
3075
3247
|
/**
|
|
@@ -3953,7 +4125,14 @@ export interface DescribeTaskResponse {
|
|
|
3953
4125
|
Includes?: FilterRule[];
|
|
3954
4126
|
/**
|
|
3955
4127
|
* @public
|
|
3956
|
-
* <p>The configuration of
|
|
4128
|
+
* <p>The configuration of the manifest that lists the files or objects to transfer. For more
|
|
4129
|
+
* information, 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>
|
|
4130
|
+
*/
|
|
4131
|
+
ManifestConfig?: ManifestConfig;
|
|
4132
|
+
/**
|
|
4133
|
+
* @public
|
|
4134
|
+
* <p>The configuration of your task report, which provides detailed information about for your
|
|
4135
|
+
* DataSync transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">Creating a task report</a>.</p>
|
|
3957
4136
|
*/
|
|
3958
4137
|
TaskReportConfig?: TaskReportConfig;
|
|
3959
4138
|
}
|
|
@@ -4124,6 +4303,12 @@ export interface DescribeTaskExecutionResponse {
|
|
|
4124
4303
|
* information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
|
|
4125
4304
|
*/
|
|
4126
4305
|
Includes?: FilterRule[];
|
|
4306
|
+
/**
|
|
4307
|
+
* @public
|
|
4308
|
+
* <p>The configuration of the manifest that lists the files or objects to transfer. For more
|
|
4309
|
+
* information, 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>
|
|
4310
|
+
*/
|
|
4311
|
+
ManifestConfig?: ManifestConfig;
|
|
4127
4312
|
/**
|
|
4128
4313
|
* @public
|
|
4129
4314
|
* <p>The time when the task execution started.</p>
|
|
@@ -4166,11 +4351,6 @@ export interface DescribeTaskExecutionResponse {
|
|
|
4166
4351
|
* sent over the network, see <code>BytesCompressed</code>. </p>
|
|
4167
4352
|
*/
|
|
4168
4353
|
BytesTransferred?: number;
|
|
4169
|
-
/**
|
|
4170
|
-
* @public
|
|
4171
|
-
* <p>The result of the task execution.</p>
|
|
4172
|
-
*/
|
|
4173
|
-
Result?: TaskExecutionResultDetail;
|
|
4174
4354
|
/**
|
|
4175
4355
|
* @public
|
|
4176
4356
|
* <p>The physical number of bytes transferred over the network after compression was applied.
|
|
@@ -4180,7 +4360,13 @@ export interface DescribeTaskExecutionResponse {
|
|
|
4180
4360
|
BytesCompressed?: number;
|
|
4181
4361
|
/**
|
|
4182
4362
|
* @public
|
|
4183
|
-
* <p>The
|
|
4363
|
+
* <p>The result of the task execution.</p>
|
|
4364
|
+
*/
|
|
4365
|
+
Result?: TaskExecutionResultDetail;
|
|
4366
|
+
/**
|
|
4367
|
+
* @public
|
|
4368
|
+
* <p>The configuration of your task report, which provides detailed information about for your
|
|
4369
|
+
* DataSync transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">Creating a task report</a>.</p>
|
|
4184
4370
|
*/
|
|
4185
4371
|
TaskReportConfig?: TaskReportConfig;
|
|
4186
4372
|
/**
|
|
@@ -4578,37 +4764,37 @@ export interface ListTagsForResourceResponse {
|
|
|
4578
4764
|
export interface ListTaskExecutionsRequest {
|
|
4579
4765
|
/**
|
|
4580
4766
|
* @public
|
|
4581
|
-
* <p>
|
|
4767
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the task that you want execution
|
|
4768
|
+
* information about.</p>
|
|
4582
4769
|
*/
|
|
4583
4770
|
TaskArn?: string;
|
|
4584
4771
|
/**
|
|
4585
4772
|
* @public
|
|
4586
|
-
* <p>
|
|
4773
|
+
* <p>Specifies how many results you want in the response.</p>
|
|
4587
4774
|
*/
|
|
4588
4775
|
MaxResults?: number;
|
|
4589
4776
|
/**
|
|
4590
4777
|
* @public
|
|
4591
|
-
* <p>
|
|
4592
|
-
*
|
|
4778
|
+
* <p>Specifies an opaque string that indicates the position at which to begin the next list
|
|
4779
|
+
* of results in the response.</p>
|
|
4593
4780
|
*/
|
|
4594
4781
|
NextToken?: string;
|
|
4595
4782
|
}
|
|
4596
4783
|
/**
|
|
4597
4784
|
* @public
|
|
4598
|
-
* <p>Represents a single entry in a list of task executions
|
|
4599
|
-
*
|
|
4600
|
-
*
|
|
4601
|
-
* operation is called.</p>
|
|
4785
|
+
* <p>Represents a single entry in a list of DataSync task executions that's
|
|
4786
|
+
* returned with the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html">ListTaskExecutions</a>
|
|
4787
|
+
* operation.</p>
|
|
4602
4788
|
*/
|
|
4603
4789
|
export interface TaskExecutionListEntry {
|
|
4604
4790
|
/**
|
|
4605
4791
|
* @public
|
|
4606
|
-
* <p>The Amazon Resource Name (ARN) of
|
|
4792
|
+
* <p>The Amazon Resource Name (ARN) of a task execution.</p>
|
|
4607
4793
|
*/
|
|
4608
4794
|
TaskExecutionArn?: string;
|
|
4609
4795
|
/**
|
|
4610
4796
|
* @public
|
|
4611
|
-
* <p>The status of a task execution
|
|
4797
|
+
* <p>The status of a task execution. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/understand-task-statuses.html#understand-task-execution-statuses">Task execution statuses</a>.</p>
|
|
4612
4798
|
*/
|
|
4613
4799
|
Status?: TaskExecutionStatus;
|
|
4614
4800
|
}
|
|
@@ -4619,13 +4805,13 @@ export interface TaskExecutionListEntry {
|
|
|
4619
4805
|
export interface ListTaskExecutionsResponse {
|
|
4620
4806
|
/**
|
|
4621
4807
|
* @public
|
|
4622
|
-
* <p>A list of
|
|
4808
|
+
* <p>A list of the task's executions.</p>
|
|
4623
4809
|
*/
|
|
4624
4810
|
TaskExecutions?: TaskExecutionListEntry[];
|
|
4625
4811
|
/**
|
|
4626
4812
|
* @public
|
|
4627
|
-
* <p>
|
|
4628
|
-
*
|
|
4813
|
+
* <p>The opaque string that indicates the position to begin the next list of results in the
|
|
4814
|
+
* response.</p>
|
|
4629
4815
|
*/
|
|
4630
4816
|
NextToken?: string;
|
|
4631
4817
|
}
|
|
@@ -4829,6 +5015,22 @@ export interface StartTaskExecutionRequest {
|
|
|
4829
5015
|
* are delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>. </p>
|
|
4830
5016
|
*/
|
|
4831
5017
|
Excludes?: FilterRule[];
|
|
5018
|
+
/**
|
|
5019
|
+
* @public
|
|
5020
|
+
* <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>
|
|
5021
|
+
* <p>When using this parameter, your caller identity (the role that you're 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>
|
|
5022
|
+
* <p>To remove a manifest configuration, specify this parameter with an empty value.</p>
|
|
5023
|
+
*/
|
|
5024
|
+
ManifestConfig?: ManifestConfig;
|
|
5025
|
+
/**
|
|
5026
|
+
* @public
|
|
5027
|
+
* <p>Specifies how you want to configure a task report, which provides detailed information
|
|
5028
|
+
* about your DataSync transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">Monitoring your DataSync
|
|
5029
|
+
* transfers with task reports</a>.</p>
|
|
5030
|
+
* <p>When using this parameter, your caller identity (the role that you're 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>
|
|
5031
|
+
* <p>To remove a task report configuration, specify this parameter as empty.</p>
|
|
5032
|
+
*/
|
|
5033
|
+
TaskReportConfig?: TaskReportConfig;
|
|
4832
5034
|
/**
|
|
4833
5035
|
* @public
|
|
4834
5036
|
* <p>Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing
|
|
@@ -4838,11 +5040,6 @@ export interface StartTaskExecutionRequest {
|
|
|
4838
5040
|
* your DataSync resources.</p>
|
|
4839
5041
|
*/
|
|
4840
5042
|
Tags?: TagListEntry[];
|
|
4841
|
-
/**
|
|
4842
|
-
* @public
|
|
4843
|
-
* <p>Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.</p>
|
|
4844
|
-
*/
|
|
4845
|
-
TaskReportConfig?: TaskReportConfig;
|
|
4846
5043
|
}
|
|
4847
5044
|
/**
|
|
4848
5045
|
* @public
|
|
@@ -5342,7 +5539,18 @@ export interface UpdateTaskRequest {
|
|
|
5342
5539
|
Includes?: FilterRule[];
|
|
5343
5540
|
/**
|
|
5344
5541
|
* @public
|
|
5345
|
-
* <p>
|
|
5542
|
+
* <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>
|
|
5543
|
+
* <p>When using this parameter, your caller identity (the IAM role that you're 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>
|
|
5544
|
+
* <p>To remove a manifest configuration, specify this parameter as empty.</p>
|
|
5545
|
+
*/
|
|
5546
|
+
ManifestConfig?: ManifestConfig;
|
|
5547
|
+
/**
|
|
5548
|
+
* @public
|
|
5549
|
+
* <p>Specifies how you want to configure a task report, which provides detailed information
|
|
5550
|
+
* about your DataSync transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">Monitoring your DataSync
|
|
5551
|
+
* transfers with task reports</a>.</p>
|
|
5552
|
+
* <p>When using this parameter, your caller identity (the IAM role that you're 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>
|
|
5553
|
+
* <p>To remove a task report configuration, specify this parameter as empty.</p>
|
|
5346
5554
|
*/
|
|
5347
5555
|
TaskReportConfig?: TaskReportConfig;
|
|
5348
5556
|
}
|