aws-sdk-datasync 1.72.0 → 1.73.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -615,8 +615,9 @@ module Aws::DataSync
615
615
  req.send_request(options)
616
616
  end
617
617
 
618
- # Creates an endpoint for a Microsoft Azure Blob Storage container that
619
- # DataSync can use as a transfer source or destination.
618
+ # Creates a transfer *location* for a Microsoft Azure Blob Storage
619
+ # container. DataSync can use this location as a transfer source or
620
+ # destination.
620
621
  #
621
622
  # Before you begin, make sure you know [how DataSync accesses Azure Blob
622
623
  # Storage][1] and works with [access tiers][2] and [blob types][3]. You
@@ -719,13 +720,16 @@ module Aws::DataSync
719
720
  req.send_request(options)
720
721
  end
721
722
 
722
- # Creates an endpoint for an Amazon EFS file system that DataSync can
723
- # access for a transfer. For more information, see [Creating a location
724
- # for Amazon EFS][1].
723
+ # Creates a transfer *location* for an Amazon EFS file system. DataSync
724
+ # can use this location as a source or destination for transferring
725
+ # data.
726
+ #
727
+ # Before you begin, make sure that you understand how DataSync [accesses
728
+ # Amazon EFS file systems][1].
725
729
  #
726
730
  #
727
731
  #
728
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html
732
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-access
729
733
  #
730
734
  # @option params [String] :subdirectory
731
735
  # Specifies a mount path for your Amazon EFS file system. This is where
@@ -805,7 +809,16 @@ module Aws::DataSync
805
809
  req.send_request(options)
806
810
  end
807
811
 
808
- # Creates an endpoint for an Amazon FSx for Lustre file system.
812
+ # Creates a transfer *location* for an Amazon FSx for Lustre file
813
+ # system. DataSync can use this location as a source or destination for
814
+ # transferring data.
815
+ #
816
+ # Before you begin, make sure that you understand how DataSync [accesses
817
+ # FSx for Lustre file systems][1].
818
+ #
819
+ #
820
+ #
821
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-lustre-location.html#create-lustre-location-access
809
822
  #
810
823
  # @option params [required, String] :fsx_filesystem_arn
811
824
  # The Amazon Resource Name (ARN) for the FSx for Lustre file system.
@@ -856,11 +869,12 @@ module Aws::DataSync
856
869
  req.send_request(options)
857
870
  end
858
871
 
859
- # Creates an endpoint for an Amazon FSx for NetApp ONTAP file system
860
- # that DataSync can use for a data transfer.
872
+ # Creates a transfer *location* for an Amazon FSx for NetApp ONTAP file
873
+ # system. DataSync can use this location as a source or destination for
874
+ # transferring data.
861
875
  #
862
876
  # Before you begin, make sure that you understand how DataSync [accesses
863
- # an FSx for ONTAP file system][1].
877
+ # FSx for ONTAP file systems][1].
864
878
  #
865
879
  #
866
880
  #
@@ -958,9 +972,12 @@ module Aws::DataSync
958
972
  req.send_request(options)
959
973
  end
960
974
 
961
- # Creates an endpoint for an Amazon FSx for OpenZFS file system that
962
- # DataSync can access for a transfer. For more information, see
963
- # [Creating a location for FSx for OpenZFS][1].
975
+ # Creates a transfer *location* for an Amazon FSx for OpenZFS file
976
+ # system. DataSync can use this location as a source or destination for
977
+ # transferring data.
978
+ #
979
+ # Before you begin, make sure that you understand how DataSync [accesses
980
+ # FSx for OpenZFS file systems][1].
964
981
  #
965
982
  # <note markdown="1"> Request parameters related to `SMB` aren't supported with the
966
983
  # `CreateLocationFsxOpenZfs` operation.
@@ -969,7 +986,7 @@ module Aws::DataSync
969
986
  #
970
987
  #
971
988
  #
972
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html
989
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html#create-openzfs-access
973
990
  #
974
991
  # @option params [required, String] :fsx_filesystem_arn
975
992
  # The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.
@@ -1038,11 +1055,12 @@ module Aws::DataSync
1038
1055
  req.send_request(options)
1039
1056
  end
1040
1057
 
1041
- # Creates an endpoint for an Amazon FSx for Windows File Server file
1042
- # system that DataSync can use for a data transfer.
1058
+ # Creates a transfer *location* for an Amazon FSx for Windows File
1059
+ # Server file system. DataSync can use this location as a source or
1060
+ # destination for transferring data.
1043
1061
  #
1044
1062
  # Before you begin, make sure that you understand how DataSync [accesses
1045
- # an FSx for Windows File Server][1].
1063
+ # FSx for Windows File Server file systems][1].
1046
1064
  #
1047
1065
  #
1048
1066
  #
@@ -1078,8 +1096,9 @@ module Aws::DataSync
1078
1096
  # tag for your location.
1079
1097
  #
1080
1098
  # @option params [required, String] :user
1081
- # Specifies the user who has the permissions to access files, folders,
1082
- # and metadata in your file system.
1099
+ # Specifies the user with the permissions to mount and access the files,
1100
+ # folders, and file metadata in your FSx for Windows File Server file
1101
+ # system.
1083
1102
  #
1084
1103
  # For information about choosing a user with the right level of access
1085
1104
  # for your transfer, see [required permissions][1] for FSx for Windows
@@ -1090,29 +1109,17 @@ module Aws::DataSync
1090
1109
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions
1091
1110
  #
1092
1111
  # @option params [String] :domain
1093
- # Specifies the name of the Windows domain that the FSx for Windows File
1094
- # Server belongs to.
1095
- #
1096
- # If you have multiple domains in your environment, configuring this
1097
- # parameter makes sure that DataSync connects to the right file server.
1098
- #
1099
- # For more information, see [required permissions][1] for FSx for
1100
- # Windows File Server locations.
1112
+ # Specifies the name of the Microsoft Active Directory domain that the
1113
+ # FSx for Windows File Server file system belongs to.
1101
1114
  #
1102
- #
1103
- #
1104
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions
1115
+ # If you have multiple Active Directory domains in your environment,
1116
+ # configuring this parameter makes sure that DataSync connects to the
1117
+ # right file system.
1105
1118
  #
1106
1119
  # @option params [required, String] :password
1107
- # Specifies the password of the user who has the permissions to access
1108
- # files and folders in the file system.
1109
- #
1110
- # For more information, see [required permissions][1] for FSx for
1111
- # Windows File Server locations.
1112
- #
1113
- #
1114
- #
1115
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions
1120
+ # Specifies the password of the user with the permissions to mount and
1121
+ # access the files, folders, and file metadata in your FSx for Windows
1122
+ # File Server file system.
1116
1123
  #
1117
1124
  # @return [Types::CreateLocationFsxWindowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1118
1125
  #
@@ -1148,7 +1155,16 @@ module Aws::DataSync
1148
1155
  req.send_request(options)
1149
1156
  end
1150
1157
 
1151
- # Creates an endpoint for a Hadoop Distributed File System (HDFS).
1158
+ # Creates a transfer *location* for a Hadoop Distributed File System
1159
+ # (HDFS). DataSync can use this location as a source or destination for
1160
+ # transferring data.
1161
+ #
1162
+ # Before you begin, make sure that you understand how DataSync [accesses
1163
+ # HDFS clusters][1].
1164
+ #
1165
+ #
1166
+ #
1167
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-hdfs-location.html#accessing-hdfs
1152
1168
  #
1153
1169
  # @option params [String] :subdirectory
1154
1170
  # A subdirectory in the HDFS cluster. This subdirectory is used to read
@@ -1283,11 +1299,12 @@ module Aws::DataSync
1283
1299
  req.send_request(options)
1284
1300
  end
1285
1301
 
1286
- # Creates an endpoint for a Network File System (NFS) file server that
1287
- # DataSync can use for a data transfer.
1302
+ # Creates a transfer *location* for a Network File System (NFS) file
1303
+ # server. DataSync can use this location as a source or destination for
1304
+ # transferring data.
1288
1305
  #
1289
- # For more information, see [Configuring transfers to or from an NFS
1290
- # file server][1].
1306
+ # Before you begin, make sure that you understand how DataSync [accesses
1307
+ # NFS file servers][1].
1291
1308
  #
1292
1309
  # <note markdown="1"> If you're copying data to or from an Snowcone device, you can also
1293
1310
  # use `CreateLocationNfs` to create your transfer location. For more
@@ -1297,7 +1314,7 @@ module Aws::DataSync
1297
1314
  #
1298
1315
  #
1299
1316
  #
1300
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html
1317
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs
1301
1318
  # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/nfs-on-snowcone.html
1302
1319
  #
1303
1320
  # @option params [required, String] :subdirectory
@@ -1372,13 +1389,16 @@ module Aws::DataSync
1372
1389
  req.send_request(options)
1373
1390
  end
1374
1391
 
1375
- # Creates an endpoint for an object storage system that DataSync can
1376
- # access for a transfer. For more information, see [Creating a location
1377
- # for object storage][1].
1392
+ # Creates a transfer *location* for an object storage system. DataSync
1393
+ # can use this location as a source or destination for transferring
1394
+ # data.
1378
1395
  #
1396
+ # Before you begin, make sure that you understand the [prerequisites][1]
1397
+ # for DataSync to work with object storage systems.
1379
1398
  #
1380
1399
  #
1381
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html
1400
+ #
1401
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html#create-object-location-prerequisites
1382
1402
  #
1383
1403
  # @option params [required, String] :server_hostname
1384
1404
  # Specifies the domain name or IP address of the object storage server.
@@ -1475,72 +1495,93 @@ module Aws::DataSync
1475
1495
  req.send_request(options)
1476
1496
  end
1477
1497
 
1478
- # A *location* is an endpoint for an Amazon S3 bucket. DataSync can use
1479
- # the location as a source or destination for copying data.
1498
+ # Creates a transfer *location* for an Amazon S3 bucket. DataSync can
1499
+ # use this location as a source or destination for transferring data.
1480
1500
  #
1481
- # Before you create your location, make sure that you read the following
1482
- # sections:
1501
+ # Before you begin, make sure that you read the following topics:
1483
1502
  #
1484
1503
  # * [Storage class considerations with Amazon S3 locations][1]
1485
1504
  #
1486
1505
  # * [Evaluating S3 request costs when using DataSync][2]
1487
1506
  #
1488
- # For more information, see [Creating an Amazon S3 location][3].
1507
+ # For more information, see [Configuring transfers with Amazon S3][3].
1489
1508
  #
1490
1509
  #
1491
1510
  #
1492
1511
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
1493
1512
  # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests
1494
- # [3]: https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli
1513
+ # [3]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html
1495
1514
  #
1496
1515
  # @option params [String] :subdirectory
1497
- # A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3
1498
- # is used to read data from the S3 source location or write data to the
1499
- # S3 destination.
1516
+ # Specifies a prefix in the S3 bucket that DataSync reads from or writes
1517
+ # to (depending on whether the bucket is a source or destination
1518
+ # location).
1519
+ #
1520
+ # <note markdown="1"> DataSync can't transfer objects with a prefix that begins with a
1521
+ # slash (`/`) or includes `//`, `/./`, or `/../` patterns. For example:
1522
+ #
1523
+ # * `/photos`
1524
+ #
1525
+ # * `photos//2006/January`
1526
+ #
1527
+ # * `photos/./2006/February`
1528
+ #
1529
+ # * `photos/../2006/March`
1530
+ #
1531
+ # </note>
1500
1532
  #
1501
1533
  # @option params [required, String] :s3_bucket_arn
1502
- # The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web
1503
- # Services Outpost, this must be an access point ARN.
1534
+ # Specifies the ARN of the S3 bucket that you want to use as a location.
1535
+ # (When creating your DataSync task later, you specify whether this
1536
+ # location is a transfer source or destination.)
1537
+ #
1538
+ # If your S3 bucket is located on an Outposts resource, you must specify
1539
+ # an Amazon S3 access point. For more information, see [Managing data
1540
+ # access with Amazon S3 access points][1] in the *Amazon S3 User Guide*.
1541
+ #
1542
+ #
1543
+ #
1544
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html
1504
1545
  #
1505
1546
  # @option params [String] :s3_storage_class
1506
- # The Amazon S3 storage class that you want to store your files in when
1507
- # this location is used as a task destination. For buckets in Amazon Web
1508
- # Services Regions, the storage class defaults to Standard. For buckets
1509
- # on Outposts, the storage class defaults to Amazon Web Services S3
1510
- # Outposts.
1547
+ # Specifies the storage class that you want your objects to use when
1548
+ # Amazon S3 is a transfer destination.
1549
+ #
1550
+ # For buckets in Amazon Web Services Regions, the storage class defaults
1551
+ # to `STANDARD`. For buckets on Outposts, the storage class defaults to
1552
+ # `OUTPOSTS`.
1511
1553
  #
1512
- # For more information about S3 storage classes, see [Amazon S3 Storage
1513
- # Classes][1]. Some storage classes have behaviors that can affect your
1514
- # S3 storage cost. For detailed information, see [Considerations when
1515
- # working with S3 storage classes in DataSync][2].
1554
+ # For more information, see [Storage class considerations with Amazon S3
1555
+ # transfers][1].
1516
1556
  #
1517
1557
  #
1518
1558
  #
1519
- # [1]: http://aws.amazon.com/s3/storage-classes/
1520
- # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
1559
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
1521
1560
  #
1522
1561
  # @option params [required, Types::S3Config] :s3_config
1523
- # The Amazon Resource Name (ARN) of the Identity and Access Management
1524
- # (IAM) role used to access an Amazon S3 bucket.
1562
+ # Specifies the Amazon Resource Name (ARN) of the Identity and Access
1563
+ # Management (IAM) role that DataSync uses to access your S3 bucket.
1525
1564
  #
1526
- # For detailed information about using such a role, see Creating a
1527
- # Location for Amazon S3 in the *DataSync User Guide*.
1565
+ # For more information, see [Accessing S3 buckets][1].
1566
+ #
1567
+ #
1568
+ #
1569
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access
1528
1570
  #
1529
1571
  # @option params [Array<String>] :agent_arns
1530
- # If you're using DataSync on an Amazon Web Services Outpost, specify
1531
- # the Amazon Resource Names (ARNs) of the DataSync agents deployed on
1532
- # your Outpost. For more information about launching a DataSync agent on
1533
- # an Amazon Web Services Outpost, see [Deploy your DataSync agent on
1534
- # Outposts][1].
1572
+ # (Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN)
1573
+ # of the DataSync agent on your Outpost.
1574
+ #
1575
+ # For more information, see [Deploy your DataSync agent on Outposts][1].
1535
1576
  #
1536
1577
  #
1537
1578
  #
1538
1579
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent
1539
1580
  #
1540
1581
  # @option params [Array<Types::TagListEntry>] :tags
1541
- # The key-value pair that represents the tag that you want to add to the
1542
- # location. The value can be an empty string. We recommend using tags to
1543
- # name your resources.
1582
+ # Specifies labels that help you categorize, filter, and search for your
1583
+ # Amazon Web Services resources. We recommend creating at least a name
1584
+ # tag for your transfer location.
1544
1585
  #
1545
1586
  # @return [Types::CreateLocationS3Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1546
1587
  #
@@ -1577,15 +1618,16 @@ module Aws::DataSync
1577
1618
  req.send_request(options)
1578
1619
  end
1579
1620
 
1580
- # Creates an endpoint for a Server Message Block (SMB) file server that
1581
- # DataSync can use for a data transfer.
1621
+ # Creates a transfer *location* for a Server Message Block (SMB) file
1622
+ # server. DataSync can use this location as a source or destination for
1623
+ # transferring data.
1582
1624
  #
1583
1625
  # Before you begin, make sure that you understand how DataSync [accesses
1584
- # an SMB file server][1].
1626
+ # SMB file servers][1].
1585
1627
  #
1586
1628
  #
1587
1629
  #
1588
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html
1630
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb
1589
1631
  #
1590
1632
  # @option params [required, String] :subdirectory
1591
1633
  # Specifies the name of the share exported by your SMB file server where
@@ -1593,9 +1635,9 @@ module Aws::DataSync
1593
1635
  # the share path (for example, `/path/to/subdirectory`). Make sure that
1594
1636
  # other SMB clients in your network can also mount this path.
1595
1637
  #
1596
- # To copy all data in the specified subdirectory, DataSync must be able
1597
- # to mount the SMB share and access all of its data. For more
1598
- # information, see [required permissions][1] for SMB locations.
1638
+ # To copy all data in the subdirectory, DataSync must be able to mount
1639
+ # the SMB share and access all of its data. For more information, see
1640
+ # [required permissions][1] for SMB locations.
1599
1641
  #
1600
1642
  #
1601
1643
  #
@@ -1610,8 +1652,8 @@ module Aws::DataSync
1610
1652
  # </note>
1611
1653
  #
1612
1654
  # @option params [required, String] :user
1613
- # Specifies the user name that can mount your SMB file server and has
1614
- # permission to access the files and folders involved in your transfer.
1655
+ # Specifies the user that can mount and access the files, folders, and
1656
+ # file metadata in your SMB file server.
1615
1657
  #
1616
1658
  # For information about choosing a user with the right level of access
1617
1659
  # for your transfer, see [required permissions][1] for SMB locations.
@@ -1621,17 +1663,12 @@ module Aws::DataSync
1621
1663
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
1622
1664
  #
1623
1665
  # @option params [String] :domain
1624
- # Specifies the Windows domain name that your SMB file server belongs
1625
- # to.
1626
- #
1627
- # If you have multiple domains in your environment, configuring this
1628
- # parameter makes sure that DataSync connects to the right file server.
1629
- #
1630
- # For more information, see [required permissions][1] for SMB locations.
1631
- #
1666
+ # Specifies the name of the Active Directory domain that your SMB file
1667
+ # server belongs to.
1632
1668
  #
1633
- #
1634
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
1669
+ # If you have multiple Active Directory domains in your environment,
1670
+ # configuring this parameter makes sure that DataSync connects to the
1671
+ # right file server.
1635
1672
  #
1636
1673
  # @option params [required, String] :password
1637
1674
  # Specifies the password of the user who can mount your SMB file server
@@ -1772,9 +1809,35 @@ module Aws::DataSync
1772
1809
  #
1773
1810
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
1774
1811
  #
1812
+ # @option params [Types::ManifestConfig] :manifest_config
1813
+ # Configures a manifest, which is a list of files or objects that you
1814
+ # want DataSync to transfer. For more information and configuration
1815
+ # examples, see [Specifying what DataSync transfers by using a
1816
+ # manifest][1].
1817
+ #
1818
+ # When using this parameter, your caller identity (the role that you're
1819
+ # using DataSync with) must have the `iam:PassRole` permission. The
1820
+ # [AWSDataSyncFullAccess][2] policy includes this permission.
1821
+ #
1822
+ #
1823
+ #
1824
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
1825
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
1826
+ #
1775
1827
  # @option params [Types::TaskReportConfig] :task_report_config
1776
1828
  # Specifies how you want to configure a task report, which provides
1777
- # detailed information about for your DataSync transfer.
1829
+ # detailed information about your DataSync transfer. For more
1830
+ # information, see [Monitoring your DataSync transfers with task
1831
+ # reports][1].
1832
+ #
1833
+ # When using this parameter, your caller identity (the role that you're
1834
+ # using DataSync with) must have the `iam:PassRole` permission. The
1835
+ # [AWSDataSyncFullAccess][2] policy includes this permission.
1836
+ #
1837
+ #
1838
+ #
1839
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
1840
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
1778
1841
  #
1779
1842
  # @return [Types::CreateTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1780
1843
  #
@@ -1825,6 +1888,18 @@ module Aws::DataSync
1825
1888
  # value: "FilterValue",
1826
1889
  # },
1827
1890
  # ],
1891
+ # manifest_config: {
1892
+ # action: "TRANSFER", # accepts TRANSFER
1893
+ # format: "CSV", # accepts CSV
1894
+ # source: {
1895
+ # s3: { # required
1896
+ # manifest_object_path: "S3Subdirectory", # required
1897
+ # bucket_access_role_arn: "IamRoleArn", # required
1898
+ # s3_bucket_arn: "S3BucketArn", # required
1899
+ # manifest_object_version_id: "S3ObjectVersionId",
1900
+ # },
1901
+ # },
1902
+ # },
1828
1903
  # task_report_config: {
1829
1904
  # destination: {
1830
1905
  # s3: {
@@ -1901,7 +1976,7 @@ module Aws::DataSync
1901
1976
  req.send_request(options)
1902
1977
  end
1903
1978
 
1904
- # Deletes the configuration of a location used by DataSync.
1979
+ # Deletes a transfer location resource from DataSync.
1905
1980
  #
1906
1981
  # @option params [required, String] :location_arn
1907
1982
  # The Amazon Resource Name (ARN) of the location to delete.
@@ -1923,7 +1998,7 @@ module Aws::DataSync
1923
1998
  req.send_request(options)
1924
1999
  end
1925
2000
 
1926
- # Deletes an DataSync transfer task.
2001
+ # Deletes a transfer task resource from DataSync.
1927
2002
  #
1928
2003
  # @option params [required, String] :task_arn
1929
2004
  # Specifies the Amazon Resource Name (ARN) of the task that you want to
@@ -2077,8 +2152,8 @@ module Aws::DataSync
2077
2152
  req.send_request(options)
2078
2153
  end
2079
2154
 
2080
- # Returns metadata about your DataSync location for an Amazon EFS file
2081
- # system.
2155
+ # Provides details about how an DataSync transfer location for an Amazon
2156
+ # EFS file system is configured.
2082
2157
  #
2083
2158
  # @option params [required, String] :location_arn
2084
2159
  # The Amazon Resource Name (ARN) of the Amazon EFS file system location
@@ -2121,8 +2196,8 @@ module Aws::DataSync
2121
2196
  req.send_request(options)
2122
2197
  end
2123
2198
 
2124
- # Provides details about how an DataSync location for an Amazon FSx for
2125
- # Lustre file system is configured.
2199
+ # Provides details about how an DataSync transfer location for an Amazon
2200
+ # FSx for Lustre file system is configured.
2126
2201
  #
2127
2202
  # @option params [required, String] :location_arn
2128
2203
  # The Amazon Resource Name (ARN) of the FSx for Lustre location to
@@ -2158,8 +2233,8 @@ module Aws::DataSync
2158
2233
  req.send_request(options)
2159
2234
  end
2160
2235
 
2161
- # Provides details about how an DataSync location for an Amazon FSx for
2162
- # NetApp ONTAP file system is configured.
2236
+ # Provides details about how an DataSync transfer location for an Amazon
2237
+ # FSx for NetApp ONTAP file system is configured.
2163
2238
  #
2164
2239
  # <note markdown="1"> If your location uses SMB, the `DescribeLocationFsxOntap` operation
2165
2240
  # doesn't actually return a `Password`.
@@ -2210,8 +2285,8 @@ module Aws::DataSync
2210
2285
  req.send_request(options)
2211
2286
  end
2212
2287
 
2213
- # Provides details about how an DataSync location for an Amazon FSx for
2214
- # OpenZFS file system is configured.
2288
+ # Provides details about how an DataSync transfer location for an Amazon
2289
+ # FSx for OpenZFS file system is configured.
2215
2290
  #
2216
2291
  # <note markdown="1"> Response elements related to `SMB` aren't supported with the
2217
2292
  # `DescribeLocationFsxOpenZfs` operation.
@@ -2258,12 +2333,12 @@ module Aws::DataSync
2258
2333
  req.send_request(options)
2259
2334
  end
2260
2335
 
2261
- # Returns metadata about an Amazon FSx for Windows File Server location,
2262
- # such as information about its path.
2336
+ # Provides details about how an DataSync transfer location for an Amazon
2337
+ # FSx for Windows File Server file system is configured.
2263
2338
  #
2264
2339
  # @option params [required, String] :location_arn
2265
- # The Amazon Resource Name (ARN) of the FSx for Windows File Server
2266
- # location to describe.
2340
+ # Specifies the Amazon Resource Name (ARN) of the FSx for Windows File
2341
+ # Server location.
2267
2342
  #
2268
2343
  # @return [Types::DescribeLocationFsxWindowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2269
2344
  #
@@ -2299,12 +2374,11 @@ module Aws::DataSync
2299
2374
  req.send_request(options)
2300
2375
  end
2301
2376
 
2302
- # Returns metadata, such as the authentication information about the
2303
- # Hadoop Distributed File System (HDFS) location.
2377
+ # Provides details about how an DataSync transfer location for a Hadoop
2378
+ # Distributed File System (HDFS) is configured.
2304
2379
  #
2305
2380
  # @option params [required, String] :location_arn
2306
- # The Amazon Resource Name (ARN) of the HDFS cluster location to
2307
- # describe.
2381
+ # Specifies the Amazon Resource Name (ARN) of the HDFS location.
2308
2382
  #
2309
2383
  # @return [Types::DescribeLocationHdfsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2310
2384
  #
@@ -2394,12 +2468,12 @@ module Aws::DataSync
2394
2468
  req.send_request(options)
2395
2469
  end
2396
2470
 
2397
- # Returns metadata about your DataSync location for an object storage
2398
- # system.
2471
+ # Provides details about how an DataSync transfer location for an object
2472
+ # storage system is configured.
2399
2473
  #
2400
2474
  # @option params [required, String] :location_arn
2401
- # The Amazon Resource Name (ARN) of the object storage system location
2402
- # that you want information about.
2475
+ # Specifies the Amazon Resource Name (ARN) of the object storage system
2476
+ # location.
2403
2477
  #
2404
2478
  # @return [Types::DescribeLocationObjectStorageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2405
2479
  #
@@ -2439,12 +2513,11 @@ module Aws::DataSync
2439
2513
  req.send_request(options)
2440
2514
  end
2441
2515
 
2442
- # Returns metadata, such as bucket name, about an Amazon S3 bucket
2443
- # location.
2516
+ # Provides details about how an DataSync transfer location for an S3
2517
+ # bucket is configured.
2444
2518
  #
2445
2519
  # @option params [required, String] :location_arn
2446
- # The Amazon Resource Name (ARN) of the Amazon S3 bucket location to
2447
- # describe.
2520
+ # Specifies the Amazon Resource Name (ARN) of the Amazon S3 location.
2448
2521
  #
2449
2522
  # @return [Types::DescribeLocationS3Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2450
2523
  #
@@ -2480,11 +2553,12 @@ module Aws::DataSync
2480
2553
  req.send_request(options)
2481
2554
  end
2482
2555
 
2483
- # Returns metadata, such as the path and user information about an SMB
2484
- # location.
2556
+ # Provides details about how an DataSync transfer location for a Server
2557
+ # Message Block (SMB) file server is configured.
2485
2558
  #
2486
2559
  # @option params [required, String] :location_arn
2487
- # The Amazon Resource Name (ARN) of the SMB location to describe.
2560
+ # Specifies the Amazon Resource Name (ARN) of the SMB location that you
2561
+ # want information about.
2488
2562
  #
2489
2563
  # @return [Types::DescribeLocationSmbResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2490
2564
  #
@@ -2828,6 +2902,7 @@ module Aws::DataSync
2828
2902
  # * {Types::DescribeTaskResponse#error_detail #error_detail} => String
2829
2903
  # * {Types::DescribeTaskResponse#creation_time #creation_time} => Time
2830
2904
  # * {Types::DescribeTaskResponse#includes #includes} => Array&lt;Types::FilterRule&gt;
2905
+ # * {Types::DescribeTaskResponse#manifest_config #manifest_config} => Types::ManifestConfig
2831
2906
  # * {Types::DescribeTaskResponse#task_report_config #task_report_config} => Types::TaskReportConfig
2832
2907
  #
2833
2908
  # @example Request syntax with placeholder values
@@ -2874,6 +2949,12 @@ module Aws::DataSync
2874
2949
  # resp.includes #=> Array
2875
2950
  # resp.includes[0].filter_type #=> String, one of "SIMPLE_PATTERN"
2876
2951
  # resp.includes[0].value #=> String
2952
+ # resp.manifest_config.action #=> String, one of "TRANSFER"
2953
+ # resp.manifest_config.format #=> String, one of "CSV"
2954
+ # resp.manifest_config.source.s3.manifest_object_path #=> String
2955
+ # resp.manifest_config.source.s3.bucket_access_role_arn #=> String
2956
+ # resp.manifest_config.source.s3.s3_bucket_arn #=> String
2957
+ # resp.manifest_config.source.s3.manifest_object_version_id #=> String
2877
2958
  # resp.task_report_config.destination.s3.subdirectory #=> String
2878
2959
  # resp.task_report_config.destination.s3.s3_bucket_arn #=> String
2879
2960
  # resp.task_report_config.destination.s3.bucket_access_role_arn #=> String
@@ -2909,14 +2990,15 @@ module Aws::DataSync
2909
2990
  # * {Types::DescribeTaskExecutionResponse#options #options} => Types::Options
2910
2991
  # * {Types::DescribeTaskExecutionResponse#excludes #excludes} => Array&lt;Types::FilterRule&gt;
2911
2992
  # * {Types::DescribeTaskExecutionResponse#includes #includes} => Array&lt;Types::FilterRule&gt;
2993
+ # * {Types::DescribeTaskExecutionResponse#manifest_config #manifest_config} => Types::ManifestConfig
2912
2994
  # * {Types::DescribeTaskExecutionResponse#start_time #start_time} => Time
2913
2995
  # * {Types::DescribeTaskExecutionResponse#estimated_files_to_transfer #estimated_files_to_transfer} => Integer
2914
2996
  # * {Types::DescribeTaskExecutionResponse#estimated_bytes_to_transfer #estimated_bytes_to_transfer} => Integer
2915
2997
  # * {Types::DescribeTaskExecutionResponse#files_transferred #files_transferred} => Integer
2916
2998
  # * {Types::DescribeTaskExecutionResponse#bytes_written #bytes_written} => Integer
2917
2999
  # * {Types::DescribeTaskExecutionResponse#bytes_transferred #bytes_transferred} => Integer
2918
- # * {Types::DescribeTaskExecutionResponse#result #result} => Types::TaskExecutionResultDetail
2919
3000
  # * {Types::DescribeTaskExecutionResponse#bytes_compressed #bytes_compressed} => Integer
3001
+ # * {Types::DescribeTaskExecutionResponse#result #result} => Types::TaskExecutionResultDetail
2920
3002
  # * {Types::DescribeTaskExecutionResponse#task_report_config #task_report_config} => Types::TaskReportConfig
2921
3003
  # * {Types::DescribeTaskExecutionResponse#files_deleted #files_deleted} => Integer
2922
3004
  # * {Types::DescribeTaskExecutionResponse#files_skipped #files_skipped} => Integer
@@ -2955,12 +3037,19 @@ module Aws::DataSync
2955
3037
  # resp.includes #=> Array
2956
3038
  # resp.includes[0].filter_type #=> String, one of "SIMPLE_PATTERN"
2957
3039
  # resp.includes[0].value #=> String
3040
+ # resp.manifest_config.action #=> String, one of "TRANSFER"
3041
+ # resp.manifest_config.format #=> String, one of "CSV"
3042
+ # resp.manifest_config.source.s3.manifest_object_path #=> String
3043
+ # resp.manifest_config.source.s3.bucket_access_role_arn #=> String
3044
+ # resp.manifest_config.source.s3.s3_bucket_arn #=> String
3045
+ # resp.manifest_config.source.s3.manifest_object_version_id #=> String
2958
3046
  # resp.start_time #=> Time
2959
3047
  # resp.estimated_files_to_transfer #=> Integer
2960
3048
  # resp.estimated_bytes_to_transfer #=> Integer
2961
3049
  # resp.files_transferred #=> Integer
2962
3050
  # resp.bytes_written #=> Integer
2963
3051
  # resp.bytes_transferred #=> Integer
3052
+ # resp.bytes_compressed #=> Integer
2964
3053
  # resp.result.prepare_duration #=> Integer
2965
3054
  # resp.result.prepare_status #=> String, one of "PENDING", "SUCCESS", "ERROR"
2966
3055
  # resp.result.total_duration #=> Integer
@@ -2970,7 +3059,6 @@ module Aws::DataSync
2970
3059
  # resp.result.verify_status #=> String, one of "PENDING", "SUCCESS", "ERROR"
2971
3060
  # resp.result.error_code #=> String
2972
3061
  # resp.result.error_detail #=> String
2973
- # resp.bytes_compressed #=> Integer
2974
3062
  # resp.task_report_config.destination.s3.subdirectory #=> String
2975
3063
  # resp.task_report_config.destination.s3.s3_bucket_arn #=> String
2976
3064
  # resp.task_report_config.destination.s3.bucket_access_role_arn #=> String
@@ -3293,18 +3381,18 @@ module Aws::DataSync
3293
3381
  req.send_request(options)
3294
3382
  end
3295
3383
 
3296
- # Returns a list of executed tasks.
3384
+ # Returns a list of executions for an DataSync transfer task.
3297
3385
  #
3298
3386
  # @option params [String] :task_arn
3299
- # The Amazon Resource Name (ARN) of the task whose tasks you want to
3300
- # list.
3387
+ # Specifies the Amazon Resource Name (ARN) of the task that you want
3388
+ # execution information about.
3301
3389
  #
3302
3390
  # @option params [Integer] :max_results
3303
- # The maximum number of executed tasks to list.
3391
+ # Specifies how many results you want in the response.
3304
3392
  #
3305
3393
  # @option params [String] :next_token
3306
- # An opaque string that indicates the position at which to begin the
3307
- # next list of the executed tasks.
3394
+ # Specifies an opaque string that indicates the position at which to
3395
+ # begin the next list of results in the response.
3308
3396
  #
3309
3397
  # @return [Types::ListTaskExecutionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3310
3398
  #
@@ -3522,6 +3610,42 @@ module Aws::DataSync
3522
3610
  # consists of the patterns to exclude. The patterns are delimited by
3523
3611
  # "\|" (that is, a pipe), for example, `"/folder1|/folder2"`.
3524
3612
  #
3613
+ # @option params [Types::ManifestConfig] :manifest_config
3614
+ # Configures a manifest, which is a list of files or objects that you
3615
+ # want DataSync to transfer. For more information and configuration
3616
+ # examples, see [Specifying what DataSync transfers by using a
3617
+ # manifest][1].
3618
+ #
3619
+ # When using this parameter, your caller identity (the role that you're
3620
+ # using DataSync with) must have the `iam:PassRole` permission. The
3621
+ # [AWSDataSyncFullAccess][2] policy includes this permission.
3622
+ #
3623
+ # To remove a manifest configuration, specify this parameter with an
3624
+ # empty value.
3625
+ #
3626
+ #
3627
+ #
3628
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
3629
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
3630
+ #
3631
+ # @option params [Types::TaskReportConfig] :task_report_config
3632
+ # Specifies how you want to configure a task report, which provides
3633
+ # detailed information about your DataSync transfer. For more
3634
+ # information, see [Monitoring your DataSync transfers with task
3635
+ # reports][1].
3636
+ #
3637
+ # When using this parameter, your caller identity (the role that you're
3638
+ # using DataSync with) must have the `iam:PassRole` permission. The
3639
+ # [AWSDataSyncFullAccess][2] policy includes this permission.
3640
+ #
3641
+ # To remove a task report configuration, specify this parameter as
3642
+ # empty.
3643
+ #
3644
+ #
3645
+ #
3646
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
3647
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
3648
+ #
3525
3649
  # @option params [Array<Types::TagListEntry>] :tags
3526
3650
  # Specifies the tags that you want to apply to the Amazon Resource Name
3527
3651
  # (ARN) representing the task execution.
@@ -3529,10 +3653,6 @@ module Aws::DataSync
3529
3653
  # *Tags* are key-value pairs that help you manage, filter, and search
3530
3654
  # for your DataSync resources.
3531
3655
  #
3532
- # @option params [Types::TaskReportConfig] :task_report_config
3533
- # Specifies how you want to configure a task report, which provides
3534
- # detailed information about for your DataSync transfer.
3535
- #
3536
3656
  # @return [Types::StartTaskExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3537
3657
  #
3538
3658
  # * {Types::StartTaskExecutionResponse#task_execution_arn #task_execution_arn} => String
@@ -3570,12 +3690,18 @@ module Aws::DataSync
3570
3690
  # value: "FilterValue",
3571
3691
  # },
3572
3692
  # ],
3573
- # tags: [
3574
- # {
3575
- # key: "TagKey", # required
3576
- # value: "TagValue",
3693
+ # manifest_config: {
3694
+ # action: "TRANSFER", # accepts TRANSFER
3695
+ # format: "CSV", # accepts CSV
3696
+ # source: {
3697
+ # s3: { # required
3698
+ # manifest_object_path: "S3Subdirectory", # required
3699
+ # bucket_access_role_arn: "IamRoleArn", # required
3700
+ # s3_bucket_arn: "S3BucketArn", # required
3701
+ # manifest_object_version_id: "S3ObjectVersionId",
3702
+ # },
3577
3703
  # },
3578
- # ],
3704
+ # },
3579
3705
  # task_report_config: {
3580
3706
  # destination: {
3581
3707
  # s3: {
@@ -3602,6 +3728,12 @@ module Aws::DataSync
3602
3728
  # },
3603
3729
  # },
3604
3730
  # },
3731
+ # tags: [
3732
+ # {
3733
+ # key: "TagKey", # required
3734
+ # value: "TagValue",
3735
+ # },
3736
+ # ],
3605
3737
  # })
3606
3738
  #
3607
3739
  # @example Response structure
@@ -4215,7 +4347,7 @@ module Aws::DataSync
4215
4347
  req.send_request(options)
4216
4348
  end
4217
4349
 
4218
- # Updates the configuration of a DataSync transfer task.
4350
+ # Updates the configuration of an DataSync transfer task.
4219
4351
  #
4220
4352
  # @option params [required, String] :task_arn
4221
4353
  # The Amazon Resource Name (ARN) of the resource name of the task to
@@ -4267,9 +4399,40 @@ module Aws::DataSync
4267
4399
  #
4268
4400
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
4269
4401
  #
4402
+ # @option params [Types::ManifestConfig] :manifest_config
4403
+ # Configures a manifest, which is a list of files or objects that you
4404
+ # want DataSync to transfer. For more information and configuration
4405
+ # examples, see [Specifying what DataSync transfers by using a
4406
+ # manifest][1].
4407
+ #
4408
+ # When using this parameter, your caller identity (the IAM role that
4409
+ # you're using DataSync with) must have the `iam:PassRole` permission.
4410
+ # The [AWSDataSyncFullAccess][2] policy includes this permission.
4411
+ #
4412
+ # To remove a manifest configuration, specify this parameter as empty.
4413
+ #
4414
+ #
4415
+ #
4416
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
4417
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
4418
+ #
4270
4419
  # @option params [Types::TaskReportConfig] :task_report_config
4271
4420
  # Specifies how you want to configure a task report, which provides
4272
- # detailed information about for your DataSync transfer.
4421
+ # detailed information about your DataSync transfer. For more
4422
+ # information, see [Monitoring your DataSync transfers with task
4423
+ # reports][1].
4424
+ #
4425
+ # When using this parameter, your caller identity (the IAM role that
4426
+ # you're using DataSync with) must have the `iam:PassRole` permission.
4427
+ # The [AWSDataSyncFullAccess][2] policy includes this permission.
4428
+ #
4429
+ # To remove a task report configuration, specify this parameter as
4430
+ # empty.
4431
+ #
4432
+ #
4433
+ #
4434
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
4435
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
4273
4436
  #
4274
4437
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4275
4438
  #
@@ -4311,6 +4474,18 @@ module Aws::DataSync
4311
4474
  # value: "FilterValue",
4312
4475
  # },
4313
4476
  # ],
4477
+ # manifest_config: {
4478
+ # action: "TRANSFER", # accepts TRANSFER
4479
+ # format: "CSV", # accepts CSV
4480
+ # source: {
4481
+ # s3: { # required
4482
+ # manifest_object_path: "S3Subdirectory", # required
4483
+ # bucket_access_role_arn: "IamRoleArn", # required
4484
+ # s3_bucket_arn: "S3BucketArn", # required
4485
+ # manifest_object_version_id: "S3ObjectVersionId",
4486
+ # },
4487
+ # },
4488
+ # },
4314
4489
  # task_report_config: {
4315
4490
  # destination: {
4316
4491
  # s3: {
@@ -4416,7 +4591,7 @@ module Aws::DataSync
4416
4591
  params: params,
4417
4592
  config: config)
4418
4593
  context[:gem_name] = 'aws-sdk-datasync'
4419
- context[:gem_version] = '1.72.0'
4594
+ context[:gem_version] = '1.73.0'
4420
4595
  Seahorse::Client::Request.new(handlers, context)
4421
4596
  end
4422
4597