aws-sdk-datasync 1.90.0 → 1.92.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 +157 -72
- data/lib/aws-sdk-datasync/client_api.rb +21 -0
- data/lib/aws-sdk-datasync/types.rb +568 -165
- data/lib/aws-sdk-datasync.rb +1 -1
- data/sig/client.rbs +7 -1
- data/sig/types.rbs +22 -0
- metadata +2 -2
|
@@ -217,7 +217,7 @@ module Aws::DataSync
|
|
|
217
217
|
#
|
|
218
218
|
# @!attribute [rw] activation_key
|
|
219
219
|
# Specifies your DataSync agent's activation key. If you don't have
|
|
220
|
-
# an activation key, see [
|
|
220
|
+
# an activation key, see [Activating your agent][1].
|
|
221
221
|
#
|
|
222
222
|
#
|
|
223
223
|
#
|
|
@@ -225,8 +225,8 @@ module Aws::DataSync
|
|
|
225
225
|
# @return [String]
|
|
226
226
|
#
|
|
227
227
|
# @!attribute [rw] agent_name
|
|
228
|
-
# Specifies a name for your agent.
|
|
229
|
-
#
|
|
228
|
+
# Specifies a name for your agent. We recommend specifying a name that
|
|
229
|
+
# you can remember.
|
|
230
230
|
# @return [String]
|
|
231
231
|
#
|
|
232
232
|
# @!attribute [rw] tags
|
|
@@ -236,34 +236,27 @@ module Aws::DataSync
|
|
|
236
236
|
# @return [Array<Types::TagListEntry>]
|
|
237
237
|
#
|
|
238
238
|
# @!attribute [rw] vpc_endpoint_id
|
|
239
|
-
# Specifies the ID of the VPC endpoint that you
|
|
240
|
-
#
|
|
239
|
+
# Specifies the ID of the [VPC service endpoint][1] that you're
|
|
240
|
+
# using. For example, a VPC endpoint ID looks like
|
|
241
241
|
# `vpce-01234d5aff67890e1`.
|
|
242
242
|
#
|
|
243
|
-
# The VPC endpoint you use must include the DataSync service
|
|
244
|
-
# example, `com.amazonaws.us-east-2.datasync`).
|
|
245
|
-
# @return [String]
|
|
243
|
+
# The VPC service endpoint you use must include the DataSync service
|
|
244
|
+
# name (for example, `com.amazonaws.us-east-2.datasync`).
|
|
246
245
|
#
|
|
247
|
-
# @!attribute [rw] subnet_arns
|
|
248
|
-
# Specifies the ARN of the subnet where you want to run your DataSync
|
|
249
|
-
# task when using a VPC endpoint. This is the subnet where DataSync
|
|
250
|
-
# creates and manages the [network interfaces][1] for your transfer.
|
|
251
|
-
# You can only specify one ARN.
|
|
252
246
|
#
|
|
253
247
|
#
|
|
248
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#datasync-in-vpc
|
|
249
|
+
# @return [String]
|
|
254
250
|
#
|
|
255
|
-
#
|
|
251
|
+
# @!attribute [rw] subnet_arns
|
|
252
|
+
# Specifies the ARN of the subnet where your VPC service endpoint is
|
|
253
|
+
# located. You can only specify one ARN.
|
|
256
254
|
# @return [Array<String>]
|
|
257
255
|
#
|
|
258
256
|
# @!attribute [rw] security_group_arns
|
|
259
257
|
# Specifies the Amazon Resource Name (ARN) of the security group that
|
|
260
|
-
#
|
|
261
|
-
#
|
|
262
|
-
#
|
|
263
|
-
#
|
|
264
|
-
#
|
|
265
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces
|
|
266
|
-
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc
|
|
258
|
+
# allows traffic between your agent and VPC service endpoint. You can
|
|
259
|
+
# only specify one ARN.
|
|
267
260
|
# @return [Array<String>]
|
|
268
261
|
#
|
|
269
262
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateAgentRequest AWS API Documentation
|
|
@@ -393,22 +386,29 @@ module Aws::DataSync
|
|
|
393
386
|
# @!attribute [rw] subdirectory
|
|
394
387
|
# Specifies a mount path for your Amazon EFS file system. This is
|
|
395
388
|
# where DataSync reads or writes data (depending on if this is a
|
|
396
|
-
# source or destination location)
|
|
397
|
-
# directory, but you can also include subdirectories.
|
|
389
|
+
# source or destination location) on your file system.
|
|
398
390
|
#
|
|
399
|
-
#
|
|
391
|
+
# By default, DataSync uses the root directory (or [access point][1]
|
|
392
|
+
# if you provide one by using `AccessPointArn`). You can also include
|
|
393
|
+
# subdirectories using forward slashes (for example,
|
|
400
394
|
# `/path/to/folder`).
|
|
401
395
|
#
|
|
402
|
-
#
|
|
396
|
+
#
|
|
397
|
+
#
|
|
398
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html
|
|
403
399
|
# @return [String]
|
|
404
400
|
#
|
|
405
401
|
# @!attribute [rw] efs_filesystem_arn
|
|
406
|
-
# Specifies the ARN for
|
|
402
|
+
# Specifies the ARN for your Amazon EFS file system.
|
|
407
403
|
# @return [String]
|
|
408
404
|
#
|
|
409
405
|
# @!attribute [rw] ec2_config
|
|
410
|
-
# Specifies the subnet and security groups DataSync uses to
|
|
411
|
-
# your Amazon EFS file system.
|
|
406
|
+
# Specifies the subnet and security groups DataSync uses to connect to
|
|
407
|
+
# one of your Amazon EFS file system's [mount targets][1].
|
|
408
|
+
#
|
|
409
|
+
#
|
|
410
|
+
#
|
|
411
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html
|
|
412
412
|
# @return [Types::Ec2Config]
|
|
413
413
|
#
|
|
414
414
|
# @!attribute [rw] tags
|
|
@@ -420,18 +420,31 @@ module Aws::DataSync
|
|
|
420
420
|
#
|
|
421
421
|
# @!attribute [rw] access_point_arn
|
|
422
422
|
# Specifies the Amazon Resource Name (ARN) of the access point that
|
|
423
|
-
# DataSync uses to
|
|
423
|
+
# DataSync uses to mount your Amazon EFS file system.
|
|
424
|
+
#
|
|
425
|
+
# For more information, see [Accessing restricted file systems][1].
|
|
426
|
+
#
|
|
427
|
+
#
|
|
428
|
+
#
|
|
429
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam
|
|
424
430
|
# @return [String]
|
|
425
431
|
#
|
|
426
432
|
# @!attribute [rw] file_system_access_role_arn
|
|
427
|
-
# Specifies an Identity and Access Management (IAM) role that
|
|
428
|
-
#
|
|
433
|
+
# Specifies an Identity and Access Management (IAM) role that allows
|
|
434
|
+
# DataSync to access your Amazon EFS file system.
|
|
435
|
+
#
|
|
436
|
+
# For information on creating this role, see [Creating a DataSync IAM
|
|
437
|
+
# role for file system access][1].
|
|
438
|
+
#
|
|
439
|
+
#
|
|
440
|
+
#
|
|
441
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role
|
|
429
442
|
# @return [String]
|
|
430
443
|
#
|
|
431
444
|
# @!attribute [rw] in_transit_encryption
|
|
432
445
|
# Specifies whether you want DataSync to use Transport Layer Security
|
|
433
|
-
# (TLS) 1.2 encryption when it
|
|
434
|
-
# file system.
|
|
446
|
+
# (TLS) 1.2 encryption when it transfers data to or from your Amazon
|
|
447
|
+
# EFS file system.
|
|
435
448
|
#
|
|
436
449
|
# If you specify an access point using `AccessPointArn` or an IAM role
|
|
437
450
|
# using `FileSystemAccessRoleArn`, you must set this parameter to
|
|
@@ -652,8 +665,13 @@ module Aws::DataSync
|
|
|
652
665
|
# @return [String]
|
|
653
666
|
#
|
|
654
667
|
# @!attribute [rw] security_group_arns
|
|
655
|
-
# Specifies the ARNs of the security groups that provide
|
|
656
|
-
# your file system's preferred subnet.
|
|
668
|
+
# Specifies the ARNs of the Amazon EC2 security groups that provide
|
|
669
|
+
# access to your file system's preferred subnet.
|
|
670
|
+
#
|
|
671
|
+
# The security groups that you specify must be able to communicate
|
|
672
|
+
# with your file system's security groups. For information about
|
|
673
|
+
# configuring security groups for file system access, see the [
|
|
674
|
+
# *Amazon FSx for Windows File Server User Guide* ][1].
|
|
657
675
|
#
|
|
658
676
|
# <note markdown="1"> If you choose a security group that doesn't allow connections from
|
|
659
677
|
# within itself, do one of the following:
|
|
@@ -665,6 +683,10 @@ module Aws::DataSync
|
|
|
665
683
|
# mount target's security group.
|
|
666
684
|
#
|
|
667
685
|
# </note>
|
|
686
|
+
#
|
|
687
|
+
#
|
|
688
|
+
#
|
|
689
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html
|
|
668
690
|
# @return [Array<String>]
|
|
669
691
|
#
|
|
670
692
|
# @!attribute [rw] tags
|
|
@@ -818,8 +840,8 @@ module Aws::DataSync
|
|
|
818
840
|
# @return [String]
|
|
819
841
|
#
|
|
820
842
|
# @!attribute [rw] agent_arns
|
|
821
|
-
# The Amazon Resource Names (ARNs) of the agents that
|
|
822
|
-
# connect to
|
|
843
|
+
# The Amazon Resource Names (ARNs) of the DataSync agents that can
|
|
844
|
+
# connect to your HDFS cluster.
|
|
823
845
|
# @return [Array<String>]
|
|
824
846
|
#
|
|
825
847
|
# @!attribute [rw] tags
|
|
@@ -849,7 +871,7 @@ module Aws::DataSync
|
|
|
849
871
|
end
|
|
850
872
|
|
|
851
873
|
# @!attribute [rw] location_arn
|
|
852
|
-
# The ARN of the source HDFS cluster location that
|
|
874
|
+
# The ARN of the source HDFS cluster location that you create.
|
|
853
875
|
# @return [String]
|
|
854
876
|
#
|
|
855
877
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationHdfsResponse AWS API Documentation
|
|
@@ -882,14 +904,14 @@ module Aws::DataSync
|
|
|
882
904
|
#
|
|
883
905
|
# @!attribute [rw] on_prem_config
|
|
884
906
|
# Specifies the Amazon Resource Name (ARN) of the DataSync agent that
|
|
885
|
-
#
|
|
907
|
+
# can connect to your NFS file server.
|
|
886
908
|
#
|
|
887
909
|
# You can specify more than one agent. For more information, see
|
|
888
|
-
# [Using multiple agents
|
|
910
|
+
# [Using multiple DataSync agents][1].
|
|
889
911
|
#
|
|
890
912
|
#
|
|
891
913
|
#
|
|
892
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents
|
|
914
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#multiple-agents
|
|
893
915
|
# @return [Types::OnPremConfig]
|
|
894
916
|
#
|
|
895
917
|
# @!attribute [rw] mount_options
|
|
@@ -972,7 +994,7 @@ module Aws::DataSync
|
|
|
972
994
|
#
|
|
973
995
|
# @!attribute [rw] agent_arns
|
|
974
996
|
# Specifies the Amazon Resource Names (ARNs) of the DataSync agents
|
|
975
|
-
# that can
|
|
997
|
+
# that can connect with your object storage system.
|
|
976
998
|
# @return [Array<String>]
|
|
977
999
|
#
|
|
978
1000
|
# @!attribute [rw] tags
|
|
@@ -1211,9 +1233,9 @@ module Aws::DataSync
|
|
|
1211
1233
|
# @return [String]
|
|
1212
1234
|
#
|
|
1213
1235
|
# @!attribute [rw] agent_arns
|
|
1214
|
-
# Specifies the DataSync agent (or agents)
|
|
1215
|
-
#
|
|
1216
|
-
#
|
|
1236
|
+
# Specifies the DataSync agent (or agents) that can connect to your
|
|
1237
|
+
# SMB file server. You specify an agent by using its Amazon Resource
|
|
1238
|
+
# Name (ARN).
|
|
1217
1239
|
# @return [Array<String>]
|
|
1218
1240
|
#
|
|
1219
1241
|
# @!attribute [rw] mount_options
|
|
@@ -1269,6 +1291,10 @@ module Aws::DataSync
|
|
|
1269
1291
|
# @!attribute [rw] cloud_watch_log_group_arn
|
|
1270
1292
|
# Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log
|
|
1271
1293
|
# group for monitoring your task.
|
|
1294
|
+
#
|
|
1295
|
+
# For Enhanced mode tasks, you don't need to specify anything.
|
|
1296
|
+
# DataSync automatically sends logs to a CloudWatch log group named
|
|
1297
|
+
# `/aws/datasync`.
|
|
1272
1298
|
# @return [String]
|
|
1273
1299
|
#
|
|
1274
1300
|
# @!attribute [rw] name
|
|
@@ -1308,10 +1334,10 @@ module Aws::DataSync
|
|
|
1308
1334
|
# @return [Array<Types::TagListEntry>]
|
|
1309
1335
|
#
|
|
1310
1336
|
# @!attribute [rw] includes
|
|
1311
|
-
# Specifies include filters define the files, objects, and
|
|
1312
|
-
# your source location that you want DataSync to transfer.
|
|
1313
|
-
# information and examples, see [Specifying what DataSync
|
|
1314
|
-
# using filters][1].
|
|
1337
|
+
# Specifies include filters that define the files, objects, and
|
|
1338
|
+
# folders in your source location that you want DataSync to transfer.
|
|
1339
|
+
# For more information and examples, see [Specifying what DataSync
|
|
1340
|
+
# transfers by using filters][1].
|
|
1315
1341
|
#
|
|
1316
1342
|
#
|
|
1317
1343
|
#
|
|
@@ -1352,6 +1378,36 @@ module Aws::DataSync
|
|
|
1352
1378
|
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess
|
|
1353
1379
|
# @return [Types::TaskReportConfig]
|
|
1354
1380
|
#
|
|
1381
|
+
# @!attribute [rw] task_mode
|
|
1382
|
+
# Specifies one of the following task modes for your data transfer:
|
|
1383
|
+
#
|
|
1384
|
+
# * `ENHANCED` - Transfer virtually unlimited numbers of objects with
|
|
1385
|
+
# higher performance than Basic mode. Enhanced mode tasks optimize
|
|
1386
|
+
# the data transfer process by listing, preparing, transferring, and
|
|
1387
|
+
# verifying data in parallel. Enhanced mode is currently available
|
|
1388
|
+
# for transfers between Amazon S3 locations.
|
|
1389
|
+
#
|
|
1390
|
+
# <note markdown="1"> To create an Enhanced mode task, the IAM role that you use to call
|
|
1391
|
+
# the `CreateTask` operation must have the
|
|
1392
|
+
# `iam:CreateServiceLinkedRole` permission.
|
|
1393
|
+
#
|
|
1394
|
+
# </note>
|
|
1395
|
+
#
|
|
1396
|
+
# * `BASIC` (default) - Transfer files or objects between Amazon Web
|
|
1397
|
+
# Services storage and all other supported DataSync locations. Basic
|
|
1398
|
+
# mode tasks are subject to [quotas][1] on the number of files,
|
|
1399
|
+
# objects, and directories in a dataset. Basic mode sequentially
|
|
1400
|
+
# prepares, transfers, and verifies data, making it slower than
|
|
1401
|
+
# Enhanced mode for most workloads.
|
|
1402
|
+
#
|
|
1403
|
+
# For more information, see [Understanding task mode differences][2].
|
|
1404
|
+
#
|
|
1405
|
+
#
|
|
1406
|
+
#
|
|
1407
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/datasync-limits.html
|
|
1408
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences
|
|
1409
|
+
# @return [String]
|
|
1410
|
+
#
|
|
1355
1411
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateTaskRequest AWS API Documentation
|
|
1356
1412
|
#
|
|
1357
1413
|
class CreateTaskRequest < Struct.new(
|
|
@@ -1365,7 +1421,8 @@ module Aws::DataSync
|
|
|
1365
1421
|
:tags,
|
|
1366
1422
|
:includes,
|
|
1367
1423
|
:manifest_config,
|
|
1368
|
-
:task_report_config
|
|
1424
|
+
:task_report_config,
|
|
1425
|
+
:task_mode)
|
|
1369
1426
|
SENSITIVE = []
|
|
1370
1427
|
include Aws::Structure
|
|
1371
1428
|
end
|
|
@@ -1718,8 +1775,12 @@ module Aws::DataSync
|
|
|
1718
1775
|
# @return [String]
|
|
1719
1776
|
#
|
|
1720
1777
|
# @!attribute [rw] ec2_config
|
|
1721
|
-
# The subnet and security groups that DataSync uses to
|
|
1722
|
-
# Amazon EFS file system.
|
|
1778
|
+
# The subnet and security groups that DataSync uses to connect to one
|
|
1779
|
+
# of your Amazon EFS file system's [mount targets][1].
|
|
1780
|
+
#
|
|
1781
|
+
#
|
|
1782
|
+
#
|
|
1783
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html
|
|
1723
1784
|
# @return [Types::Ec2Config]
|
|
1724
1785
|
#
|
|
1725
1786
|
# @!attribute [rw] creation_time
|
|
@@ -1729,16 +1790,30 @@ module Aws::DataSync
|
|
|
1729
1790
|
# @!attribute [rw] access_point_arn
|
|
1730
1791
|
# The ARN of the access point that DataSync uses to access the Amazon
|
|
1731
1792
|
# EFS file system.
|
|
1793
|
+
#
|
|
1794
|
+
# For more information, see [Accessing restricted file systems][1].
|
|
1795
|
+
#
|
|
1796
|
+
#
|
|
1797
|
+
#
|
|
1798
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam
|
|
1732
1799
|
# @return [String]
|
|
1733
1800
|
#
|
|
1734
1801
|
# @!attribute [rw] file_system_access_role_arn
|
|
1735
|
-
# The Identity and Access Management (IAM) role that DataSync
|
|
1736
|
-
#
|
|
1802
|
+
# The Identity and Access Management (IAM) role that allows DataSync
|
|
1803
|
+
# to access your Amazon EFS file system.
|
|
1804
|
+
#
|
|
1805
|
+
# For more information, see [Creating a DataSync IAM role for file
|
|
1806
|
+
# system access][1].
|
|
1807
|
+
#
|
|
1808
|
+
#
|
|
1809
|
+
#
|
|
1810
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role
|
|
1737
1811
|
# @return [String]
|
|
1738
1812
|
#
|
|
1739
1813
|
# @!attribute [rw] in_transit_encryption
|
|
1740
|
-
#
|
|
1741
|
-
# encryption when
|
|
1814
|
+
# Indicates whether DataSync uses Transport Layer Security (TLS)
|
|
1815
|
+
# encryption when transferring data to or from the Amazon EFS file
|
|
1816
|
+
# system.
|
|
1742
1817
|
# @return [String]
|
|
1743
1818
|
#
|
|
1744
1819
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationEfsResponse AWS API Documentation
|
|
@@ -1928,8 +2003,16 @@ module Aws::DataSync
|
|
|
1928
2003
|
# @return [String]
|
|
1929
2004
|
#
|
|
1930
2005
|
# @!attribute [rw] security_group_arns
|
|
1931
|
-
# The ARNs of the security groups that
|
|
1932
|
-
#
|
|
2006
|
+
# The ARNs of the Amazon EC2 security groups that provide access to
|
|
2007
|
+
# your file system's preferred subnet.
|
|
2008
|
+
#
|
|
2009
|
+
# For information about configuring security groups for file system
|
|
2010
|
+
# access, see the [ *Amazon FSx for Windows File Server User Guide*
|
|
2011
|
+
# ][1].
|
|
2012
|
+
#
|
|
2013
|
+
#
|
|
2014
|
+
#
|
|
2015
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html
|
|
1933
2016
|
# @return [Array<String>]
|
|
1934
2017
|
#
|
|
1935
2018
|
# @!attribute [rw] creation_time
|
|
@@ -2073,8 +2156,8 @@ module Aws::DataSync
|
|
|
2073
2156
|
# @return [String]
|
|
2074
2157
|
#
|
|
2075
2158
|
# @!attribute [rw] on_prem_config
|
|
2076
|
-
# The DataSync agents that
|
|
2077
|
-
# (NFS)
|
|
2159
|
+
# The DataSync agents that can connect to your Network File System
|
|
2160
|
+
# (NFS) file server.
|
|
2078
2161
|
# @return [Types::OnPremConfig]
|
|
2079
2162
|
#
|
|
2080
2163
|
# @!attribute [rw] mount_options
|
|
@@ -2624,46 +2707,82 @@ module Aws::DataSync
|
|
|
2624
2707
|
# @return [Time]
|
|
2625
2708
|
#
|
|
2626
2709
|
# @!attribute [rw] estimated_files_to_transfer
|
|
2627
|
-
# The
|
|
2628
|
-
#
|
|
2629
|
-
#
|
|
2630
|
-
#
|
|
2631
|
-
#
|
|
2632
|
-
#
|
|
2710
|
+
# The number of files, objects, and directories that DataSync expects
|
|
2711
|
+
# to transfer over the network. This value is calculated while
|
|
2712
|
+
# DataSync [prepares][1] the transfer.
|
|
2713
|
+
#
|
|
2714
|
+
# How this gets calculated depends primarily on your task’s [transfer
|
|
2715
|
+
# mode][2] configuration:
|
|
2716
|
+
#
|
|
2717
|
+
# * If `TranserMode` is set to `CHANGED` - The calculation is based on
|
|
2718
|
+
# comparing the content of the source and destination locations and
|
|
2719
|
+
# determining the difference that needs to be transferred. The
|
|
2720
|
+
# difference can include:
|
|
2721
|
+
#
|
|
2722
|
+
# * Anything that's added or modified at the source location.
|
|
2723
|
+
#
|
|
2724
|
+
# * Anything that's in both locations and modified at the
|
|
2725
|
+
# destination after an initial transfer (unless [OverwriteMode][3]
|
|
2726
|
+
# is set to `NEVER`).
|
|
2727
|
+
#
|
|
2728
|
+
# * **(Basic task mode only)** The number of items that DataSync
|
|
2729
|
+
# expects to delete (if [PreserveDeletedFiles][4] is set to
|
|
2730
|
+
# `REMOVE`).
|
|
2731
|
+
#
|
|
2732
|
+
# * If `TranserMode` is set to `ALL` - The calculation is based only
|
|
2733
|
+
# on the items that DataSync finds at the source location.
|
|
2734
|
+
#
|
|
2735
|
+
#
|
|
2736
|
+
#
|
|
2737
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses
|
|
2738
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-TransferMode
|
|
2739
|
+
# [3]: https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-OverwriteMode
|
|
2740
|
+
# [4]: https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-PreserveDeletedFiles
|
|
2633
2741
|
# @return [Integer]
|
|
2634
2742
|
#
|
|
2635
2743
|
# @!attribute [rw] estimated_bytes_to_transfer
|
|
2636
|
-
# The
|
|
2637
|
-
#
|
|
2744
|
+
# The number of logical bytes that DataSync expects to write to the
|
|
2745
|
+
# destination location.
|
|
2638
2746
|
# @return [Integer]
|
|
2639
2747
|
#
|
|
2640
2748
|
# @!attribute [rw] files_transferred
|
|
2641
|
-
# The
|
|
2642
|
-
#
|
|
2643
|
-
# during
|
|
2644
|
-
#
|
|
2749
|
+
# The number of files, objects, and directories that DataSync actually
|
|
2750
|
+
# transfers over the network. This value is updated periodically
|
|
2751
|
+
# during your task execution when something is read from the source
|
|
2752
|
+
# and sent over the network.
|
|
2645
2753
|
#
|
|
2646
2754
|
# If DataSync fails to transfer something, this value can be less than
|
|
2647
2755
|
# `EstimatedFilesToTransfer`. In some cases, this value can also be
|
|
2648
2756
|
# greater than `EstimatedFilesToTransfer`. This element is
|
|
2649
2757
|
# implementation-specific for some location types, so don't use it as
|
|
2650
|
-
# an exact indication of what
|
|
2758
|
+
# an exact indication of what's transferring or to monitor your task
|
|
2651
2759
|
# execution.
|
|
2652
2760
|
# @return [Integer]
|
|
2653
2761
|
#
|
|
2654
2762
|
# @!attribute [rw] bytes_written
|
|
2655
|
-
# The number of logical bytes
|
|
2763
|
+
# The number of logical bytes that DataSync actually writes to the
|
|
2764
|
+
# destination location.
|
|
2656
2765
|
# @return [Integer]
|
|
2657
2766
|
#
|
|
2658
2767
|
# @!attribute [rw] bytes_transferred
|
|
2659
|
-
# The
|
|
2660
|
-
#
|
|
2768
|
+
# The number of bytes that DataSync sends to the network before
|
|
2769
|
+
# compression (if compression is possible). For the number of bytes
|
|
2770
|
+
# transferred over the network, see [BytesCompressed][1].
|
|
2771
|
+
#
|
|
2772
|
+
#
|
|
2773
|
+
#
|
|
2774
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-BytesCompressed
|
|
2661
2775
|
# @return [Integer]
|
|
2662
2776
|
#
|
|
2663
2777
|
# @!attribute [rw] bytes_compressed
|
|
2664
|
-
# The
|
|
2665
|
-
# compression
|
|
2666
|
-
#
|
|
2778
|
+
# The number of physical bytes that DataSync transfers over the
|
|
2779
|
+
# network after compression (if compression is possible). This number
|
|
2780
|
+
# is typically less than [BytesTransferred][1] unless the data isn't
|
|
2781
|
+
# compressible.
|
|
2782
|
+
#
|
|
2783
|
+
#
|
|
2784
|
+
#
|
|
2785
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-BytesTransferred
|
|
2667
2786
|
# @return [Integer]
|
|
2668
2787
|
#
|
|
2669
2788
|
# @!attribute [rw] result
|
|
@@ -2681,10 +2800,10 @@ module Aws::DataSync
|
|
|
2681
2800
|
# @return [Types::TaskReportConfig]
|
|
2682
2801
|
#
|
|
2683
2802
|
# @!attribute [rw] files_deleted
|
|
2684
|
-
# The number of files, objects, and directories that DataSync
|
|
2685
|
-
# in your destination location. If you don't
|
|
2686
|
-
# to delete data in the destination that isn't in the
|
|
2687
|
-
# value is always `0`.
|
|
2803
|
+
# The number of files, objects, and directories that DataSync actually
|
|
2804
|
+
# deletes in your destination location. If you don't configure your
|
|
2805
|
+
# task to [delete data in the destination that isn't in the
|
|
2806
|
+
# source][1], the value is always `0`.
|
|
2688
2807
|
#
|
|
2689
2808
|
#
|
|
2690
2809
|
#
|
|
@@ -2692,12 +2811,12 @@ module Aws::DataSync
|
|
|
2692
2811
|
# @return [Integer]
|
|
2693
2812
|
#
|
|
2694
2813
|
# @!attribute [rw] files_skipped
|
|
2695
|
-
# The number of files, objects, and directories that DataSync
|
|
2814
|
+
# The number of files, objects, and directories that DataSync skips
|
|
2696
2815
|
# during your transfer.
|
|
2697
2816
|
# @return [Integer]
|
|
2698
2817
|
#
|
|
2699
2818
|
# @!attribute [rw] files_verified
|
|
2700
|
-
# The number of files, objects, and directories that DataSync
|
|
2819
|
+
# The number of files, objects, and directories that DataSync verifies
|
|
2701
2820
|
# during your transfer.
|
|
2702
2821
|
#
|
|
2703
2822
|
# <note markdown="1"> When you configure your task to [verify only the data that's
|
|
@@ -2721,16 +2840,69 @@ module Aws::DataSync
|
|
|
2721
2840
|
# @return [Types::ReportResult]
|
|
2722
2841
|
#
|
|
2723
2842
|
# @!attribute [rw] estimated_files_to_delete
|
|
2724
|
-
# The
|
|
2725
|
-
#
|
|
2726
|
-
#
|
|
2727
|
-
# source, the value is always `0`.
|
|
2843
|
+
# The number of files, objects, and directories that DataSync expects
|
|
2844
|
+
# to delete in your destination location. If you don't configure your
|
|
2845
|
+
# task to [delete data in the destination that isn't in the
|
|
2846
|
+
# source][1], the value is always `0`.
|
|
2728
2847
|
#
|
|
2729
2848
|
#
|
|
2730
2849
|
#
|
|
2731
2850
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html
|
|
2732
2851
|
# @return [Integer]
|
|
2733
2852
|
#
|
|
2853
|
+
# @!attribute [rw] task_mode
|
|
2854
|
+
# The task mode that you're using. For more information, see
|
|
2855
|
+
# [Choosing a task mode for your data transfer][1].
|
|
2856
|
+
#
|
|
2857
|
+
#
|
|
2858
|
+
#
|
|
2859
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
|
2860
|
+
# @return [String]
|
|
2861
|
+
#
|
|
2862
|
+
# @!attribute [rw] files_prepared
|
|
2863
|
+
# The number of objects that DataSync will attempt to transfer after
|
|
2864
|
+
# comparing your source and destination locations.
|
|
2865
|
+
#
|
|
2866
|
+
# <note markdown="1"> Applies only to [Enhanced mode tasks][1].
|
|
2867
|
+
#
|
|
2868
|
+
# </note>
|
|
2869
|
+
#
|
|
2870
|
+
# This counter isn't applicable if you configure your task to
|
|
2871
|
+
# [transfer all data][2]. In that scenario, DataSync copies everything
|
|
2872
|
+
# from the source to the destination without comparing differences
|
|
2873
|
+
# between the locations.
|
|
2874
|
+
#
|
|
2875
|
+
#
|
|
2876
|
+
#
|
|
2877
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
|
2878
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-transfer-mode
|
|
2879
|
+
# @return [Integer]
|
|
2880
|
+
#
|
|
2881
|
+
# @!attribute [rw] files_listed
|
|
2882
|
+
# The number of objects that DataSync finds at your locations.
|
|
2883
|
+
#
|
|
2884
|
+
# <note markdown="1"> Applies only to [Enhanced mode tasks][1].
|
|
2885
|
+
#
|
|
2886
|
+
# </note>
|
|
2887
|
+
#
|
|
2888
|
+
#
|
|
2889
|
+
#
|
|
2890
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
|
2891
|
+
# @return [Types::TaskExecutionFilesListedDetail]
|
|
2892
|
+
#
|
|
2893
|
+
# @!attribute [rw] files_failed
|
|
2894
|
+
# The number of objects that DataSync fails to prepare, transfer,
|
|
2895
|
+
# verify, and delete during your task execution.
|
|
2896
|
+
#
|
|
2897
|
+
# <note markdown="1"> Applies only to [Enhanced mode tasks][1].
|
|
2898
|
+
#
|
|
2899
|
+
# </note>
|
|
2900
|
+
#
|
|
2901
|
+
#
|
|
2902
|
+
#
|
|
2903
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
|
2904
|
+
# @return [Types::TaskExecutionFilesFailedDetail]
|
|
2905
|
+
#
|
|
2734
2906
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskExecutionResponse AWS API Documentation
|
|
2735
2907
|
#
|
|
2736
2908
|
class DescribeTaskExecutionResponse < Struct.new(
|
|
@@ -2753,7 +2925,11 @@ module Aws::DataSync
|
|
|
2753
2925
|
:files_skipped,
|
|
2754
2926
|
:files_verified,
|
|
2755
2927
|
:report_result,
|
|
2756
|
-
:estimated_files_to_delete
|
|
2928
|
+
:estimated_files_to_delete,
|
|
2929
|
+
:task_mode,
|
|
2930
|
+
:files_prepared,
|
|
2931
|
+
:files_listed,
|
|
2932
|
+
:files_failed)
|
|
2757
2933
|
SENSITIVE = []
|
|
2758
2934
|
include Aws::Structure
|
|
2759
2935
|
end
|
|
@@ -2808,12 +2984,12 @@ module Aws::DataSync
|
|
|
2808
2984
|
# The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for
|
|
2809
2985
|
# monitoring your task.
|
|
2810
2986
|
#
|
|
2811
|
-
# For more information, see [Monitoring
|
|
2812
|
-
#
|
|
2987
|
+
# For more information, see [Monitoring data transfers with CloudWatch
|
|
2988
|
+
# Logs][1].
|
|
2813
2989
|
#
|
|
2814
2990
|
#
|
|
2815
2991
|
#
|
|
2816
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/
|
|
2992
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html
|
|
2817
2993
|
# @return [String]
|
|
2818
2994
|
#
|
|
2819
2995
|
# @!attribute [rw] source_network_interface_arns
|
|
@@ -2923,6 +3099,15 @@ module Aws::DataSync
|
|
|
2923
3099
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
|
|
2924
3100
|
# @return [Types::TaskScheduleDetails]
|
|
2925
3101
|
#
|
|
3102
|
+
# @!attribute [rw] task_mode
|
|
3103
|
+
# The task mode that you're using. For more information, see
|
|
3104
|
+
# [Choosing a task mode for your data transfer][1].
|
|
3105
|
+
#
|
|
3106
|
+
#
|
|
3107
|
+
#
|
|
3108
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
|
3109
|
+
# @return [String]
|
|
3110
|
+
#
|
|
2926
3111
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskResponse AWS API Documentation
|
|
2927
3112
|
#
|
|
2928
3113
|
class DescribeTaskResponse < Struct.new(
|
|
@@ -2944,7 +3129,8 @@ module Aws::DataSync
|
|
|
2944
3129
|
:includes,
|
|
2945
3130
|
:manifest_config,
|
|
2946
3131
|
:task_report_config,
|
|
2947
|
-
:schedule_details
|
|
3132
|
+
:schedule_details,
|
|
3133
|
+
:task_mode)
|
|
2948
3134
|
SENSITIVE = []
|
|
2949
3135
|
include Aws::Structure
|
|
2950
3136
|
end
|
|
@@ -2995,8 +3181,12 @@ module Aws::DataSync
|
|
|
2995
3181
|
include Aws::Structure
|
|
2996
3182
|
end
|
|
2997
3183
|
|
|
2998
|
-
# The subnet and security groups that DataSync uses to
|
|
2999
|
-
# Amazon EFS file system.
|
|
3184
|
+
# The subnet and security groups that DataSync uses to connect to one of
|
|
3185
|
+
# your Amazon EFS file system's [mount targets][1].
|
|
3186
|
+
#
|
|
3187
|
+
#
|
|
3188
|
+
#
|
|
3189
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html
|
|
3000
3190
|
#
|
|
3001
3191
|
# @!attribute [rw] subnet_arn
|
|
3002
3192
|
# Specifies the ARN of a subnet where DataSync creates the [network
|
|
@@ -4129,12 +4319,19 @@ module Aws::DataSync
|
|
|
4129
4319
|
include Aws::Structure
|
|
4130
4320
|
end
|
|
4131
4321
|
|
|
4132
|
-
# The DataSync agents that
|
|
4133
|
-
#
|
|
4322
|
+
# The DataSync agents that can connect to your Network File System (NFS)
|
|
4323
|
+
# file server.
|
|
4134
4324
|
#
|
|
4135
4325
|
# @!attribute [rw] agent_arns
|
|
4136
|
-
# The Amazon Resource Names (ARNs) of the agents
|
|
4137
|
-
#
|
|
4326
|
+
# The Amazon Resource Names (ARNs) of the DataSync agents that can
|
|
4327
|
+
# connect to your NFS file server.
|
|
4328
|
+
#
|
|
4329
|
+
# You can specify more than one agent. For more information, see
|
|
4330
|
+
# [Using multiple DataSync agents][1].
|
|
4331
|
+
#
|
|
4332
|
+
#
|
|
4333
|
+
#
|
|
4334
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#multiple-agents
|
|
4138
4335
|
# @return [Array<String>]
|
|
4139
4336
|
#
|
|
4140
4337
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/OnPremConfig AWS API Documentation
|
|
@@ -4162,39 +4359,50 @@ module Aws::DataSync
|
|
|
4162
4359
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
|
4163
4360
|
#
|
|
4164
4361
|
# @!attribute [rw] verify_mode
|
|
4165
|
-
# Specifies
|
|
4166
|
-
#
|
|
4362
|
+
# Specifies if and how DataSync checks the integrity of your data at
|
|
4363
|
+
# the end of your transfer.
|
|
4167
4364
|
#
|
|
4168
4365
|
# * `ONLY_FILES_TRANSFERRED` (recommended) - DataSync calculates the
|
|
4169
|
-
# checksum of transferred
|
|
4170
|
-
# At the end of the transfer, DataSync then compares this
|
|
4171
|
-
# to the checksum calculated on
|
|
4366
|
+
# checksum of transferred data (including metadata) at the source
|
|
4367
|
+
# location. At the end of the transfer, DataSync then compares this
|
|
4368
|
+
# checksum to the checksum calculated on that data at the
|
|
4369
|
+
# destination.
|
|
4370
|
+
#
|
|
4371
|
+
# <note markdown="1"> This is the default option for [Enhanced mode tasks][1].
|
|
4372
|
+
#
|
|
4373
|
+
# </note>
|
|
4172
4374
|
#
|
|
4173
4375
|
# We recommend this option when transferring to S3 Glacier Flexible
|
|
4174
4376
|
# Retrieval or S3 Glacier Deep Archive storage classes. For more
|
|
4175
4377
|
# information, see [Storage class considerations with Amazon S3
|
|
4176
|
-
# locations][
|
|
4378
|
+
# locations][2].
|
|
4177
4379
|
#
|
|
4178
|
-
# * `POINT_IN_TIME_CONSISTENT`
|
|
4179
|
-
#
|
|
4180
|
-
#
|
|
4380
|
+
# * `POINT_IN_TIME_CONSISTENT` - At the end of the transfer, DataSync
|
|
4381
|
+
# checks the entire source and destination to verify that both
|
|
4382
|
+
# locations are fully synchronized.
|
|
4181
4383
|
#
|
|
4182
|
-
#
|
|
4384
|
+
# <note markdown="1"> The is the default option for [Basic mode tasks][1] and isn't
|
|
4385
|
+
# currently supported with Enhanced mode tasks.
|
|
4386
|
+
#
|
|
4387
|
+
# </note>
|
|
4388
|
+
#
|
|
4389
|
+
# If you use a [manifest][3], DataSync only scans and verifies
|
|
4183
4390
|
# what's listed in the manifest.
|
|
4184
4391
|
#
|
|
4185
4392
|
# You can't use this option when transferring to S3 Glacier
|
|
4186
4393
|
# Flexible Retrieval or S3 Glacier Deep Archive storage classes. For
|
|
4187
4394
|
# more information, see [Storage class considerations with Amazon S3
|
|
4188
|
-
# locations][
|
|
4395
|
+
# locations][2].
|
|
4189
4396
|
#
|
|
4190
|
-
# * `NONE` - DataSync
|
|
4191
|
-
#
|
|
4192
|
-
#
|
|
4397
|
+
# * `NONE` - DataSync performs data integrity checks only during your
|
|
4398
|
+
# transfer. Unlike other options, there's no additional
|
|
4399
|
+
# verification at the end of your transfer.
|
|
4193
4400
|
#
|
|
4194
4401
|
#
|
|
4195
4402
|
#
|
|
4196
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/
|
|
4197
|
-
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/
|
|
4403
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
|
4404
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
|
|
4405
|
+
# [3]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
|
|
4198
4406
|
# @return [String]
|
|
4199
4407
|
#
|
|
4200
4408
|
# @!attribute [rw] overwrite_mode
|
|
@@ -4230,7 +4438,7 @@ module Aws::DataSync
|
|
|
4230
4438
|
#
|
|
4231
4439
|
# * `BEST_EFFORT` (default) - DataSync attempts to preserve the
|
|
4232
4440
|
# original `Atime` attribute on all source files (that is, the
|
|
4233
|
-
# version before the `PREPARING`
|
|
4441
|
+
# version before the `PREPARING` steps of the task execution). This
|
|
4234
4442
|
# option is recommended.
|
|
4235
4443
|
#
|
|
4236
4444
|
# * `NONE` - Ignores `Atime`.
|
|
@@ -4245,7 +4453,7 @@ module Aws::DataSync
|
|
|
4245
4453
|
#
|
|
4246
4454
|
# @!attribute [rw] mtime
|
|
4247
4455
|
# Specifies whether to preserve metadata indicating the last time that
|
|
4248
|
-
# a file was written to before the `PREPARING`
|
|
4456
|
+
# a file was written to before the `PREPARING` step of your task
|
|
4249
4457
|
# execution. This option is required when you need to run the a task
|
|
4250
4458
|
# more than once.
|
|
4251
4459
|
#
|
|
@@ -4285,11 +4493,12 @@ module Aws::DataSync
|
|
|
4285
4493
|
#
|
|
4286
4494
|
# * `NONE` - Ignores UID and GID.
|
|
4287
4495
|
#
|
|
4288
|
-
# For more information, see [
|
|
4496
|
+
# For more information, see [Understanding how DataSync handles file
|
|
4497
|
+
# and object metadata][1].
|
|
4289
4498
|
#
|
|
4290
4499
|
#
|
|
4291
4500
|
#
|
|
4292
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/
|
|
4501
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html
|
|
4293
4502
|
# @return [String]
|
|
4294
4503
|
#
|
|
4295
4504
|
# @!attribute [rw] preserve_deleted_files
|
|
@@ -4338,7 +4547,8 @@ module Aws::DataSync
|
|
|
4338
4547
|
# Specifies which users or groups can access a file for a specific
|
|
4339
4548
|
# purpose such as reading, writing, or execution of the file.
|
|
4340
4549
|
#
|
|
4341
|
-
# For more information, see [
|
|
4550
|
+
# For more information, see [Understanding how DataSync handles file
|
|
4551
|
+
# and object metadata][1].
|
|
4342
4552
|
#
|
|
4343
4553
|
# * `PRESERVE` (default) - Preserves POSIX-style permissions, which is
|
|
4344
4554
|
# recommended.
|
|
@@ -4351,13 +4561,21 @@ module Aws::DataSync
|
|
|
4351
4561
|
#
|
|
4352
4562
|
#
|
|
4353
4563
|
#
|
|
4354
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/
|
|
4564
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html
|
|
4355
4565
|
# @return [String]
|
|
4356
4566
|
#
|
|
4357
4567
|
# @!attribute [rw] bytes_per_second
|
|
4358
4568
|
# Limits the bandwidth used by a DataSync task. For example, if you
|
|
4359
4569
|
# want DataSync to use a maximum of 1 MB, set this value to `1048576`
|
|
4360
4570
|
# (`=1024*1024`).
|
|
4571
|
+
#
|
|
4572
|
+
# <note markdown="1"> Not applicable to [Enhanced mode tasks][1].
|
|
4573
|
+
#
|
|
4574
|
+
# </note>
|
|
4575
|
+
#
|
|
4576
|
+
#
|
|
4577
|
+
#
|
|
4578
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
|
4361
4579
|
# @return [Integer]
|
|
4362
4580
|
#
|
|
4363
4581
|
# @!attribute [rw] task_queueing
|
|
@@ -4389,14 +4607,15 @@ module Aws::DataSync
|
|
|
4389
4607
|
# @return [String]
|
|
4390
4608
|
#
|
|
4391
4609
|
# @!attribute [rw] transfer_mode
|
|
4392
|
-
#
|
|
4393
|
-
# that
|
|
4394
|
-
# transfers all
|
|
4395
|
-
#
|
|
4610
|
+
# Specifies whether DataSync transfers only the data (including
|
|
4611
|
+
# metadata) that differs between locations following an initial copy
|
|
4612
|
+
# or transfers all data every time you run the task. If you're
|
|
4613
|
+
# planning on recurring transfers, you might only want to transfer
|
|
4614
|
+
# what's changed since your previous task execution.
|
|
4396
4615
|
#
|
|
4397
|
-
# * `CHANGED` (default) -
|
|
4398
|
-
#
|
|
4399
|
-
# destination location.
|
|
4616
|
+
# * `CHANGED` (default) - After your initial full transfer, DataSync
|
|
4617
|
+
# copies only the data and metadata that differs between the source
|
|
4618
|
+
# and destination location.
|
|
4400
4619
|
#
|
|
4401
4620
|
# * `ALL` - DataSync copies everything in the source to the
|
|
4402
4621
|
# destination without comparing differences between the locations.
|
|
@@ -4408,8 +4627,8 @@ module Aws::DataSync
|
|
|
4408
4627
|
#
|
|
4409
4628
|
# This value is only used for transfers between SMB and Amazon FSx for
|
|
4410
4629
|
# Windows File Server locations or between two FSx for Windows File
|
|
4411
|
-
# Server locations. For more information, see [how
|
|
4412
|
-
# metadata][1].
|
|
4630
|
+
# Server locations. For more information, see [Understanding how
|
|
4631
|
+
# DataSync handles file and object metadata][1].
|
|
4413
4632
|
#
|
|
4414
4633
|
# * `OWNER_DACL` (default) - For each copied object, DataSync copies
|
|
4415
4634
|
# the following metadata:
|
|
@@ -4447,7 +4666,7 @@ module Aws::DataSync
|
|
|
4447
4666
|
#
|
|
4448
4667
|
#
|
|
4449
4668
|
#
|
|
4450
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/
|
|
4669
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html
|
|
4451
4670
|
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
|
|
4452
4671
|
# [3]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions
|
|
4453
4672
|
# [4]: https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb
|
|
@@ -4546,7 +4765,7 @@ module Aws::DataSync
|
|
|
4546
4765
|
#
|
|
4547
4766
|
#
|
|
4548
4767
|
#
|
|
4549
|
-
# [1]: https://docs.aws.amazon.com/vpc/latest/
|
|
4768
|
+
# [1]: https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html
|
|
4550
4769
|
# @return [String]
|
|
4551
4770
|
#
|
|
4552
4771
|
# @!attribute [rw] subnet_arns
|
|
@@ -5270,6 +5489,96 @@ module Aws::DataSync
|
|
|
5270
5489
|
#
|
|
5271
5490
|
class TagResourceResponse < Aws::EmptyStructure; end
|
|
5272
5491
|
|
|
5492
|
+
# The number of objects that DataSync fails to prepare, transfer,
|
|
5493
|
+
# verify, and delete during your task execution.
|
|
5494
|
+
#
|
|
5495
|
+
# <note markdown="1"> Applies only to [Enhanced mode tasks][1].
|
|
5496
|
+
#
|
|
5497
|
+
# </note>
|
|
5498
|
+
#
|
|
5499
|
+
#
|
|
5500
|
+
#
|
|
5501
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
|
5502
|
+
#
|
|
5503
|
+
# @!attribute [rw] prepare
|
|
5504
|
+
# The number of objects that DataSync fails to prepare during your
|
|
5505
|
+
# task execution.
|
|
5506
|
+
# @return [Integer]
|
|
5507
|
+
#
|
|
5508
|
+
# @!attribute [rw] transfer
|
|
5509
|
+
# The number of objects that DataSync fails to transfer during your
|
|
5510
|
+
# task execution.
|
|
5511
|
+
# @return [Integer]
|
|
5512
|
+
#
|
|
5513
|
+
# @!attribute [rw] verify
|
|
5514
|
+
# The number of objects that DataSync fails to verify during your task
|
|
5515
|
+
# execution.
|
|
5516
|
+
# @return [Integer]
|
|
5517
|
+
#
|
|
5518
|
+
# @!attribute [rw] delete
|
|
5519
|
+
# The number of objects that DataSync fails to delete during your task
|
|
5520
|
+
# execution.
|
|
5521
|
+
# @return [Integer]
|
|
5522
|
+
#
|
|
5523
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskExecutionFilesFailedDetail AWS API Documentation
|
|
5524
|
+
#
|
|
5525
|
+
class TaskExecutionFilesFailedDetail < Struct.new(
|
|
5526
|
+
:prepare,
|
|
5527
|
+
:transfer,
|
|
5528
|
+
:verify,
|
|
5529
|
+
:delete)
|
|
5530
|
+
SENSITIVE = []
|
|
5531
|
+
include Aws::Structure
|
|
5532
|
+
end
|
|
5533
|
+
|
|
5534
|
+
# The number of objects that DataSync finds at your locations.
|
|
5535
|
+
#
|
|
5536
|
+
# <note markdown="1"> Applies only to [Enhanced mode tasks][1].
|
|
5537
|
+
#
|
|
5538
|
+
# </note>
|
|
5539
|
+
#
|
|
5540
|
+
#
|
|
5541
|
+
#
|
|
5542
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
|
5543
|
+
#
|
|
5544
|
+
# @!attribute [rw] at_source
|
|
5545
|
+
# The number of objects that DataSync finds at your source location.
|
|
5546
|
+
#
|
|
5547
|
+
# * With a [manifest][1], DataSync lists only what's in your manifest
|
|
5548
|
+
# (and not everything at your source location).
|
|
5549
|
+
#
|
|
5550
|
+
# * With an include [filter][2], DataSync lists only what matches the
|
|
5551
|
+
# filter at your source location.
|
|
5552
|
+
#
|
|
5553
|
+
# * With an exclude filter, DataSync lists everything at your source
|
|
5554
|
+
# location before applying the filter.
|
|
5555
|
+
#
|
|
5556
|
+
#
|
|
5557
|
+
#
|
|
5558
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
|
|
5559
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
|
5560
|
+
# @return [Integer]
|
|
5561
|
+
#
|
|
5562
|
+
# @!attribute [rw] at_destination_for_delete
|
|
5563
|
+
# The number of objects that DataSync finds at your destination
|
|
5564
|
+
# location. This counter is only applicable if you [configure your
|
|
5565
|
+
# task][1] to delete data in the destination that isn't in the
|
|
5566
|
+
# source.
|
|
5567
|
+
#
|
|
5568
|
+
#
|
|
5569
|
+
#
|
|
5570
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-file-object-handling
|
|
5571
|
+
# @return [Integer]
|
|
5572
|
+
#
|
|
5573
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskExecutionFilesListedDetail AWS API Documentation
|
|
5574
|
+
#
|
|
5575
|
+
class TaskExecutionFilesListedDetail < Struct.new(
|
|
5576
|
+
:at_source,
|
|
5577
|
+
:at_destination_for_delete)
|
|
5578
|
+
SENSITIVE = []
|
|
5579
|
+
include Aws::Structure
|
|
5580
|
+
end
|
|
5581
|
+
|
|
5273
5582
|
# Represents a single entry in a list of DataSync task executions
|
|
5274
5583
|
# that's returned with the [ListTaskExecutions][1] operation.
|
|
5275
5584
|
#
|
|
@@ -5290,60 +5599,118 @@ module Aws::DataSync
|
|
|
5290
5599
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/understand-task-statuses.html#understand-task-execution-statuses
|
|
5291
5600
|
# @return [String]
|
|
5292
5601
|
#
|
|
5602
|
+
# @!attribute [rw] task_mode
|
|
5603
|
+
# The task mode that you're using. For more information, see
|
|
5604
|
+
# [Choosing a task mode for your data transfer][1].
|
|
5605
|
+
#
|
|
5606
|
+
#
|
|
5607
|
+
#
|
|
5608
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
|
5609
|
+
# @return [String]
|
|
5610
|
+
#
|
|
5293
5611
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskExecutionListEntry AWS API Documentation
|
|
5294
5612
|
#
|
|
5295
5613
|
class TaskExecutionListEntry < Struct.new(
|
|
5296
5614
|
:task_execution_arn,
|
|
5297
|
-
:status
|
|
5615
|
+
:status,
|
|
5616
|
+
:task_mode)
|
|
5298
5617
|
SENSITIVE = []
|
|
5299
5618
|
include Aws::Structure
|
|
5300
5619
|
end
|
|
5301
5620
|
|
|
5302
|
-
#
|
|
5303
|
-
#
|
|
5304
|
-
# status of the task execution, and the errors encountered.
|
|
5621
|
+
# Provides detailed information about the result of your DataSync task
|
|
5622
|
+
# execution.
|
|
5305
5623
|
#
|
|
5306
5624
|
# @!attribute [rw] prepare_duration
|
|
5307
|
-
# The
|
|
5308
|
-
#
|
|
5625
|
+
# The time in milliseconds that your task execution was in the
|
|
5626
|
+
# `PREPARING` step. For more information, see [Task execution
|
|
5627
|
+
# statuses][1].
|
|
5628
|
+
#
|
|
5629
|
+
# For Enhanced mode tasks, the value is always `0`. For more
|
|
5630
|
+
# information, see [How DataSync prepares your data transfer][2].
|
|
5631
|
+
#
|
|
5632
|
+
#
|
|
5633
|
+
#
|
|
5634
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses
|
|
5635
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-datasync-prepares
|
|
5309
5636
|
# @return [Integer]
|
|
5310
5637
|
#
|
|
5311
5638
|
# @!attribute [rw] prepare_status
|
|
5312
|
-
# The status of the PREPARING
|
|
5639
|
+
# The status of the `PREPARING` step for your task execution. For more
|
|
5640
|
+
# information, see [Task execution statuses][1].
|
|
5641
|
+
#
|
|
5642
|
+
#
|
|
5643
|
+
#
|
|
5644
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses
|
|
5313
5645
|
# @return [String]
|
|
5314
5646
|
#
|
|
5315
5647
|
# @!attribute [rw] total_duration
|
|
5316
|
-
# The
|
|
5317
|
-
# file from the source to the destination location.
|
|
5648
|
+
# The time in milliseconds that your task execution ran.
|
|
5318
5649
|
# @return [Integer]
|
|
5319
5650
|
#
|
|
5320
5651
|
# @!attribute [rw] transfer_duration
|
|
5321
|
-
# The
|
|
5322
|
-
# TRANSFERRING
|
|
5652
|
+
# The time in milliseconds that your task execution was in the
|
|
5653
|
+
# `TRANSFERRING` step. For more information, see [Task execution
|
|
5654
|
+
# statuses][1].
|
|
5655
|
+
#
|
|
5656
|
+
# For Enhanced mode tasks, the value is always `0`. For more
|
|
5657
|
+
# information, see [How DataSync transfers your data][2].
|
|
5658
|
+
#
|
|
5659
|
+
#
|
|
5660
|
+
#
|
|
5661
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses
|
|
5662
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-datasync-transfers
|
|
5323
5663
|
# @return [Integer]
|
|
5324
5664
|
#
|
|
5325
5665
|
# @!attribute [rw] transfer_status
|
|
5326
|
-
# The status of the TRANSFERRING
|
|
5666
|
+
# The status of the `TRANSFERRING` step for your task execution. For
|
|
5667
|
+
# more information, see [Task execution statuses][1].
|
|
5668
|
+
#
|
|
5669
|
+
#
|
|
5670
|
+
#
|
|
5671
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses
|
|
5327
5672
|
# @return [String]
|
|
5328
5673
|
#
|
|
5329
5674
|
# @!attribute [rw] verify_duration
|
|
5330
|
-
# The
|
|
5331
|
-
#
|
|
5675
|
+
# The time in milliseconds that your task execution was in the
|
|
5676
|
+
# `VERIFYING` step. For more information, see [Task execution
|
|
5677
|
+
# statuses][1].
|
|
5678
|
+
#
|
|
5679
|
+
# For Enhanced mode tasks, the value is always `0`. For more
|
|
5680
|
+
# information, see [How DataSync verifies your data's integrity][2].
|
|
5681
|
+
#
|
|
5682
|
+
#
|
|
5683
|
+
#
|
|
5684
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses
|
|
5685
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-verifying-works
|
|
5332
5686
|
# @return [Integer]
|
|
5333
5687
|
#
|
|
5334
5688
|
# @!attribute [rw] verify_status
|
|
5335
|
-
# The status of the VERIFYING
|
|
5689
|
+
# The status of the `VERIFYING` step for your task execution. For more
|
|
5690
|
+
# information, see [Task execution statuses][1].
|
|
5691
|
+
#
|
|
5692
|
+
#
|
|
5693
|
+
#
|
|
5694
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses
|
|
5336
5695
|
# @return [String]
|
|
5337
5696
|
#
|
|
5338
5697
|
# @!attribute [rw] error_code
|
|
5339
|
-
#
|
|
5340
|
-
# can use this
|
|
5698
|
+
# An error that DataSync encountered during your task execution. You
|
|
5699
|
+
# can use this information to help [troubleshoot issues][1].
|
|
5700
|
+
#
|
|
5701
|
+
#
|
|
5702
|
+
#
|
|
5703
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html
|
|
5341
5704
|
# @return [String]
|
|
5342
5705
|
#
|
|
5343
5706
|
# @!attribute [rw] error_detail
|
|
5344
|
-
#
|
|
5345
|
-
# task execution. You can use this information to help
|
|
5346
|
-
# issues.
|
|
5707
|
+
# The detailed description of an error that DataSync encountered
|
|
5708
|
+
# during your task execution. You can use this information to help
|
|
5709
|
+
# [troubleshoot issues][1].
|
|
5710
|
+
#
|
|
5711
|
+
#
|
|
5712
|
+
#
|
|
5713
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html
|
|
5347
5714
|
# @return [String]
|
|
5348
5715
|
#
|
|
5349
5716
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskExecutionResultDetail AWS API Documentation
|
|
@@ -5420,12 +5787,22 @@ module Aws::DataSync
|
|
|
5420
5787
|
# The name of the task.
|
|
5421
5788
|
# @return [String]
|
|
5422
5789
|
#
|
|
5790
|
+
# @!attribute [rw] task_mode
|
|
5791
|
+
# The task mode that you're using. For more information, see
|
|
5792
|
+
# [Choosing a task mode for your data transfer][1].
|
|
5793
|
+
#
|
|
5794
|
+
#
|
|
5795
|
+
#
|
|
5796
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
|
5797
|
+
# @return [String]
|
|
5798
|
+
#
|
|
5423
5799
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskListEntry AWS API Documentation
|
|
5424
5800
|
#
|
|
5425
5801
|
class TaskListEntry < Struct.new(
|
|
5426
5802
|
:task_arn,
|
|
5427
5803
|
:status,
|
|
5428
|
-
:name
|
|
5804
|
+
:name,
|
|
5805
|
+
:task_mode)
|
|
5429
5806
|
SENSITIVE = []
|
|
5430
5807
|
include Aws::Structure
|
|
5431
5808
|
end
|
|
@@ -5511,13 +5888,26 @@ module Aws::DataSync
|
|
|
5511
5888
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
|
|
5512
5889
|
#
|
|
5513
5890
|
# @!attribute [rw] schedule_expression
|
|
5514
|
-
# Specifies your task schedule by using a cron
|
|
5515
|
-
#
|
|
5516
|
-
#
|
|
5891
|
+
# Specifies your task schedule by using a cron or rate expression.
|
|
5892
|
+
#
|
|
5893
|
+
# Use cron expressions for task schedules that run on a specific time
|
|
5894
|
+
# and day. For example, the following cron expression creates a task
|
|
5895
|
+
# schedule that runs at 8 AM on the first Wednesday of every month:
|
|
5896
|
+
#
|
|
5897
|
+
# `cron(0 8 * * 3#1)`
|
|
5898
|
+
#
|
|
5899
|
+
# Use rate expressions for task schedules that run on a regular
|
|
5900
|
+
# interval. For example, the following rate expression creates a task
|
|
5901
|
+
# schedule that runs every 12 hours:
|
|
5902
|
+
#
|
|
5903
|
+
# `rate(12 hours)`
|
|
5517
5904
|
#
|
|
5905
|
+
# For information about cron and rate expression syntax, see the [
|
|
5906
|
+
# *Amazon EventBridge User Guide* ][1].
|
|
5518
5907
|
#
|
|
5519
5908
|
#
|
|
5520
|
-
#
|
|
5909
|
+
#
|
|
5910
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html
|
|
5521
5911
|
# @return [String]
|
|
5522
5912
|
#
|
|
5523
5913
|
# @!attribute [rw] status
|
|
@@ -5839,7 +6229,8 @@ module Aws::DataSync
|
|
|
5839
6229
|
# @return [String]
|
|
5840
6230
|
#
|
|
5841
6231
|
# @!attribute [rw] agent_arns
|
|
5842
|
-
# The ARNs of the agents that
|
|
6232
|
+
# The Amazon Resource Names (ARNs) of the DataSync agents that can
|
|
6233
|
+
# connect to your HDFS cluster.
|
|
5843
6234
|
# @return [Array<String>]
|
|
5844
6235
|
#
|
|
5845
6236
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationHdfsRequest AWS API Documentation
|
|
@@ -5885,8 +6276,8 @@ module Aws::DataSync
|
|
|
5885
6276
|
# @return [String]
|
|
5886
6277
|
#
|
|
5887
6278
|
# @!attribute [rw] on_prem_config
|
|
5888
|
-
# The DataSync agents that
|
|
5889
|
-
# (NFS)
|
|
6279
|
+
# The DataSync agents that can connect to your Network File System
|
|
6280
|
+
# (NFS) file server.
|
|
5890
6281
|
# @return [Types::OnPremConfig]
|
|
5891
6282
|
#
|
|
5892
6283
|
# @!attribute [rw] mount_options
|
|
@@ -5942,7 +6333,7 @@ module Aws::DataSync
|
|
|
5942
6333
|
#
|
|
5943
6334
|
# @!attribute [rw] agent_arns
|
|
5944
6335
|
# Specifies the Amazon Resource Names (ARNs) of the DataSync agents
|
|
5945
|
-
# that can
|
|
6336
|
+
# that can connect with your object storage system.
|
|
5946
6337
|
# @return [Array<String>]
|
|
5947
6338
|
#
|
|
5948
6339
|
# @!attribute [rw] server_certificate
|
|
@@ -6056,9 +6447,9 @@ module Aws::DataSync
|
|
|
6056
6447
|
# @return [String]
|
|
6057
6448
|
#
|
|
6058
6449
|
# @!attribute [rw] agent_arns
|
|
6059
|
-
# Specifies the DataSync agent (or agents)
|
|
6060
|
-
#
|
|
6061
|
-
#
|
|
6450
|
+
# Specifies the DataSync agent (or agents) that can connect to your
|
|
6451
|
+
# SMB file server. You specify an agent by using its Amazon Resource
|
|
6452
|
+
# Name (ARN).
|
|
6062
6453
|
# @return [Array<String>]
|
|
6063
6454
|
#
|
|
6064
6455
|
# @!attribute [rw] mount_options
|
|
@@ -6220,6 +6611,18 @@ module Aws::DataSync
|
|
|
6220
6611
|
# @!attribute [rw] cloud_watch_log_group_arn
|
|
6221
6612
|
# Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log
|
|
6222
6613
|
# group for monitoring your task.
|
|
6614
|
+
#
|
|
6615
|
+
# For Enhanced mode tasks, you must use `/aws/datasync` as your log
|
|
6616
|
+
# group name. For example:
|
|
6617
|
+
#
|
|
6618
|
+
# `arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync:*`
|
|
6619
|
+
#
|
|
6620
|
+
# For more information, see [Monitoring data transfers with CloudWatch
|
|
6621
|
+
# Logs][1].
|
|
6622
|
+
#
|
|
6623
|
+
#
|
|
6624
|
+
#
|
|
6625
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html
|
|
6223
6626
|
# @return [String]
|
|
6224
6627
|
#
|
|
6225
6628
|
# @!attribute [rw] includes
|