aws-sdk-datasync 1.89.0 → 1.91.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-datasync/client.rb +153 -72
- data/lib/aws-sdk-datasync/client_api.rb +21 -0
- data/lib/aws-sdk-datasync/endpoint_parameters.rb +9 -6
- data/lib/aws-sdk-datasync/endpoints.rb +2 -658
- data/lib/aws-sdk-datasync/plugins/endpoints.rb +1 -126
- data/lib/aws-sdk-datasync/types.rb +572 -163
- data/lib/aws-sdk-datasync.rb +1 -1
- data/sig/client.rbs +7 -1
- data/sig/types.rbs +22 -0
- metadata +4 -4
@@ -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,32 @@ 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
|
+
# enhanced metrics, more detailed logs, and higher performance than
|
1386
|
+
# Basic mode. Currently available for transfers between Amazon S3
|
1387
|
+
# locations.
|
1388
|
+
#
|
1389
|
+
# <note markdown="1"> To create an Enhanced mode task, the IAM role that you use to call
|
1390
|
+
# the `CreateTask` operation must have the
|
1391
|
+
# `iam:CreateServiceLinkedRole` permission.
|
1392
|
+
#
|
1393
|
+
# </note>
|
1394
|
+
#
|
1395
|
+
# * `BASIC` (default) - Transfer files or objects between Amazon Web
|
1396
|
+
# Services storage and on-premises, edge, or other cloud storage.
|
1397
|
+
# DataSync [quotas][1] apply.
|
1398
|
+
#
|
1399
|
+
# For more information, see [Understanding task mode differences][2].
|
1400
|
+
#
|
1401
|
+
#
|
1402
|
+
#
|
1403
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/datasync-limits.html
|
1404
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences
|
1405
|
+
# @return [String]
|
1406
|
+
#
|
1355
1407
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateTaskRequest AWS API Documentation
|
1356
1408
|
#
|
1357
1409
|
class CreateTaskRequest < Struct.new(
|
@@ -1365,7 +1417,8 @@ module Aws::DataSync
|
|
1365
1417
|
:tags,
|
1366
1418
|
:includes,
|
1367
1419
|
:manifest_config,
|
1368
|
-
:task_report_config
|
1420
|
+
:task_report_config,
|
1421
|
+
:task_mode)
|
1369
1422
|
SENSITIVE = []
|
1370
1423
|
include Aws::Structure
|
1371
1424
|
end
|
@@ -1718,8 +1771,12 @@ module Aws::DataSync
|
|
1718
1771
|
# @return [String]
|
1719
1772
|
#
|
1720
1773
|
# @!attribute [rw] ec2_config
|
1721
|
-
# The subnet and security groups that DataSync uses to
|
1722
|
-
# Amazon EFS file system.
|
1774
|
+
# The subnet and security groups that DataSync uses to connect to one
|
1775
|
+
# of your Amazon EFS file system's [mount targets][1].
|
1776
|
+
#
|
1777
|
+
#
|
1778
|
+
#
|
1779
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html
|
1723
1780
|
# @return [Types::Ec2Config]
|
1724
1781
|
#
|
1725
1782
|
# @!attribute [rw] creation_time
|
@@ -1729,16 +1786,30 @@ module Aws::DataSync
|
|
1729
1786
|
# @!attribute [rw] access_point_arn
|
1730
1787
|
# The ARN of the access point that DataSync uses to access the Amazon
|
1731
1788
|
# EFS file system.
|
1789
|
+
#
|
1790
|
+
# For more information, see [Accessing restricted file systems][1].
|
1791
|
+
#
|
1792
|
+
#
|
1793
|
+
#
|
1794
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam
|
1732
1795
|
# @return [String]
|
1733
1796
|
#
|
1734
1797
|
# @!attribute [rw] file_system_access_role_arn
|
1735
|
-
# The Identity and Access Management (IAM) role that DataSync
|
1736
|
-
#
|
1798
|
+
# The Identity and Access Management (IAM) role that allows DataSync
|
1799
|
+
# to access your Amazon EFS file system.
|
1800
|
+
#
|
1801
|
+
# For more information, see [Creating a DataSync IAM role for file
|
1802
|
+
# system access][1].
|
1803
|
+
#
|
1804
|
+
#
|
1805
|
+
#
|
1806
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role
|
1737
1807
|
# @return [String]
|
1738
1808
|
#
|
1739
1809
|
# @!attribute [rw] in_transit_encryption
|
1740
|
-
#
|
1741
|
-
# encryption when
|
1810
|
+
# Indicates whether DataSync uses Transport Layer Security (TLS)
|
1811
|
+
# encryption when transferring data to or from the Amazon EFS file
|
1812
|
+
# system.
|
1742
1813
|
# @return [String]
|
1743
1814
|
#
|
1744
1815
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationEfsResponse AWS API Documentation
|
@@ -1928,8 +1999,16 @@ module Aws::DataSync
|
|
1928
1999
|
# @return [String]
|
1929
2000
|
#
|
1930
2001
|
# @!attribute [rw] security_group_arns
|
1931
|
-
# The ARNs of the security groups that
|
1932
|
-
#
|
2002
|
+
# The ARNs of the Amazon EC2 security groups that provide access to
|
2003
|
+
# your file system's preferred subnet.
|
2004
|
+
#
|
2005
|
+
# For information about configuring security groups for file system
|
2006
|
+
# access, see the [ *Amazon FSx for Windows File Server User Guide*
|
2007
|
+
# ][1].
|
2008
|
+
#
|
2009
|
+
#
|
2010
|
+
#
|
2011
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html
|
1933
2012
|
# @return [Array<String>]
|
1934
2013
|
#
|
1935
2014
|
# @!attribute [rw] creation_time
|
@@ -2073,8 +2152,8 @@ module Aws::DataSync
|
|
2073
2152
|
# @return [String]
|
2074
2153
|
#
|
2075
2154
|
# @!attribute [rw] on_prem_config
|
2076
|
-
# The DataSync agents that
|
2077
|
-
# (NFS)
|
2155
|
+
# The DataSync agents that can connect to your Network File System
|
2156
|
+
# (NFS) file server.
|
2078
2157
|
# @return [Types::OnPremConfig]
|
2079
2158
|
#
|
2080
2159
|
# @!attribute [rw] mount_options
|
@@ -2624,46 +2703,92 @@ module Aws::DataSync
|
|
2624
2703
|
# @return [Time]
|
2625
2704
|
#
|
2626
2705
|
# @!attribute [rw] estimated_files_to_transfer
|
2627
|
-
# The
|
2628
|
-
#
|
2629
|
-
# task execution's `PREPARING`
|
2630
|
-
#
|
2631
|
-
#
|
2632
|
-
#
|
2706
|
+
# The number of files, objects, and directories that DataSync expects
|
2707
|
+
# to transfer over the network. This value is calculated during the
|
2708
|
+
# task execution's `PREPARING` [step][1] before the `TRANSFERRING`
|
2709
|
+
# step.
|
2710
|
+
#
|
2711
|
+
# How this gets calculated depends primarily on your task’s [transfer
|
2712
|
+
# mode][2] configuration:
|
2713
|
+
#
|
2714
|
+
# * If `TranserMode` is set to `CHANGED` - The calculation is based on
|
2715
|
+
# comparing the content of the source and destination locations and
|
2716
|
+
# determining the difference that needs to be transferred. The
|
2717
|
+
# difference can include:
|
2718
|
+
#
|
2719
|
+
# * Anything that's added or modified at the source location.
|
2720
|
+
#
|
2721
|
+
# * Anything that's in both locations and modified at the
|
2722
|
+
# destination after an initial transfer (unless [OverwriteMode][3]
|
2723
|
+
# is set to `NEVER`).
|
2724
|
+
#
|
2725
|
+
# * **(Basic task mode only)** The number of items that DataSync
|
2726
|
+
# expects to delete (if [PreserveDeletedFiles][4] is set to
|
2727
|
+
# `REMOVE`).
|
2728
|
+
#
|
2729
|
+
# * If `TranserMode` is set to `ALL` - The calculation is based only
|
2730
|
+
# on the items that DataSync finds at the source location.
|
2731
|
+
#
|
2732
|
+
#
|
2733
|
+
#
|
2734
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses
|
2735
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-TransferMode
|
2736
|
+
# [3]: https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-OverwriteMode
|
2737
|
+
# [4]: https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-PreserveDeletedFiles
|
2633
2738
|
# @return [Integer]
|
2634
2739
|
#
|
2635
2740
|
# @!attribute [rw] estimated_bytes_to_transfer
|
2636
|
-
# The
|
2637
|
-
#
|
2741
|
+
# The number of logical bytes that DataSync expects to write to the
|
2742
|
+
# destination location.
|
2638
2743
|
# @return [Integer]
|
2639
2744
|
#
|
2640
2745
|
# @!attribute [rw] files_transferred
|
2641
|
-
# The
|
2642
|
-
#
|
2643
|
-
# during the task execution's `TRANSFERRING`
|
2644
|
-
# read from the source and sent over the network.
|
2746
|
+
# The number of files, objects, and directories that DataSync actually
|
2747
|
+
# transfers over the network. This value is updated periodically
|
2748
|
+
# during the task execution's `TRANSFERRING` [step][1] when something
|
2749
|
+
# is read from the source and sent over the network.
|
2645
2750
|
#
|
2646
2751
|
# If DataSync fails to transfer something, this value can be less than
|
2647
2752
|
# `EstimatedFilesToTransfer`. In some cases, this value can also be
|
2648
2753
|
# greater than `EstimatedFilesToTransfer`. This element is
|
2649
2754
|
# implementation-specific for some location types, so don't use it as
|
2650
|
-
# an exact indication of what
|
2755
|
+
# an exact indication of what's transferring or to monitor your task
|
2651
2756
|
# execution.
|
2757
|
+
#
|
2758
|
+
#
|
2759
|
+
#
|
2760
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses
|
2652
2761
|
# @return [Integer]
|
2653
2762
|
#
|
2654
2763
|
# @!attribute [rw] bytes_written
|
2655
|
-
# The number of logical bytes
|
2764
|
+
# The number of logical bytes that DataSync actually writes to the
|
2765
|
+
# destination location.
|
2656
2766
|
# @return [Integer]
|
2657
2767
|
#
|
2658
2768
|
# @!attribute [rw] bytes_transferred
|
2659
|
-
# The
|
2660
|
-
#
|
2769
|
+
# The number of bytes that DataSync sends to the network before
|
2770
|
+
# compression (if compression is possible). For the number of bytes
|
2771
|
+
# transferred over the network, see [BytesCompressed][1].
|
2772
|
+
#
|
2773
|
+
#
|
2774
|
+
#
|
2775
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-BytesCompressed
|
2661
2776
|
# @return [Integer]
|
2662
2777
|
#
|
2663
2778
|
# @!attribute [rw] bytes_compressed
|
2664
|
-
# The
|
2665
|
-
# compression
|
2666
|
-
#
|
2779
|
+
# The number of physical bytes that DataSync transfers over the
|
2780
|
+
# network after compression (if compression is possible). This number
|
2781
|
+
# is typically less than [BytesTransferred][1] unless the data isn't
|
2782
|
+
# compressible.
|
2783
|
+
#
|
2784
|
+
# <note markdown="1"> Not currently supported with [Enhanced mode tasks][2].
|
2785
|
+
#
|
2786
|
+
# </note>
|
2787
|
+
#
|
2788
|
+
#
|
2789
|
+
#
|
2790
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-BytesTransferred
|
2791
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
2667
2792
|
# @return [Integer]
|
2668
2793
|
#
|
2669
2794
|
# @!attribute [rw] result
|
@@ -2681,10 +2806,10 @@ module Aws::DataSync
|
|
2681
2806
|
# @return [Types::TaskReportConfig]
|
2682
2807
|
#
|
2683
2808
|
# @!attribute [rw] files_deleted
|
2684
|
-
# The number of files, objects, and directories that DataSync
|
2685
|
-
# in your destination location. If you don't [configure your
|
2686
|
-
# to delete data in the destination that isn't in the
|
2687
|
-
# value is always `0`.
|
2809
|
+
# The number of files, objects, and directories that DataSync actually
|
2810
|
+
# deletes in your destination location. If you don't [configure your
|
2811
|
+
# task][1] to delete data in the destination that isn't in the
|
2812
|
+
# source, the value is always `0`.
|
2688
2813
|
#
|
2689
2814
|
#
|
2690
2815
|
#
|
@@ -2692,12 +2817,12 @@ module Aws::DataSync
|
|
2692
2817
|
# @return [Integer]
|
2693
2818
|
#
|
2694
2819
|
# @!attribute [rw] files_skipped
|
2695
|
-
# The number of files, objects, and directories that DataSync
|
2820
|
+
# The number of files, objects, and directories that DataSync skips
|
2696
2821
|
# during your transfer.
|
2697
2822
|
# @return [Integer]
|
2698
2823
|
#
|
2699
2824
|
# @!attribute [rw] files_verified
|
2700
|
-
# The number of files, objects, and directories that DataSync
|
2825
|
+
# The number of files, objects, and directories that DataSync verifies
|
2701
2826
|
# during your transfer.
|
2702
2827
|
#
|
2703
2828
|
# <note markdown="1"> When you configure your task to [verify only the data that's
|
@@ -2721,8 +2846,8 @@ module Aws::DataSync
|
|
2721
2846
|
# @return [Types::ReportResult]
|
2722
2847
|
#
|
2723
2848
|
# @!attribute [rw] estimated_files_to_delete
|
2724
|
-
# The
|
2725
|
-
#
|
2849
|
+
# The number of files, objects, and directories that DataSync expects
|
2850
|
+
# to delete in your destination location. If you don't [configure
|
2726
2851
|
# your task][1] to delete data in the destination that isn't in the
|
2727
2852
|
# source, the value is always `0`.
|
2728
2853
|
#
|
@@ -2731,6 +2856,59 @@ module Aws::DataSync
|
|
2731
2856
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html
|
2732
2857
|
# @return [Integer]
|
2733
2858
|
#
|
2859
|
+
# @!attribute [rw] task_mode
|
2860
|
+
# The task mode that you're using. For more information, see
|
2861
|
+
# [Choosing a task mode for your data transfer][1].
|
2862
|
+
#
|
2863
|
+
#
|
2864
|
+
#
|
2865
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
2866
|
+
# @return [String]
|
2867
|
+
#
|
2868
|
+
# @!attribute [rw] files_prepared
|
2869
|
+
# The number of objects that DataSync will attempt to transfer after
|
2870
|
+
# comparing your source and destination locations.
|
2871
|
+
#
|
2872
|
+
# <note markdown="1"> Applies only to [Enhanced mode tasks][1].
|
2873
|
+
#
|
2874
|
+
# </note>
|
2875
|
+
#
|
2876
|
+
# This metric isn't applicable if you configure your task to
|
2877
|
+
# [transfer all data][2]. In that scenario, DataSync copies everything
|
2878
|
+
# from the source to the destination without comparing differences
|
2879
|
+
# between the locations.
|
2880
|
+
#
|
2881
|
+
#
|
2882
|
+
#
|
2883
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
2884
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-transfer-mode
|
2885
|
+
# @return [Integer]
|
2886
|
+
#
|
2887
|
+
# @!attribute [rw] files_listed
|
2888
|
+
# The number of objects that DataSync finds at your locations.
|
2889
|
+
#
|
2890
|
+
# <note markdown="1"> Applies only to [Enhanced mode tasks][1].
|
2891
|
+
#
|
2892
|
+
# </note>
|
2893
|
+
#
|
2894
|
+
#
|
2895
|
+
#
|
2896
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
2897
|
+
# @return [Types::TaskExecutionFilesListedDetail]
|
2898
|
+
#
|
2899
|
+
# @!attribute [rw] files_failed
|
2900
|
+
# The number of objects that DataSync fails to prepare, transfer,
|
2901
|
+
# verify, and delete during your task execution.
|
2902
|
+
#
|
2903
|
+
# <note markdown="1"> Applies only to [Enhanced mode tasks][1].
|
2904
|
+
#
|
2905
|
+
# </note>
|
2906
|
+
#
|
2907
|
+
#
|
2908
|
+
#
|
2909
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
2910
|
+
# @return [Types::TaskExecutionFilesFailedDetail]
|
2911
|
+
#
|
2734
2912
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskExecutionResponse AWS API Documentation
|
2735
2913
|
#
|
2736
2914
|
class DescribeTaskExecutionResponse < Struct.new(
|
@@ -2753,7 +2931,11 @@ module Aws::DataSync
|
|
2753
2931
|
:files_skipped,
|
2754
2932
|
:files_verified,
|
2755
2933
|
:report_result,
|
2756
|
-
:estimated_files_to_delete
|
2934
|
+
:estimated_files_to_delete,
|
2935
|
+
:task_mode,
|
2936
|
+
:files_prepared,
|
2937
|
+
:files_listed,
|
2938
|
+
:files_failed)
|
2757
2939
|
SENSITIVE = []
|
2758
2940
|
include Aws::Structure
|
2759
2941
|
end
|
@@ -2808,12 +2990,12 @@ module Aws::DataSync
|
|
2808
2990
|
# The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for
|
2809
2991
|
# monitoring your task.
|
2810
2992
|
#
|
2811
|
-
# For more information, see [Monitoring
|
2812
|
-
#
|
2993
|
+
# For more information, see [Monitoring data transfers with CloudWatch
|
2994
|
+
# Logs][1].
|
2813
2995
|
#
|
2814
2996
|
#
|
2815
2997
|
#
|
2816
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/
|
2998
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html
|
2817
2999
|
# @return [String]
|
2818
3000
|
#
|
2819
3001
|
# @!attribute [rw] source_network_interface_arns
|
@@ -2923,6 +3105,15 @@ module Aws::DataSync
|
|
2923
3105
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
|
2924
3106
|
# @return [Types::TaskScheduleDetails]
|
2925
3107
|
#
|
3108
|
+
# @!attribute [rw] task_mode
|
3109
|
+
# The task mode that you're using. For more information, see
|
3110
|
+
# [Choosing a task mode for your data transfer][1].
|
3111
|
+
#
|
3112
|
+
#
|
3113
|
+
#
|
3114
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
3115
|
+
# @return [String]
|
3116
|
+
#
|
2926
3117
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskResponse AWS API Documentation
|
2927
3118
|
#
|
2928
3119
|
class DescribeTaskResponse < Struct.new(
|
@@ -2944,7 +3135,8 @@ module Aws::DataSync
|
|
2944
3135
|
:includes,
|
2945
3136
|
:manifest_config,
|
2946
3137
|
:task_report_config,
|
2947
|
-
:schedule_details
|
3138
|
+
:schedule_details,
|
3139
|
+
:task_mode)
|
2948
3140
|
SENSITIVE = []
|
2949
3141
|
include Aws::Structure
|
2950
3142
|
end
|
@@ -2995,8 +3187,12 @@ module Aws::DataSync
|
|
2995
3187
|
include Aws::Structure
|
2996
3188
|
end
|
2997
3189
|
|
2998
|
-
# The subnet and security groups that DataSync uses to
|
2999
|
-
# Amazon EFS file system.
|
3190
|
+
# The subnet and security groups that DataSync uses to connect to one of
|
3191
|
+
# your Amazon EFS file system's [mount targets][1].
|
3192
|
+
#
|
3193
|
+
#
|
3194
|
+
#
|
3195
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html
|
3000
3196
|
#
|
3001
3197
|
# @!attribute [rw] subnet_arn
|
3002
3198
|
# Specifies the ARN of a subnet where DataSync creates the [network
|
@@ -4129,12 +4325,19 @@ module Aws::DataSync
|
|
4129
4325
|
include Aws::Structure
|
4130
4326
|
end
|
4131
4327
|
|
4132
|
-
# The DataSync agents that
|
4133
|
-
#
|
4328
|
+
# The DataSync agents that can connect to your Network File System (NFS)
|
4329
|
+
# file server.
|
4134
4330
|
#
|
4135
4331
|
# @!attribute [rw] agent_arns
|
4136
|
-
# The Amazon Resource Names (ARNs) of the agents
|
4137
|
-
#
|
4332
|
+
# The Amazon Resource Names (ARNs) of the DataSync agents that can
|
4333
|
+
# connect to your NFS file server.
|
4334
|
+
#
|
4335
|
+
# You can specify more than one agent. For more information, see
|
4336
|
+
# [Using multiple DataSync agents][1].
|
4337
|
+
#
|
4338
|
+
#
|
4339
|
+
#
|
4340
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#multiple-agents
|
4138
4341
|
# @return [Array<String>]
|
4139
4342
|
#
|
4140
4343
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/OnPremConfig AWS API Documentation
|
@@ -4162,39 +4365,50 @@ module Aws::DataSync
|
|
4162
4365
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
4163
4366
|
#
|
4164
4367
|
# @!attribute [rw] verify_mode
|
4165
|
-
# Specifies
|
4166
|
-
#
|
4368
|
+
# Specifies if and how DataSync checks the integrity of your data at
|
4369
|
+
# the end of your transfer.
|
4167
4370
|
#
|
4168
4371
|
# * `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
|
4372
|
+
# checksum of transferred data (including metadata) at the source
|
4373
|
+
# location. At the end of the transfer, DataSync then compares this
|
4374
|
+
# checksum to the checksum calculated on that data at the
|
4375
|
+
# destination.
|
4376
|
+
#
|
4377
|
+
# <note markdown="1"> This is the default option for [Enhanced mode tasks][1].
|
4378
|
+
#
|
4379
|
+
# </note>
|
4172
4380
|
#
|
4173
4381
|
# We recommend this option when transferring to S3 Glacier Flexible
|
4174
4382
|
# Retrieval or S3 Glacier Deep Archive storage classes. For more
|
4175
4383
|
# information, see [Storage class considerations with Amazon S3
|
4176
|
-
# locations][
|
4384
|
+
# locations][2].
|
4177
4385
|
#
|
4178
|
-
# * `POINT_IN_TIME_CONSISTENT`
|
4179
|
-
#
|
4180
|
-
#
|
4386
|
+
# * `POINT_IN_TIME_CONSISTENT` - At the end of the transfer, DataSync
|
4387
|
+
# checks the entire source and destination to verify that both
|
4388
|
+
# locations are fully synchronized.
|
4181
4389
|
#
|
4182
|
-
#
|
4390
|
+
# <note markdown="1"> The is the default option for [Basic mode tasks][1] and isn't
|
4391
|
+
# currently supported with Enhanced mode tasks.
|
4392
|
+
#
|
4393
|
+
# </note>
|
4394
|
+
#
|
4395
|
+
# If you use a [manifest][3], DataSync only scans and verifies
|
4183
4396
|
# what's listed in the manifest.
|
4184
4397
|
#
|
4185
4398
|
# You can't use this option when transferring to S3 Glacier
|
4186
4399
|
# Flexible Retrieval or S3 Glacier Deep Archive storage classes. For
|
4187
4400
|
# more information, see [Storage class considerations with Amazon S3
|
4188
|
-
# locations][
|
4401
|
+
# locations][2].
|
4189
4402
|
#
|
4190
|
-
# * `NONE` - DataSync
|
4191
|
-
#
|
4192
|
-
#
|
4403
|
+
# * `NONE` - DataSync performs data integrity checks only during your
|
4404
|
+
# transfer. Unlike other options, there's no additional
|
4405
|
+
# verification at the end of your transfer.
|
4193
4406
|
#
|
4194
4407
|
#
|
4195
4408
|
#
|
4196
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/
|
4197
|
-
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/
|
4409
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
4410
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
|
4411
|
+
# [3]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
|
4198
4412
|
# @return [String]
|
4199
4413
|
#
|
4200
4414
|
# @!attribute [rw] overwrite_mode
|
@@ -4230,7 +4444,7 @@ module Aws::DataSync
|
|
4230
4444
|
#
|
4231
4445
|
# * `BEST_EFFORT` (default) - DataSync attempts to preserve the
|
4232
4446
|
# original `Atime` attribute on all source files (that is, the
|
4233
|
-
# version before the `PREPARING`
|
4447
|
+
# version before the `PREPARING` steps of the task execution). This
|
4234
4448
|
# option is recommended.
|
4235
4449
|
#
|
4236
4450
|
# * `NONE` - Ignores `Atime`.
|
@@ -4245,7 +4459,7 @@ module Aws::DataSync
|
|
4245
4459
|
#
|
4246
4460
|
# @!attribute [rw] mtime
|
4247
4461
|
# Specifies whether to preserve metadata indicating the last time that
|
4248
|
-
# a file was written to before the `PREPARING`
|
4462
|
+
# a file was written to before the `PREPARING` step of your task
|
4249
4463
|
# execution. This option is required when you need to run the a task
|
4250
4464
|
# more than once.
|
4251
4465
|
#
|
@@ -4285,11 +4499,12 @@ module Aws::DataSync
|
|
4285
4499
|
#
|
4286
4500
|
# * `NONE` - Ignores UID and GID.
|
4287
4501
|
#
|
4288
|
-
# For more information, see [
|
4502
|
+
# For more information, see [Understanding how DataSync handles file
|
4503
|
+
# and object metadata][1].
|
4289
4504
|
#
|
4290
4505
|
#
|
4291
4506
|
#
|
4292
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/
|
4507
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html
|
4293
4508
|
# @return [String]
|
4294
4509
|
#
|
4295
4510
|
# @!attribute [rw] preserve_deleted_files
|
@@ -4338,7 +4553,8 @@ module Aws::DataSync
|
|
4338
4553
|
# Specifies which users or groups can access a file for a specific
|
4339
4554
|
# purpose such as reading, writing, or execution of the file.
|
4340
4555
|
#
|
4341
|
-
# For more information, see [
|
4556
|
+
# For more information, see [Understanding how DataSync handles file
|
4557
|
+
# and object metadata][1].
|
4342
4558
|
#
|
4343
4559
|
# * `PRESERVE` (default) - Preserves POSIX-style permissions, which is
|
4344
4560
|
# recommended.
|
@@ -4351,13 +4567,21 @@ module Aws::DataSync
|
|
4351
4567
|
#
|
4352
4568
|
#
|
4353
4569
|
#
|
4354
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/
|
4570
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html
|
4355
4571
|
# @return [String]
|
4356
4572
|
#
|
4357
4573
|
# @!attribute [rw] bytes_per_second
|
4358
4574
|
# Limits the bandwidth used by a DataSync task. For example, if you
|
4359
4575
|
# want DataSync to use a maximum of 1 MB, set this value to `1048576`
|
4360
4576
|
# (`=1024*1024`).
|
4577
|
+
#
|
4578
|
+
# <note markdown="1"> Not applicable to [Enhanced mode tasks][1].
|
4579
|
+
#
|
4580
|
+
# </note>
|
4581
|
+
#
|
4582
|
+
#
|
4583
|
+
#
|
4584
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
4361
4585
|
# @return [Integer]
|
4362
4586
|
#
|
4363
4587
|
# @!attribute [rw] task_queueing
|
@@ -4389,14 +4613,15 @@ module Aws::DataSync
|
|
4389
4613
|
# @return [String]
|
4390
4614
|
#
|
4391
4615
|
# @!attribute [rw] transfer_mode
|
4392
|
-
#
|
4393
|
-
# that
|
4394
|
-
# transfers all
|
4395
|
-
#
|
4616
|
+
# Specifies whether DataSync transfers only the data (including
|
4617
|
+
# metadata) that differs between locations following an initial copy
|
4618
|
+
# or transfers all data every time you run the task. If you're
|
4619
|
+
# planning on recurring transfers, you might only want to transfer
|
4620
|
+
# what's changed since your previous task execution.
|
4396
4621
|
#
|
4397
|
-
# * `CHANGED` (default) -
|
4398
|
-
#
|
4399
|
-
# destination location.
|
4622
|
+
# * `CHANGED` (default) - After your initial full transfer, DataSync
|
4623
|
+
# copies only the data and metadata that differs between the source
|
4624
|
+
# and destination location.
|
4400
4625
|
#
|
4401
4626
|
# * `ALL` - DataSync copies everything in the source to the
|
4402
4627
|
# destination without comparing differences between the locations.
|
@@ -4408,8 +4633,8 @@ module Aws::DataSync
|
|
4408
4633
|
#
|
4409
4634
|
# This value is only used for transfers between SMB and Amazon FSx for
|
4410
4635
|
# Windows File Server locations or between two FSx for Windows File
|
4411
|
-
# Server locations. For more information, see [how
|
4412
|
-
# metadata][1].
|
4636
|
+
# Server locations. For more information, see [Understanding how
|
4637
|
+
# DataSync handles file and object metadata][1].
|
4413
4638
|
#
|
4414
4639
|
# * `OWNER_DACL` (default) - For each copied object, DataSync copies
|
4415
4640
|
# the following metadata:
|
@@ -4447,7 +4672,7 @@ module Aws::DataSync
|
|
4447
4672
|
#
|
4448
4673
|
#
|
4449
4674
|
#
|
4450
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/
|
4675
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html
|
4451
4676
|
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions
|
4452
4677
|
# [3]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions
|
4453
4678
|
# [4]: https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb
|
@@ -4546,7 +4771,7 @@ module Aws::DataSync
|
|
4546
4771
|
#
|
4547
4772
|
#
|
4548
4773
|
#
|
4549
|
-
# [1]: https://docs.aws.amazon.com/vpc/latest/
|
4774
|
+
# [1]: https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html
|
4550
4775
|
# @return [String]
|
4551
4776
|
#
|
4552
4777
|
# @!attribute [rw] subnet_arns
|
@@ -5270,6 +5495,96 @@ module Aws::DataSync
|
|
5270
5495
|
#
|
5271
5496
|
class TagResourceResponse < Aws::EmptyStructure; end
|
5272
5497
|
|
5498
|
+
# The number of objects that DataSync fails to prepare, transfer,
|
5499
|
+
# verify, and delete during your task execution.
|
5500
|
+
#
|
5501
|
+
# <note markdown="1"> Applies only to [Enhanced mode tasks][1].
|
5502
|
+
#
|
5503
|
+
# </note>
|
5504
|
+
#
|
5505
|
+
#
|
5506
|
+
#
|
5507
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
5508
|
+
#
|
5509
|
+
# @!attribute [rw] prepare
|
5510
|
+
# The number of objects that DataSync fails to prepare during your
|
5511
|
+
# task execution.
|
5512
|
+
# @return [Integer]
|
5513
|
+
#
|
5514
|
+
# @!attribute [rw] transfer
|
5515
|
+
# The number of objects that DataSync fails to transfer during your
|
5516
|
+
# task execution.
|
5517
|
+
# @return [Integer]
|
5518
|
+
#
|
5519
|
+
# @!attribute [rw] verify
|
5520
|
+
# The number of objects that DataSync fails to verify during your task
|
5521
|
+
# execution.
|
5522
|
+
# @return [Integer]
|
5523
|
+
#
|
5524
|
+
# @!attribute [rw] delete
|
5525
|
+
# The number of objects that DataSync fails to delete during your task
|
5526
|
+
# execution.
|
5527
|
+
# @return [Integer]
|
5528
|
+
#
|
5529
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskExecutionFilesFailedDetail AWS API Documentation
|
5530
|
+
#
|
5531
|
+
class TaskExecutionFilesFailedDetail < Struct.new(
|
5532
|
+
:prepare,
|
5533
|
+
:transfer,
|
5534
|
+
:verify,
|
5535
|
+
:delete)
|
5536
|
+
SENSITIVE = []
|
5537
|
+
include Aws::Structure
|
5538
|
+
end
|
5539
|
+
|
5540
|
+
# The number of objects that DataSync finds at your locations.
|
5541
|
+
#
|
5542
|
+
# <note markdown="1"> Applies only to [Enhanced mode tasks][1].
|
5543
|
+
#
|
5544
|
+
# </note>
|
5545
|
+
#
|
5546
|
+
#
|
5547
|
+
#
|
5548
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
5549
|
+
#
|
5550
|
+
# @!attribute [rw] at_source
|
5551
|
+
# The number of objects that DataSync finds at your source location.
|
5552
|
+
#
|
5553
|
+
# * With a [manifest][1], DataSync lists only what's in your manifest
|
5554
|
+
# (and not everything at your source location).
|
5555
|
+
#
|
5556
|
+
# * With an include [filter][2], DataSync lists only what matches the
|
5557
|
+
# filter at your source location.
|
5558
|
+
#
|
5559
|
+
# * With an exclude filter, DataSync lists everything at your source
|
5560
|
+
# location before applying the filter.
|
5561
|
+
#
|
5562
|
+
#
|
5563
|
+
#
|
5564
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html
|
5565
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
|
5566
|
+
# @return [Integer]
|
5567
|
+
#
|
5568
|
+
# @!attribute [rw] at_destination_for_delete
|
5569
|
+
# The number of objects that DataSync finds at your destination
|
5570
|
+
# location. This metric is only applicable if you [configure your
|
5571
|
+
# task][1] to delete data in the destination that isn't in the
|
5572
|
+
# source.
|
5573
|
+
#
|
5574
|
+
#
|
5575
|
+
#
|
5576
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-file-object-handling
|
5577
|
+
# @return [Integer]
|
5578
|
+
#
|
5579
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskExecutionFilesListedDetail AWS API Documentation
|
5580
|
+
#
|
5581
|
+
class TaskExecutionFilesListedDetail < Struct.new(
|
5582
|
+
:at_source,
|
5583
|
+
:at_destination_for_delete)
|
5584
|
+
SENSITIVE = []
|
5585
|
+
include Aws::Structure
|
5586
|
+
end
|
5587
|
+
|
5273
5588
|
# Represents a single entry in a list of DataSync task executions
|
5274
5589
|
# that's returned with the [ListTaskExecutions][1] operation.
|
5275
5590
|
#
|
@@ -5290,60 +5605,118 @@ module Aws::DataSync
|
|
5290
5605
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/understand-task-statuses.html#understand-task-execution-statuses
|
5291
5606
|
# @return [String]
|
5292
5607
|
#
|
5608
|
+
# @!attribute [rw] task_mode
|
5609
|
+
# The task mode that you're using. For more information, see
|
5610
|
+
# [Choosing a task mode for your data transfer][1].
|
5611
|
+
#
|
5612
|
+
#
|
5613
|
+
#
|
5614
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
5615
|
+
# @return [String]
|
5616
|
+
#
|
5293
5617
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskExecutionListEntry AWS API Documentation
|
5294
5618
|
#
|
5295
5619
|
class TaskExecutionListEntry < Struct.new(
|
5296
5620
|
:task_execution_arn,
|
5297
|
-
:status
|
5621
|
+
:status,
|
5622
|
+
:task_mode)
|
5298
5623
|
SENSITIVE = []
|
5299
5624
|
include Aws::Structure
|
5300
5625
|
end
|
5301
5626
|
|
5302
|
-
#
|
5303
|
-
#
|
5304
|
-
# status of the task execution, and the errors encountered.
|
5627
|
+
# Provides detailed information about the result of your DataSync task
|
5628
|
+
# execution.
|
5305
5629
|
#
|
5306
5630
|
# @!attribute [rw] prepare_duration
|
5307
|
-
# The
|
5308
|
-
#
|
5631
|
+
# The time in milliseconds that your task execution was in the
|
5632
|
+
# `PREPARING` step. For more information, see [Task execution
|
5633
|
+
# statuses][1].
|
5634
|
+
#
|
5635
|
+
# For Enhanced mode tasks, the value is always `0`. For more
|
5636
|
+
# information, see [How DataSync prepares your data transfer][2].
|
5637
|
+
#
|
5638
|
+
#
|
5639
|
+
#
|
5640
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses
|
5641
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-datasync-prepares
|
5309
5642
|
# @return [Integer]
|
5310
5643
|
#
|
5311
5644
|
# @!attribute [rw] prepare_status
|
5312
|
-
# The status of the PREPARING
|
5645
|
+
# The status of the `PREPARING` step for your task execution. For more
|
5646
|
+
# information, see [Task execution statuses][1].
|
5647
|
+
#
|
5648
|
+
#
|
5649
|
+
#
|
5650
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses
|
5313
5651
|
# @return [String]
|
5314
5652
|
#
|
5315
5653
|
# @!attribute [rw] total_duration
|
5316
|
-
# The
|
5317
|
-
# file from the source to the destination location.
|
5654
|
+
# The time in milliseconds that your task execution ran.
|
5318
5655
|
# @return [Integer]
|
5319
5656
|
#
|
5320
5657
|
# @!attribute [rw] transfer_duration
|
5321
|
-
# The
|
5322
|
-
# TRANSFERRING
|
5658
|
+
# The time in milliseconds that your task execution was in the
|
5659
|
+
# `TRANSFERRING` step. For more information, see [Task execution
|
5660
|
+
# statuses][1].
|
5661
|
+
#
|
5662
|
+
# For Enhanced mode tasks, the value is always `0`. For more
|
5663
|
+
# information, see [How DataSync transfers your data][2].
|
5664
|
+
#
|
5665
|
+
#
|
5666
|
+
#
|
5667
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses
|
5668
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-datasync-transfers
|
5323
5669
|
# @return [Integer]
|
5324
5670
|
#
|
5325
5671
|
# @!attribute [rw] transfer_status
|
5326
|
-
# The status of the TRANSFERRING
|
5672
|
+
# The status of the `TRANSFERRING` step for your task execution. For
|
5673
|
+
# more information, see [Task execution statuses][1].
|
5674
|
+
#
|
5675
|
+
#
|
5676
|
+
#
|
5677
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses
|
5327
5678
|
# @return [String]
|
5328
5679
|
#
|
5329
5680
|
# @!attribute [rw] verify_duration
|
5330
|
-
# The
|
5331
|
-
#
|
5681
|
+
# The time in milliseconds that your task execution was in the
|
5682
|
+
# `VERIFYING` step. For more information, see [Task execution
|
5683
|
+
# statuses][1].
|
5684
|
+
#
|
5685
|
+
# For Enhanced mode tasks, the value is always `0`. For more
|
5686
|
+
# information, see [How DataSync verifies your data's integrity][2].
|
5687
|
+
#
|
5688
|
+
#
|
5689
|
+
#
|
5690
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses
|
5691
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-verifying-works
|
5332
5692
|
# @return [Integer]
|
5333
5693
|
#
|
5334
5694
|
# @!attribute [rw] verify_status
|
5335
|
-
# The status of the VERIFYING
|
5695
|
+
# The status of the `VERIFYING` step for your task execution. For more
|
5696
|
+
# information, see [Task execution statuses][1].
|
5697
|
+
#
|
5698
|
+
#
|
5699
|
+
#
|
5700
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses
|
5336
5701
|
# @return [String]
|
5337
5702
|
#
|
5338
5703
|
# @!attribute [rw] error_code
|
5339
|
-
#
|
5340
|
-
# can use this
|
5704
|
+
# An error that DataSync encountered during your task execution. You
|
5705
|
+
# can use this information to help [troubleshoot issues][1].
|
5706
|
+
#
|
5707
|
+
#
|
5708
|
+
#
|
5709
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html
|
5341
5710
|
# @return [String]
|
5342
5711
|
#
|
5343
5712
|
# @!attribute [rw] error_detail
|
5344
|
-
#
|
5345
|
-
# task execution. You can use this information to help
|
5346
|
-
# issues.
|
5713
|
+
# The detailed description of an error that DataSync encountered
|
5714
|
+
# during your task execution. You can use this information to help
|
5715
|
+
# [troubleshoot issues][1].
|
5716
|
+
#
|
5717
|
+
#
|
5718
|
+
#
|
5719
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html
|
5347
5720
|
# @return [String]
|
5348
5721
|
#
|
5349
5722
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskExecutionResultDetail AWS API Documentation
|
@@ -5420,12 +5793,22 @@ module Aws::DataSync
|
|
5420
5793
|
# The name of the task.
|
5421
5794
|
# @return [String]
|
5422
5795
|
#
|
5796
|
+
# @!attribute [rw] task_mode
|
5797
|
+
# The task mode that you're using. For more information, see
|
5798
|
+
# [Choosing a task mode for your data transfer][1].
|
5799
|
+
#
|
5800
|
+
#
|
5801
|
+
#
|
5802
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html
|
5803
|
+
# @return [String]
|
5804
|
+
#
|
5423
5805
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskListEntry AWS API Documentation
|
5424
5806
|
#
|
5425
5807
|
class TaskListEntry < Struct.new(
|
5426
5808
|
:task_arn,
|
5427
5809
|
:status,
|
5428
|
-
:name
|
5810
|
+
:name,
|
5811
|
+
:task_mode)
|
5429
5812
|
SENSITIVE = []
|
5430
5813
|
include Aws::Structure
|
5431
5814
|
end
|
@@ -5511,13 +5894,26 @@ module Aws::DataSync
|
|
5511
5894
|
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
|
5512
5895
|
#
|
5513
5896
|
# @!attribute [rw] schedule_expression
|
5514
|
-
# Specifies your task schedule by using a cron
|
5515
|
-
#
|
5516
|
-
#
|
5897
|
+
# Specifies your task schedule by using a cron or rate expression.
|
5898
|
+
#
|
5899
|
+
# Use cron expressions for task schedules that run on a specific time
|
5900
|
+
# and day. For example, the following cron expression creates a task
|
5901
|
+
# schedule that runs at 8 AM on the first Wednesday of every month:
|
5902
|
+
#
|
5903
|
+
# `cron(0 8 * * 3#1)`
|
5904
|
+
#
|
5905
|
+
# Use rate expressions for task schedules that run on a regular
|
5906
|
+
# interval. For example, the following rate expression creates a task
|
5907
|
+
# schedule that runs every 12 hours:
|
5908
|
+
#
|
5909
|
+
# `rate(12 hours)`
|
5517
5910
|
#
|
5911
|
+
# For information about cron and rate expression syntax, see the [
|
5912
|
+
# *Amazon EventBridge User Guide* ][1].
|
5518
5913
|
#
|
5519
5914
|
#
|
5520
|
-
#
|
5915
|
+
#
|
5916
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html
|
5521
5917
|
# @return [String]
|
5522
5918
|
#
|
5523
5919
|
# @!attribute [rw] status
|
@@ -5839,7 +6235,8 @@ module Aws::DataSync
|
|
5839
6235
|
# @return [String]
|
5840
6236
|
#
|
5841
6237
|
# @!attribute [rw] agent_arns
|
5842
|
-
# The ARNs of the agents that
|
6238
|
+
# The Amazon Resource Names (ARNs) of the DataSync agents that can
|
6239
|
+
# connect to your HDFS cluster.
|
5843
6240
|
# @return [Array<String>]
|
5844
6241
|
#
|
5845
6242
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationHdfsRequest AWS API Documentation
|
@@ -5885,8 +6282,8 @@ module Aws::DataSync
|
|
5885
6282
|
# @return [String]
|
5886
6283
|
#
|
5887
6284
|
# @!attribute [rw] on_prem_config
|
5888
|
-
# The DataSync agents that
|
5889
|
-
# (NFS)
|
6285
|
+
# The DataSync agents that can connect to your Network File System
|
6286
|
+
# (NFS) file server.
|
5890
6287
|
# @return [Types::OnPremConfig]
|
5891
6288
|
#
|
5892
6289
|
# @!attribute [rw] mount_options
|
@@ -5942,7 +6339,7 @@ module Aws::DataSync
|
|
5942
6339
|
#
|
5943
6340
|
# @!attribute [rw] agent_arns
|
5944
6341
|
# Specifies the Amazon Resource Names (ARNs) of the DataSync agents
|
5945
|
-
# that can
|
6342
|
+
# that can connect with your object storage system.
|
5946
6343
|
# @return [Array<String>]
|
5947
6344
|
#
|
5948
6345
|
# @!attribute [rw] server_certificate
|
@@ -6056,9 +6453,9 @@ module Aws::DataSync
|
|
6056
6453
|
# @return [String]
|
6057
6454
|
#
|
6058
6455
|
# @!attribute [rw] agent_arns
|
6059
|
-
# Specifies the DataSync agent (or agents)
|
6060
|
-
#
|
6061
|
-
#
|
6456
|
+
# Specifies the DataSync agent (or agents) that can connect to your
|
6457
|
+
# SMB file server. You specify an agent by using its Amazon Resource
|
6458
|
+
# Name (ARN).
|
6062
6459
|
# @return [Array<String>]
|
6063
6460
|
#
|
6064
6461
|
# @!attribute [rw] mount_options
|
@@ -6220,6 +6617,18 @@ module Aws::DataSync
|
|
6220
6617
|
# @!attribute [rw] cloud_watch_log_group_arn
|
6221
6618
|
# Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log
|
6222
6619
|
# group for monitoring your task.
|
6620
|
+
#
|
6621
|
+
# For Enhanced mode tasks, you must use `/aws/datasync` as your log
|
6622
|
+
# group name. For example:
|
6623
|
+
#
|
6624
|
+
# `arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync:*`
|
6625
|
+
#
|
6626
|
+
# For more information, see [Monitoring data transfers with CloudWatch
|
6627
|
+
# Logs][1].
|
6628
|
+
#
|
6629
|
+
#
|
6630
|
+
#
|
6631
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html
|
6223
6632
|
# @return [String]
|
6224
6633
|
#
|
6225
6634
|
# @!attribute [rw] includes
|