aws-sdk-datasync 1.72.0 → 1.74.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-datasync/client.rb +401 -206
- data/lib/aws-sdk-datasync/client_api.rb +38 -2
- data/lib/aws-sdk-datasync/types.rb +762 -421
- data/lib/aws-sdk-datasync.rb +1 -1
- data/sig/client.rbs +51 -10
- data/sig/types.rbs +36 -2
- metadata +2 -2
|
@@ -615,8 +615,9 @@ module Aws::DataSync
|
|
|
615
615
|
req.send_request(options)
|
|
616
616
|
end
|
|
617
617
|
|
|
618
|
-
# Creates
|
|
619
|
-
# DataSync can use as a transfer source or
|
|
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
|
|
723
|
-
#
|
|
724
|
-
#
|
|
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
|
|
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
|
|
860
|
-
#
|
|
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
|
-
#
|
|
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
|
|
962
|
-
# DataSync can
|
|
963
|
-
#
|
|
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
|
|
1042
|
-
# system
|
|
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
|
-
#
|
|
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
|
|
1082
|
-
# and metadata in your file
|
|
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
|
|
1094
|
-
# Server belongs to.
|
|
1112
|
+
# Specifies the name of the Microsoft Active Directory domain that the
|
|
1113
|
+
# FSx for Windows File Server file system belongs to.
|
|
1095
1114
|
#
|
|
1096
|
-
# If you have multiple domains in your environment,
|
|
1097
|
-
# parameter makes sure that DataSync connects to the
|
|
1098
|
-
#
|
|
1099
|
-
# For more information, see [required permissions][1] for FSx for
|
|
1100
|
-
# Windows File Server locations.
|
|
1101
|
-
#
|
|
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
|
|
1108
|
-
# files and
|
|
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
|
|
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
|
|
1287
|
-
# DataSync can use
|
|
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
|
-
#
|
|
1290
|
-
# file
|
|
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
|
|
1376
|
-
#
|
|
1377
|
-
#
|
|
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
|
-
#
|
|
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
|
-
#
|
|
1479
|
-
#
|
|
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
|
|
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 [
|
|
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-
|
|
1513
|
+
# [3]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html
|
|
1495
1514
|
#
|
|
1496
1515
|
# @option params [String] :subdirectory
|
|
1497
|
-
#
|
|
1498
|
-
#
|
|
1499
|
-
#
|
|
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
|
-
#
|
|
1503
|
-
#
|
|
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
|
-
#
|
|
1507
|
-
#
|
|
1508
|
-
#
|
|
1509
|
-
#
|
|
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
|
|
1513
|
-
#
|
|
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]:
|
|
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
|
-
#
|
|
1524
|
-
# (IAM) role
|
|
1562
|
+
# Specifies the Amazon Resource Name (ARN) of the Identity and Access
|
|
1563
|
+
# Management (IAM) role that DataSync uses to access your S3 bucket.
|
|
1564
|
+
#
|
|
1565
|
+
# For more information, see [Accessing S3 buckets][1].
|
|
1566
|
+
#
|
|
1567
|
+
#
|
|
1525
1568
|
#
|
|
1526
|
-
#
|
|
1527
|
-
# Location for Amazon S3 in the *DataSync User Guide*.
|
|
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
|
-
#
|
|
1531
|
-
#
|
|
1532
|
-
#
|
|
1533
|
-
#
|
|
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
|
-
#
|
|
1542
|
-
#
|
|
1543
|
-
#
|
|
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
|
|
1581
|
-
# DataSync can use
|
|
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
|
-
#
|
|
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
|
|
1597
|
-
#
|
|
1598
|
-
#
|
|
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
|
|
1614
|
-
#
|
|
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
|
|
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
|
-
#
|
|
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
|
|
@@ -1695,12 +1732,11 @@ module Aws::DataSync
|
|
|
1695
1732
|
req.send_request(options)
|
|
1696
1733
|
end
|
|
1697
1734
|
|
|
1698
|
-
# Configures a
|
|
1735
|
+
# Configures a *task*, which defines where and how DataSync transfers
|
|
1699
1736
|
# your data.
|
|
1700
1737
|
#
|
|
1701
|
-
# A task includes a source location, destination location, and
|
|
1702
|
-
# options
|
|
1703
|
-
# bandwidth limits, scheduling, among other options).
|
|
1738
|
+
# A task includes a source location, destination location, and transfer
|
|
1739
|
+
# options (such as bandwidth limits, scheduling, and more).
|
|
1704
1740
|
#
|
|
1705
1741
|
# If you're planning to transfer data to or from an Amazon S3 location,
|
|
1706
1742
|
# review [how DataSync can affect your S3 request charges][1] and the
|
|
@@ -1712,69 +1748,85 @@ module Aws::DataSync
|
|
|
1712
1748
|
# [2]: http://aws.amazon.com/datasync/pricing/
|
|
1713
1749
|
#
|
|
1714
1750
|
# @option params [required, String] :source_location_arn
|
|
1715
|
-
#
|
|
1751
|
+
# Specifies the ARN of your transfer's source location.
|
|
1716
1752
|
#
|
|
1717
1753
|
# @option params [required, String] :destination_location_arn
|
|
1718
|
-
#
|
|
1719
|
-
# resource's location.
|
|
1754
|
+
# Specifies the ARN of your transfer's destination location.
|
|
1720
1755
|
#
|
|
1721
1756
|
# @option params [String] :cloud_watch_log_group_arn
|
|
1722
|
-
#
|
|
1723
|
-
#
|
|
1757
|
+
# Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log
|
|
1758
|
+
# group for monitoring your task.
|
|
1724
1759
|
#
|
|
1725
1760
|
# @option params [String] :name
|
|
1726
|
-
#
|
|
1727
|
-
# identify the task in the console.
|
|
1761
|
+
# Specifies the name of your task.
|
|
1728
1762
|
#
|
|
1729
1763
|
# @option params [Types::Options] :options
|
|
1730
|
-
# Specifies
|
|
1731
|
-
#
|
|
1732
|
-
#
|
|
1733
|
-
# You can also override these options before starting an individual run
|
|
1734
|
-
# of a task (also known as a *task execution*). For more information,
|
|
1735
|
-
# see [StartTaskExecution][1].
|
|
1736
|
-
#
|
|
1737
|
-
#
|
|
1738
|
-
#
|
|
1739
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
|
1764
|
+
# Specifies your task's settings, such as preserving file metadata,
|
|
1765
|
+
# verifying data integrity, among other options.
|
|
1740
1766
|
#
|
|
1741
1767
|
# @option params [Array<Types::FilterRule>] :excludes
|
|
1742
|
-
# Specifies
|
|
1743
|
-
# your
|
|
1744
|
-
#
|
|
1768
|
+
# Specifies exclude filters that define the files, objects, and folders
|
|
1769
|
+
# in your source location that you don't want DataSync to transfer. For
|
|
1770
|
+
# more information and examples, see [Specifying what DataSync transfers
|
|
1771
|
+
# by using filters][1].
|
|
1745
1772
|
#
|
|
1746
1773
|
#
|
|
1747
1774
|
#
|
|
1748
1775
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
|
1749
1776
|
#
|
|
1750
1777
|
# @option params [Types::TaskSchedule] :schedule
|
|
1751
|
-
# Specifies a schedule
|
|
1752
|
-
#
|
|
1753
|
-
# time. For more information, see [Scheduling your task][1].
|
|
1778
|
+
# Specifies a schedule for when you want your task to run. For more
|
|
1779
|
+
# information, see [Scheduling your task][1].
|
|
1754
1780
|
#
|
|
1755
1781
|
#
|
|
1756
1782
|
#
|
|
1757
1783
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
|
|
1758
1784
|
#
|
|
1759
1785
|
# @option params [Array<Types::TagListEntry>] :tags
|
|
1760
|
-
# Specifies the tags that you want to apply to
|
|
1761
|
-
# (ARN) representing the task.
|
|
1786
|
+
# Specifies the tags that you want to apply to your task.
|
|
1762
1787
|
#
|
|
1763
1788
|
# *Tags* are key-value pairs that help you manage, filter, and search
|
|
1764
1789
|
# for your DataSync resources.
|
|
1765
1790
|
#
|
|
1766
1791
|
# @option params [Array<Types::FilterRule>] :includes
|
|
1767
|
-
# Specifies
|
|
1768
|
-
# your
|
|
1769
|
-
#
|
|
1792
|
+
# Specifies include filters define the files, objects, and folders in
|
|
1793
|
+
# your source location that you want DataSync to transfer. For more
|
|
1794
|
+
# information and examples, see [Specifying what DataSync transfers by
|
|
1795
|
+
# using filters][1].
|
|
1770
1796
|
#
|
|
1771
1797
|
#
|
|
1772
1798
|
#
|
|
1773
1799
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
|
1774
1800
|
#
|
|
1801
|
+
# @option params [Types::ManifestConfig] :manifest_config
|
|
1802
|
+
# Configures a manifest, which is a list of files or objects that you
|
|
1803
|
+
# want DataSync to transfer. For more information and configuration
|
|
1804
|
+
# examples, see [Specifying what DataSync transfers by using a
|
|
1805
|
+
# manifest][1].
|
|
1806
|
+
#
|
|
1807
|
+
# When using this parameter, your caller identity (the role that you're
|
|
1808
|
+
# using DataSync with) must have the `iam:PassRole` permission. The
|
|
1809
|
+
# [AWSDataSyncFullAccess][2] policy includes this permission.
|
|
1810
|
+
#
|
|
1811
|
+
#
|
|
1812
|
+
#
|
|
1813
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
|
|
1814
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
|
|
1815
|
+
#
|
|
1775
1816
|
# @option params [Types::TaskReportConfig] :task_report_config
|
|
1776
1817
|
# Specifies how you want to configure a task report, which provides
|
|
1777
|
-
# detailed information about
|
|
1818
|
+
# detailed information about your DataSync transfer. For more
|
|
1819
|
+
# information, see [Monitoring your DataSync transfers with task
|
|
1820
|
+
# reports][1].
|
|
1821
|
+
#
|
|
1822
|
+
# When using this parameter, your caller identity (the role that you're
|
|
1823
|
+
# using DataSync with) must have the `iam:PassRole` permission. The
|
|
1824
|
+
# [AWSDataSyncFullAccess][2] policy includes this permission.
|
|
1825
|
+
#
|
|
1826
|
+
#
|
|
1827
|
+
#
|
|
1828
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
|
|
1829
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
|
|
1778
1830
|
#
|
|
1779
1831
|
# @return [Types::CreateTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1780
1832
|
#
|
|
@@ -1812,6 +1864,7 @@ module Aws::DataSync
|
|
|
1812
1864
|
# ],
|
|
1813
1865
|
# schedule: {
|
|
1814
1866
|
# schedule_expression: "ScheduleExpressionCron", # required
|
|
1867
|
+
# status: "ENABLED", # accepts ENABLED, DISABLED
|
|
1815
1868
|
# },
|
|
1816
1869
|
# tags: [
|
|
1817
1870
|
# {
|
|
@@ -1825,6 +1878,18 @@ module Aws::DataSync
|
|
|
1825
1878
|
# value: "FilterValue",
|
|
1826
1879
|
# },
|
|
1827
1880
|
# ],
|
|
1881
|
+
# manifest_config: {
|
|
1882
|
+
# action: "TRANSFER", # accepts TRANSFER
|
|
1883
|
+
# format: "CSV", # accepts CSV
|
|
1884
|
+
# source: {
|
|
1885
|
+
# s3: { # required
|
|
1886
|
+
# manifest_object_path: "S3Subdirectory", # required
|
|
1887
|
+
# bucket_access_role_arn: "IamRoleArn", # required
|
|
1888
|
+
# s3_bucket_arn: "S3BucketArn", # required
|
|
1889
|
+
# manifest_object_version_id: "S3ObjectVersionId",
|
|
1890
|
+
# },
|
|
1891
|
+
# },
|
|
1892
|
+
# },
|
|
1828
1893
|
# task_report_config: {
|
|
1829
1894
|
# destination: {
|
|
1830
1895
|
# s3: {
|
|
@@ -1901,7 +1966,7 @@ module Aws::DataSync
|
|
|
1901
1966
|
req.send_request(options)
|
|
1902
1967
|
end
|
|
1903
1968
|
|
|
1904
|
-
# Deletes
|
|
1969
|
+
# Deletes a transfer location resource from DataSync.
|
|
1905
1970
|
#
|
|
1906
1971
|
# @option params [required, String] :location_arn
|
|
1907
1972
|
# The Amazon Resource Name (ARN) of the location to delete.
|
|
@@ -1923,7 +1988,7 @@ module Aws::DataSync
|
|
|
1923
1988
|
req.send_request(options)
|
|
1924
1989
|
end
|
|
1925
1990
|
|
|
1926
|
-
# Deletes
|
|
1991
|
+
# Deletes a transfer task resource from DataSync.
|
|
1927
1992
|
#
|
|
1928
1993
|
# @option params [required, String] :task_arn
|
|
1929
1994
|
# Specifies the Amazon Resource Name (ARN) of the task that you want to
|
|
@@ -2077,8 +2142,8 @@ module Aws::DataSync
|
|
|
2077
2142
|
req.send_request(options)
|
|
2078
2143
|
end
|
|
2079
2144
|
|
|
2080
|
-
#
|
|
2081
|
-
# system.
|
|
2145
|
+
# Provides details about how an DataSync transfer location for an Amazon
|
|
2146
|
+
# EFS file system is configured.
|
|
2082
2147
|
#
|
|
2083
2148
|
# @option params [required, String] :location_arn
|
|
2084
2149
|
# The Amazon Resource Name (ARN) of the Amazon EFS file system location
|
|
@@ -2121,8 +2186,8 @@ module Aws::DataSync
|
|
|
2121
2186
|
req.send_request(options)
|
|
2122
2187
|
end
|
|
2123
2188
|
|
|
2124
|
-
# Provides details about how an DataSync location for an Amazon
|
|
2125
|
-
# Lustre file system is configured.
|
|
2189
|
+
# Provides details about how an DataSync transfer location for an Amazon
|
|
2190
|
+
# FSx for Lustre file system is configured.
|
|
2126
2191
|
#
|
|
2127
2192
|
# @option params [required, String] :location_arn
|
|
2128
2193
|
# The Amazon Resource Name (ARN) of the FSx for Lustre location to
|
|
@@ -2158,8 +2223,8 @@ module Aws::DataSync
|
|
|
2158
2223
|
req.send_request(options)
|
|
2159
2224
|
end
|
|
2160
2225
|
|
|
2161
|
-
# Provides details about how an DataSync location for an Amazon
|
|
2162
|
-
# NetApp ONTAP file system is configured.
|
|
2226
|
+
# Provides details about how an DataSync transfer location for an Amazon
|
|
2227
|
+
# FSx for NetApp ONTAP file system is configured.
|
|
2163
2228
|
#
|
|
2164
2229
|
# <note markdown="1"> If your location uses SMB, the `DescribeLocationFsxOntap` operation
|
|
2165
2230
|
# doesn't actually return a `Password`.
|
|
@@ -2210,8 +2275,8 @@ module Aws::DataSync
|
|
|
2210
2275
|
req.send_request(options)
|
|
2211
2276
|
end
|
|
2212
2277
|
|
|
2213
|
-
# Provides details about how an DataSync location for an Amazon
|
|
2214
|
-
# OpenZFS file system is configured.
|
|
2278
|
+
# Provides details about how an DataSync transfer location for an Amazon
|
|
2279
|
+
# FSx for OpenZFS file system is configured.
|
|
2215
2280
|
#
|
|
2216
2281
|
# <note markdown="1"> Response elements related to `SMB` aren't supported with the
|
|
2217
2282
|
# `DescribeLocationFsxOpenZfs` operation.
|
|
@@ -2258,12 +2323,12 @@ module Aws::DataSync
|
|
|
2258
2323
|
req.send_request(options)
|
|
2259
2324
|
end
|
|
2260
2325
|
|
|
2261
|
-
#
|
|
2262
|
-
#
|
|
2326
|
+
# Provides details about how an DataSync transfer location for an Amazon
|
|
2327
|
+
# FSx for Windows File Server file system is configured.
|
|
2263
2328
|
#
|
|
2264
2329
|
# @option params [required, String] :location_arn
|
|
2265
|
-
#
|
|
2266
|
-
# location
|
|
2330
|
+
# Specifies the Amazon Resource Name (ARN) of the FSx for Windows File
|
|
2331
|
+
# Server location.
|
|
2267
2332
|
#
|
|
2268
2333
|
# @return [Types::DescribeLocationFsxWindowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2269
2334
|
#
|
|
@@ -2299,12 +2364,11 @@ module Aws::DataSync
|
|
|
2299
2364
|
req.send_request(options)
|
|
2300
2365
|
end
|
|
2301
2366
|
|
|
2302
|
-
#
|
|
2303
|
-
#
|
|
2367
|
+
# Provides details about how an DataSync transfer location for a Hadoop
|
|
2368
|
+
# Distributed File System (HDFS) is configured.
|
|
2304
2369
|
#
|
|
2305
2370
|
# @option params [required, String] :location_arn
|
|
2306
|
-
#
|
|
2307
|
-
# describe.
|
|
2371
|
+
# Specifies the Amazon Resource Name (ARN) of the HDFS location.
|
|
2308
2372
|
#
|
|
2309
2373
|
# @return [Types::DescribeLocationHdfsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2310
2374
|
#
|
|
@@ -2394,12 +2458,12 @@ module Aws::DataSync
|
|
|
2394
2458
|
req.send_request(options)
|
|
2395
2459
|
end
|
|
2396
2460
|
|
|
2397
|
-
#
|
|
2398
|
-
# system.
|
|
2461
|
+
# Provides details about how an DataSync transfer location for an object
|
|
2462
|
+
# storage system is configured.
|
|
2399
2463
|
#
|
|
2400
2464
|
# @option params [required, String] :location_arn
|
|
2401
|
-
#
|
|
2402
|
-
#
|
|
2465
|
+
# Specifies the Amazon Resource Name (ARN) of the object storage system
|
|
2466
|
+
# location.
|
|
2403
2467
|
#
|
|
2404
2468
|
# @return [Types::DescribeLocationObjectStorageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2405
2469
|
#
|
|
@@ -2439,12 +2503,11 @@ module Aws::DataSync
|
|
|
2439
2503
|
req.send_request(options)
|
|
2440
2504
|
end
|
|
2441
2505
|
|
|
2442
|
-
#
|
|
2443
|
-
#
|
|
2506
|
+
# Provides details about how an DataSync transfer location for an S3
|
|
2507
|
+
# bucket is configured.
|
|
2444
2508
|
#
|
|
2445
2509
|
# @option params [required, String] :location_arn
|
|
2446
|
-
#
|
|
2447
|
-
# describe.
|
|
2510
|
+
# Specifies the Amazon Resource Name (ARN) of the Amazon S3 location.
|
|
2448
2511
|
#
|
|
2449
2512
|
# @return [Types::DescribeLocationS3Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2450
2513
|
#
|
|
@@ -2480,11 +2543,12 @@ module Aws::DataSync
|
|
|
2480
2543
|
req.send_request(options)
|
|
2481
2544
|
end
|
|
2482
2545
|
|
|
2483
|
-
#
|
|
2484
|
-
#
|
|
2546
|
+
# Provides details about how an DataSync transfer location for a Server
|
|
2547
|
+
# Message Block (SMB) file server is configured.
|
|
2485
2548
|
#
|
|
2486
2549
|
# @option params [required, String] :location_arn
|
|
2487
|
-
#
|
|
2550
|
+
# Specifies the Amazon Resource Name (ARN) of the SMB location that you
|
|
2551
|
+
# want information about.
|
|
2488
2552
|
#
|
|
2489
2553
|
# @return [Types::DescribeLocationSmbResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2490
2554
|
#
|
|
@@ -2805,10 +2869,12 @@ module Aws::DataSync
|
|
|
2805
2869
|
req.send_request(options)
|
|
2806
2870
|
end
|
|
2807
2871
|
|
|
2808
|
-
# Provides information about
|
|
2872
|
+
# Provides information about a *task*, which defines where and how
|
|
2873
|
+
# DataSync transfers your data.
|
|
2809
2874
|
#
|
|
2810
2875
|
# @option params [required, String] :task_arn
|
|
2811
|
-
# Specifies the Amazon Resource Name (ARN) of the transfer task
|
|
2876
|
+
# Specifies the Amazon Resource Name (ARN) of the transfer task that you
|
|
2877
|
+
# want information about.
|
|
2812
2878
|
#
|
|
2813
2879
|
# @return [Types::DescribeTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2814
2880
|
#
|
|
@@ -2828,7 +2894,9 @@ module Aws::DataSync
|
|
|
2828
2894
|
# * {Types::DescribeTaskResponse#error_detail #error_detail} => String
|
|
2829
2895
|
# * {Types::DescribeTaskResponse#creation_time #creation_time} => Time
|
|
2830
2896
|
# * {Types::DescribeTaskResponse#includes #includes} => Array<Types::FilterRule>
|
|
2897
|
+
# * {Types::DescribeTaskResponse#manifest_config #manifest_config} => Types::ManifestConfig
|
|
2831
2898
|
# * {Types::DescribeTaskResponse#task_report_config #task_report_config} => Types::TaskReportConfig
|
|
2899
|
+
# * {Types::DescribeTaskResponse#schedule_details #schedule_details} => Types::TaskScheduleDetails
|
|
2832
2900
|
#
|
|
2833
2901
|
# @example Request syntax with placeholder values
|
|
2834
2902
|
#
|
|
@@ -2868,12 +2936,19 @@ module Aws::DataSync
|
|
|
2868
2936
|
# resp.excludes[0].filter_type #=> String, one of "SIMPLE_PATTERN"
|
|
2869
2937
|
# resp.excludes[0].value #=> String
|
|
2870
2938
|
# resp.schedule.schedule_expression #=> String
|
|
2939
|
+
# resp.schedule.status #=> String, one of "ENABLED", "DISABLED"
|
|
2871
2940
|
# resp.error_code #=> String
|
|
2872
2941
|
# resp.error_detail #=> String
|
|
2873
2942
|
# resp.creation_time #=> Time
|
|
2874
2943
|
# resp.includes #=> Array
|
|
2875
2944
|
# resp.includes[0].filter_type #=> String, one of "SIMPLE_PATTERN"
|
|
2876
2945
|
# resp.includes[0].value #=> String
|
|
2946
|
+
# resp.manifest_config.action #=> String, one of "TRANSFER"
|
|
2947
|
+
# resp.manifest_config.format #=> String, one of "CSV"
|
|
2948
|
+
# resp.manifest_config.source.s3.manifest_object_path #=> String
|
|
2949
|
+
# resp.manifest_config.source.s3.bucket_access_role_arn #=> String
|
|
2950
|
+
# resp.manifest_config.source.s3.s3_bucket_arn #=> String
|
|
2951
|
+
# resp.manifest_config.source.s3.manifest_object_version_id #=> String
|
|
2877
2952
|
# resp.task_report_config.destination.s3.subdirectory #=> String
|
|
2878
2953
|
# resp.task_report_config.destination.s3.s3_bucket_arn #=> String
|
|
2879
2954
|
# resp.task_report_config.destination.s3.bucket_access_role_arn #=> String
|
|
@@ -2884,6 +2959,9 @@ module Aws::DataSync
|
|
|
2884
2959
|
# resp.task_report_config.overrides.verified.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
|
|
2885
2960
|
# resp.task_report_config.overrides.deleted.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
|
|
2886
2961
|
# resp.task_report_config.overrides.skipped.report_level #=> String, one of "ERRORS_ONLY", "SUCCESSES_AND_ERRORS"
|
|
2962
|
+
# resp.schedule_details.status_update_time #=> Time
|
|
2963
|
+
# resp.schedule_details.disabled_reason #=> String
|
|
2964
|
+
# resp.schedule_details.disabled_by #=> String, one of "USER", "SERVICE"
|
|
2887
2965
|
#
|
|
2888
2966
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTask AWS API Documentation
|
|
2889
2967
|
#
|
|
@@ -2909,14 +2987,15 @@ module Aws::DataSync
|
|
|
2909
2987
|
# * {Types::DescribeTaskExecutionResponse#options #options} => Types::Options
|
|
2910
2988
|
# * {Types::DescribeTaskExecutionResponse#excludes #excludes} => Array<Types::FilterRule>
|
|
2911
2989
|
# * {Types::DescribeTaskExecutionResponse#includes #includes} => Array<Types::FilterRule>
|
|
2990
|
+
# * {Types::DescribeTaskExecutionResponse#manifest_config #manifest_config} => Types::ManifestConfig
|
|
2912
2991
|
# * {Types::DescribeTaskExecutionResponse#start_time #start_time} => Time
|
|
2913
2992
|
# * {Types::DescribeTaskExecutionResponse#estimated_files_to_transfer #estimated_files_to_transfer} => Integer
|
|
2914
2993
|
# * {Types::DescribeTaskExecutionResponse#estimated_bytes_to_transfer #estimated_bytes_to_transfer} => Integer
|
|
2915
2994
|
# * {Types::DescribeTaskExecutionResponse#files_transferred #files_transferred} => Integer
|
|
2916
2995
|
# * {Types::DescribeTaskExecutionResponse#bytes_written #bytes_written} => Integer
|
|
2917
2996
|
# * {Types::DescribeTaskExecutionResponse#bytes_transferred #bytes_transferred} => Integer
|
|
2918
|
-
# * {Types::DescribeTaskExecutionResponse#result #result} => Types::TaskExecutionResultDetail
|
|
2919
2997
|
# * {Types::DescribeTaskExecutionResponse#bytes_compressed #bytes_compressed} => Integer
|
|
2998
|
+
# * {Types::DescribeTaskExecutionResponse#result #result} => Types::TaskExecutionResultDetail
|
|
2920
2999
|
# * {Types::DescribeTaskExecutionResponse#task_report_config #task_report_config} => Types::TaskReportConfig
|
|
2921
3000
|
# * {Types::DescribeTaskExecutionResponse#files_deleted #files_deleted} => Integer
|
|
2922
3001
|
# * {Types::DescribeTaskExecutionResponse#files_skipped #files_skipped} => Integer
|
|
@@ -2955,12 +3034,19 @@ module Aws::DataSync
|
|
|
2955
3034
|
# resp.includes #=> Array
|
|
2956
3035
|
# resp.includes[0].filter_type #=> String, one of "SIMPLE_PATTERN"
|
|
2957
3036
|
# resp.includes[0].value #=> String
|
|
3037
|
+
# resp.manifest_config.action #=> String, one of "TRANSFER"
|
|
3038
|
+
# resp.manifest_config.format #=> String, one of "CSV"
|
|
3039
|
+
# resp.manifest_config.source.s3.manifest_object_path #=> String
|
|
3040
|
+
# resp.manifest_config.source.s3.bucket_access_role_arn #=> String
|
|
3041
|
+
# resp.manifest_config.source.s3.s3_bucket_arn #=> String
|
|
3042
|
+
# resp.manifest_config.source.s3.manifest_object_version_id #=> String
|
|
2958
3043
|
# resp.start_time #=> Time
|
|
2959
3044
|
# resp.estimated_files_to_transfer #=> Integer
|
|
2960
3045
|
# resp.estimated_bytes_to_transfer #=> Integer
|
|
2961
3046
|
# resp.files_transferred #=> Integer
|
|
2962
3047
|
# resp.bytes_written #=> Integer
|
|
2963
3048
|
# resp.bytes_transferred #=> Integer
|
|
3049
|
+
# resp.bytes_compressed #=> Integer
|
|
2964
3050
|
# resp.result.prepare_duration #=> Integer
|
|
2965
3051
|
# resp.result.prepare_status #=> String, one of "PENDING", "SUCCESS", "ERROR"
|
|
2966
3052
|
# resp.result.total_duration #=> Integer
|
|
@@ -2970,7 +3056,6 @@ module Aws::DataSync
|
|
|
2970
3056
|
# resp.result.verify_status #=> String, one of "PENDING", "SUCCESS", "ERROR"
|
|
2971
3057
|
# resp.result.error_code #=> String
|
|
2972
3058
|
# resp.result.error_detail #=> String
|
|
2973
|
-
# resp.bytes_compressed #=> Integer
|
|
2974
3059
|
# resp.task_report_config.destination.s3.subdirectory #=> String
|
|
2975
3060
|
# resp.task_report_config.destination.s3.s3_bucket_arn #=> String
|
|
2976
3061
|
# resp.task_report_config.destination.s3.bucket_access_role_arn #=> String
|
|
@@ -3293,18 +3378,18 @@ module Aws::DataSync
|
|
|
3293
3378
|
req.send_request(options)
|
|
3294
3379
|
end
|
|
3295
3380
|
|
|
3296
|
-
# Returns a list of
|
|
3381
|
+
# Returns a list of executions for an DataSync transfer task.
|
|
3297
3382
|
#
|
|
3298
3383
|
# @option params [String] :task_arn
|
|
3299
|
-
#
|
|
3300
|
-
#
|
|
3384
|
+
# Specifies the Amazon Resource Name (ARN) of the task that you want
|
|
3385
|
+
# execution information about.
|
|
3301
3386
|
#
|
|
3302
3387
|
# @option params [Integer] :max_results
|
|
3303
|
-
#
|
|
3388
|
+
# Specifies how many results you want in the response.
|
|
3304
3389
|
#
|
|
3305
3390
|
# @option params [String] :next_token
|
|
3306
|
-
#
|
|
3307
|
-
# next list of the
|
|
3391
|
+
# Specifies an opaque string that indicates the position at which to
|
|
3392
|
+
# begin the next list of results in the response.
|
|
3308
3393
|
#
|
|
3309
3394
|
# @return [Types::ListTaskExecutionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3310
3395
|
#
|
|
@@ -3507,7 +3592,15 @@ module Aws::DataSync
|
|
|
3507
3592
|
# integrity, set bandwidth limits for your task, among other options.
|
|
3508
3593
|
#
|
|
3509
3594
|
# Each option has a default value. Unless you need to, you don't have
|
|
3510
|
-
# to configure any
|
|
3595
|
+
# to configure any option before calling [StartTaskExecution][1].
|
|
3596
|
+
#
|
|
3597
|
+
# You also can override your task options for each task execution. For
|
|
3598
|
+
# example, you might want to adjust the `LogLevel` for an individual
|
|
3599
|
+
# execution.
|
|
3600
|
+
#
|
|
3601
|
+
#
|
|
3602
|
+
#
|
|
3603
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
|
3511
3604
|
#
|
|
3512
3605
|
# @option params [Array<Types::FilterRule>] :includes
|
|
3513
3606
|
# Specifies a list of filter rules that determines which files to
|
|
@@ -3522,6 +3615,42 @@ module Aws::DataSync
|
|
|
3522
3615
|
# consists of the patterns to exclude. The patterns are delimited by
|
|
3523
3616
|
# "\|" (that is, a pipe), for example, `"/folder1|/folder2"`.
|
|
3524
3617
|
#
|
|
3618
|
+
# @option params [Types::ManifestConfig] :manifest_config
|
|
3619
|
+
# Configures a manifest, which is a list of files or objects that you
|
|
3620
|
+
# want DataSync to transfer. For more information and configuration
|
|
3621
|
+
# examples, see [Specifying what DataSync transfers by using a
|
|
3622
|
+
# manifest][1].
|
|
3623
|
+
#
|
|
3624
|
+
# When using this parameter, your caller identity (the role that you're
|
|
3625
|
+
# using DataSync with) must have the `iam:PassRole` permission. The
|
|
3626
|
+
# [AWSDataSyncFullAccess][2] policy includes this permission.
|
|
3627
|
+
#
|
|
3628
|
+
# To remove a manifest configuration, specify this parameter with an
|
|
3629
|
+
# empty value.
|
|
3630
|
+
#
|
|
3631
|
+
#
|
|
3632
|
+
#
|
|
3633
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
|
|
3634
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
|
|
3635
|
+
#
|
|
3636
|
+
# @option params [Types::TaskReportConfig] :task_report_config
|
|
3637
|
+
# Specifies how you want to configure a task report, which provides
|
|
3638
|
+
# detailed information about your DataSync transfer. For more
|
|
3639
|
+
# information, see [Monitoring your DataSync transfers with task
|
|
3640
|
+
# reports][1].
|
|
3641
|
+
#
|
|
3642
|
+
# When using this parameter, your caller identity (the role that you're
|
|
3643
|
+
# using DataSync with) must have the `iam:PassRole` permission. The
|
|
3644
|
+
# [AWSDataSyncFullAccess][2] policy includes this permission.
|
|
3645
|
+
#
|
|
3646
|
+
# To remove a task report configuration, specify this parameter as
|
|
3647
|
+
# empty.
|
|
3648
|
+
#
|
|
3649
|
+
#
|
|
3650
|
+
#
|
|
3651
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
|
|
3652
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
|
|
3653
|
+
#
|
|
3525
3654
|
# @option params [Array<Types::TagListEntry>] :tags
|
|
3526
3655
|
# Specifies the tags that you want to apply to the Amazon Resource Name
|
|
3527
3656
|
# (ARN) representing the task execution.
|
|
@@ -3529,10 +3658,6 @@ module Aws::DataSync
|
|
|
3529
3658
|
# *Tags* are key-value pairs that help you manage, filter, and search
|
|
3530
3659
|
# for your DataSync resources.
|
|
3531
3660
|
#
|
|
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
3661
|
# @return [Types::StartTaskExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3537
3662
|
#
|
|
3538
3663
|
# * {Types::StartTaskExecutionResponse#task_execution_arn #task_execution_arn} => String
|
|
@@ -3570,12 +3695,18 @@ module Aws::DataSync
|
|
|
3570
3695
|
# value: "FilterValue",
|
|
3571
3696
|
# },
|
|
3572
3697
|
# ],
|
|
3573
|
-
#
|
|
3574
|
-
#
|
|
3575
|
-
#
|
|
3576
|
-
#
|
|
3698
|
+
# manifest_config: {
|
|
3699
|
+
# action: "TRANSFER", # accepts TRANSFER
|
|
3700
|
+
# format: "CSV", # accepts CSV
|
|
3701
|
+
# source: {
|
|
3702
|
+
# s3: { # required
|
|
3703
|
+
# manifest_object_path: "S3Subdirectory", # required
|
|
3704
|
+
# bucket_access_role_arn: "IamRoleArn", # required
|
|
3705
|
+
# s3_bucket_arn: "S3BucketArn", # required
|
|
3706
|
+
# manifest_object_version_id: "S3ObjectVersionId",
|
|
3707
|
+
# },
|
|
3577
3708
|
# },
|
|
3578
|
-
#
|
|
3709
|
+
# },
|
|
3579
3710
|
# task_report_config: {
|
|
3580
3711
|
# destination: {
|
|
3581
3712
|
# s3: {
|
|
@@ -3602,6 +3733,12 @@ module Aws::DataSync
|
|
|
3602
3733
|
# },
|
|
3603
3734
|
# },
|
|
3604
3735
|
# },
|
|
3736
|
+
# tags: [
|
|
3737
|
+
# {
|
|
3738
|
+
# key: "TagKey", # required
|
|
3739
|
+
# value: "TagValue",
|
|
3740
|
+
# },
|
|
3741
|
+
# ],
|
|
3605
3742
|
# })
|
|
3606
3743
|
#
|
|
3607
3744
|
# @example Response structure
|
|
@@ -4215,11 +4352,11 @@ module Aws::DataSync
|
|
|
4215
4352
|
req.send_request(options)
|
|
4216
4353
|
end
|
|
4217
4354
|
|
|
4218
|
-
# Updates the configuration of a
|
|
4355
|
+
# Updates the configuration of a *task*, which defines where and how
|
|
4356
|
+
# DataSync transfers your data.
|
|
4219
4357
|
#
|
|
4220
4358
|
# @option params [required, String] :task_arn
|
|
4221
|
-
#
|
|
4222
|
-
# update.
|
|
4359
|
+
# Specifies the ARN of the task that you want to update.
|
|
4223
4360
|
#
|
|
4224
4361
|
# @option params [Types::Options] :options
|
|
4225
4362
|
# Indicates how your transfer task is configured. These options include
|
|
@@ -4228,48 +4365,85 @@ module Aws::DataSync
|
|
|
4228
4365
|
# integrity, set bandwidth limits for your task, among other options.
|
|
4229
4366
|
#
|
|
4230
4367
|
# Each option has a default value. Unless you need to, you don't have
|
|
4231
|
-
# to configure any
|
|
4368
|
+
# to configure any option before calling [StartTaskExecution][1].
|
|
4369
|
+
#
|
|
4370
|
+
# You also can override your task options for each task execution. For
|
|
4371
|
+
# example, you might want to adjust the `LogLevel` for an individual
|
|
4372
|
+
# execution.
|
|
4373
|
+
#
|
|
4374
|
+
#
|
|
4375
|
+
#
|
|
4376
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
|
4232
4377
|
#
|
|
4233
4378
|
# @option params [Array<Types::FilterRule>] :excludes
|
|
4234
|
-
# Specifies
|
|
4235
|
-
# your
|
|
4236
|
-
#
|
|
4379
|
+
# Specifies exclude filters that define the files, objects, and folders
|
|
4380
|
+
# in your source location that you don't want DataSync to transfer. For
|
|
4381
|
+
# more information and examples, see [Specifying what DataSync transfers
|
|
4382
|
+
# by using filters][1].
|
|
4237
4383
|
#
|
|
4238
4384
|
#
|
|
4239
4385
|
#
|
|
4240
4386
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
|
4241
4387
|
#
|
|
4242
4388
|
# @option params [Types::TaskSchedule] :schedule
|
|
4243
|
-
# Specifies a schedule
|
|
4244
|
-
#
|
|
4245
|
-
# hourly, daily, weekly or on specific days of the week. You control
|
|
4246
|
-
# when in the day or hour you want the task to execute. The time you
|
|
4247
|
-
# specify is UTC time. For more information, see [Scheduling your
|
|
4248
|
-
# task][1].
|
|
4389
|
+
# Specifies a schedule for when you want your task to run. For more
|
|
4390
|
+
# information, see [Scheduling your task][1].
|
|
4249
4391
|
#
|
|
4250
4392
|
#
|
|
4251
4393
|
#
|
|
4252
4394
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
|
|
4253
4395
|
#
|
|
4254
4396
|
# @option params [String] :name
|
|
4255
|
-
#
|
|
4397
|
+
# Specifies the name of your task.
|
|
4256
4398
|
#
|
|
4257
4399
|
# @option params [String] :cloud_watch_log_group_arn
|
|
4258
|
-
#
|
|
4259
|
-
#
|
|
4400
|
+
# Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log
|
|
4401
|
+
# group for monitoring your task.
|
|
4260
4402
|
#
|
|
4261
4403
|
# @option params [Array<Types::FilterRule>] :includes
|
|
4262
|
-
# Specifies
|
|
4263
|
-
# your
|
|
4264
|
-
#
|
|
4404
|
+
# Specifies include filters define the files, objects, and folders in
|
|
4405
|
+
# your source location that you want DataSync to transfer. For more
|
|
4406
|
+
# information and examples, see [Specifying what DataSync transfers by
|
|
4407
|
+
# using filters][1].
|
|
4265
4408
|
#
|
|
4266
4409
|
#
|
|
4267
4410
|
#
|
|
4268
4411
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
|
4269
4412
|
#
|
|
4413
|
+
# @option params [Types::ManifestConfig] :manifest_config
|
|
4414
|
+
# Configures a manifest, which is a list of files or objects that you
|
|
4415
|
+
# want DataSync to transfer. For more information and configuration
|
|
4416
|
+
# examples, see [Specifying what DataSync transfers by using a
|
|
4417
|
+
# manifest][1].
|
|
4418
|
+
#
|
|
4419
|
+
# When using this parameter, your caller identity (the IAM role that
|
|
4420
|
+
# you're using DataSync with) must have the `iam:PassRole` permission.
|
|
4421
|
+
# The [AWSDataSyncFullAccess][2] policy includes this permission.
|
|
4422
|
+
#
|
|
4423
|
+
# To remove a manifest configuration, specify this parameter as empty.
|
|
4424
|
+
#
|
|
4425
|
+
#
|
|
4426
|
+
#
|
|
4427
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
|
|
4428
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
|
|
4429
|
+
#
|
|
4270
4430
|
# @option params [Types::TaskReportConfig] :task_report_config
|
|
4271
4431
|
# Specifies how you want to configure a task report, which provides
|
|
4272
|
-
# detailed information about
|
|
4432
|
+
# detailed information about your DataSync transfer. For more
|
|
4433
|
+
# information, see [Monitoring your DataSync transfers with task
|
|
4434
|
+
# reports][1].
|
|
4435
|
+
#
|
|
4436
|
+
# When using this parameter, your caller identity (the IAM role that
|
|
4437
|
+
# you're using DataSync with) must have the `iam:PassRole` permission.
|
|
4438
|
+
# The [AWSDataSyncFullAccess][2] policy includes this permission.
|
|
4439
|
+
#
|
|
4440
|
+
# To remove a task report configuration, specify this parameter as
|
|
4441
|
+
# empty.
|
|
4442
|
+
#
|
|
4443
|
+
#
|
|
4444
|
+
#
|
|
4445
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html
|
|
4446
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
|
|
4273
4447
|
#
|
|
4274
4448
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
4275
4449
|
#
|
|
@@ -4302,6 +4476,7 @@ module Aws::DataSync
|
|
|
4302
4476
|
# ],
|
|
4303
4477
|
# schedule: {
|
|
4304
4478
|
# schedule_expression: "ScheduleExpressionCron", # required
|
|
4479
|
+
# status: "ENABLED", # accepts ENABLED, DISABLED
|
|
4305
4480
|
# },
|
|
4306
4481
|
# name: "TagValue",
|
|
4307
4482
|
# cloud_watch_log_group_arn: "LogGroupArn",
|
|
@@ -4311,6 +4486,18 @@ module Aws::DataSync
|
|
|
4311
4486
|
# value: "FilterValue",
|
|
4312
4487
|
# },
|
|
4313
4488
|
# ],
|
|
4489
|
+
# manifest_config: {
|
|
4490
|
+
# action: "TRANSFER", # accepts TRANSFER
|
|
4491
|
+
# format: "CSV", # accepts CSV
|
|
4492
|
+
# source: {
|
|
4493
|
+
# s3: { # required
|
|
4494
|
+
# manifest_object_path: "S3Subdirectory", # required
|
|
4495
|
+
# bucket_access_role_arn: "IamRoleArn", # required
|
|
4496
|
+
# s3_bucket_arn: "S3BucketArn", # required
|
|
4497
|
+
# manifest_object_version_id: "S3ObjectVersionId",
|
|
4498
|
+
# },
|
|
4499
|
+
# },
|
|
4500
|
+
# },
|
|
4314
4501
|
# task_report_config: {
|
|
4315
4502
|
# destination: {
|
|
4316
4503
|
# s3: {
|
|
@@ -4367,7 +4554,15 @@ module Aws::DataSync
|
|
|
4367
4554
|
# integrity, set bandwidth limits for your task, among other options.
|
|
4368
4555
|
#
|
|
4369
4556
|
# Each option has a default value. Unless you need to, you don't have
|
|
4370
|
-
# to configure any
|
|
4557
|
+
# to configure any option before calling [StartTaskExecution][1].
|
|
4558
|
+
#
|
|
4559
|
+
# You also can override your task options for each task execution. For
|
|
4560
|
+
# example, you might want to adjust the `LogLevel` for an individual
|
|
4561
|
+
# execution.
|
|
4562
|
+
#
|
|
4563
|
+
#
|
|
4564
|
+
#
|
|
4565
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
|
4371
4566
|
#
|
|
4372
4567
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
4373
4568
|
#
|
|
@@ -4416,7 +4611,7 @@ module Aws::DataSync
|
|
|
4416
4611
|
params: params,
|
|
4417
4612
|
config: config)
|
|
4418
4613
|
context[:gem_name] = 'aws-sdk-datasync'
|
|
4419
|
-
context[:gem_version] = '1.
|
|
4614
|
+
context[:gem_version] = '1.74.0'
|
|
4420
4615
|
Seahorse::Client::Request.new(handlers, context)
|
|
4421
4616
|
end
|
|
4422
4617
|
|