aws-sdk-datasync 1.51.0 → 1.52.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.
@@ -42,13 +42,6 @@ module Aws::DataSync
42
42
 
43
43
  # CancelTaskExecutionRequest
44
44
  #
45
- # @note When making an API call, you may pass CancelTaskExecutionRequest
46
- # data as a hash:
47
- #
48
- # {
49
- # task_execution_arn: "TaskExecutionArn", # required
50
- # }
51
- #
52
45
  # @!attribute [rw] task_execution_arn
53
46
  # The Amazon Resource Name (ARN) of the task execution to stop.
54
47
  # @return [String]
@@ -67,23 +60,6 @@ module Aws::DataSync
67
60
 
68
61
  # CreateAgentRequest
69
62
  #
70
- # @note When making an API call, you may pass CreateAgentRequest
71
- # data as a hash:
72
- #
73
- # {
74
- # activation_key: "ActivationKey", # required
75
- # agent_name: "TagValue",
76
- # tags: [
77
- # {
78
- # key: "TagKey", # required
79
- # value: "TagValue",
80
- # },
81
- # ],
82
- # vpc_endpoint_id: "VpcEndpointId",
83
- # subnet_arns: ["Ec2SubnetArn"],
84
- # security_group_arns: ["Ec2SecurityGroupArn"],
85
- # }
86
- #
87
63
  # @!attribute [rw] activation_key
88
64
  # Your agent activation key. You can get the activation key either by
89
65
  # sending an HTTP GET request with redirects that enable you to get
@@ -183,27 +159,6 @@ module Aws::DataSync
183
159
 
184
160
  # CreateLocationEfsRequest
185
161
  #
186
- # @note When making an API call, you may pass CreateLocationEfsRequest
187
- # data as a hash:
188
- #
189
- # {
190
- # subdirectory: "EfsSubdirectory",
191
- # efs_filesystem_arn: "EfsFilesystemArn", # required
192
- # ec2_config: { # required
193
- # subnet_arn: "Ec2SubnetArn", # required
194
- # security_group_arns: ["Ec2SecurityGroupArn"], # required
195
- # },
196
- # tags: [
197
- # {
198
- # key: "TagKey", # required
199
- # value: "TagValue",
200
- # },
201
- # ],
202
- # access_point_arn: "EfsAccessPointArn",
203
- # file_system_access_role_arn: "IamRoleArn",
204
- # in_transit_encryption: "NONE", # accepts NONE, TLS1_2
205
- # }
206
- #
207
162
  # @!attribute [rw] subdirectory
208
163
  # Specifies a mount path for your Amazon EFS file system. This is
209
164
  # where DataSync reads or writes data (depending on if this is a
@@ -281,21 +236,6 @@ module Aws::DataSync
281
236
  include Aws::Structure
282
237
  end
283
238
 
284
- # @note When making an API call, you may pass CreateLocationFsxLustreRequest
285
- # data as a hash:
286
- #
287
- # {
288
- # fsx_filesystem_arn: "FsxFilesystemArn", # required
289
- # security_group_arns: ["Ec2SecurityGroupArn"], # required
290
- # subdirectory: "FsxLustreSubdirectory",
291
- # tags: [
292
- # {
293
- # key: "TagKey", # required
294
- # value: "TagValue",
295
- # },
296
- # ],
297
- # }
298
- #
299
239
  # @!attribute [rw] fsx_filesystem_arn
300
240
  # The Amazon Resource Name (ARN) for the FSx for Lustre file system.
301
241
  # @return [String]
@@ -342,36 +282,6 @@ module Aws::DataSync
342
282
  include Aws::Structure
343
283
  end
344
284
 
345
- # @note When making an API call, you may pass CreateLocationFsxOntapRequest
346
- # data as a hash:
347
- #
348
- # {
349
- # protocol: { # required
350
- # nfs: {
351
- # mount_options: {
352
- # version: "AUTOMATIC", # accepts AUTOMATIC, NFS3, NFS4_0, NFS4_1
353
- # },
354
- # },
355
- # smb: {
356
- # domain: "SmbDomain",
357
- # mount_options: {
358
- # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
359
- # },
360
- # password: "SmbPassword", # required
361
- # user: "SmbUser", # required
362
- # },
363
- # },
364
- # security_group_arns: ["Ec2SecurityGroupArn"], # required
365
- # storage_virtual_machine_arn: "StorageVirtualMachineArn", # required
366
- # subdirectory: "FsxOntapSubdirectory",
367
- # tags: [
368
- # {
369
- # key: "TagKey", # required
370
- # value: "TagValue",
371
- # },
372
- # ],
373
- # }
374
- #
375
285
  # @!attribute [rw] protocol
376
286
  # Specifies the data transfer protocol that DataSync uses to access
377
287
  # your Amazon FSx file system.
@@ -443,36 +353,6 @@ module Aws::DataSync
443
353
  include Aws::Structure
444
354
  end
445
355
 
446
- # @note When making an API call, you may pass CreateLocationFsxOpenZfsRequest
447
- # data as a hash:
448
- #
449
- # {
450
- # fsx_filesystem_arn: "FsxFilesystemArn", # required
451
- # protocol: { # required
452
- # nfs: {
453
- # mount_options: {
454
- # version: "AUTOMATIC", # accepts AUTOMATIC, NFS3, NFS4_0, NFS4_1
455
- # },
456
- # },
457
- # smb: {
458
- # domain: "SmbDomain",
459
- # mount_options: {
460
- # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
461
- # },
462
- # password: "SmbPassword", # required
463
- # user: "SmbUser", # required
464
- # },
465
- # },
466
- # security_group_arns: ["Ec2SecurityGroupArn"], # required
467
- # subdirectory: "FsxOpenZfsSubdirectory",
468
- # tags: [
469
- # {
470
- # key: "TagKey", # required
471
- # value: "TagValue",
472
- # },
473
- # ],
474
- # }
475
- #
476
356
  # @!attribute [rw] fsx_filesystem_arn
477
357
  # The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.
478
358
  # @return [String]
@@ -524,24 +404,6 @@ module Aws::DataSync
524
404
  include Aws::Structure
525
405
  end
526
406
 
527
- # @note When making an API call, you may pass CreateLocationFsxWindowsRequest
528
- # data as a hash:
529
- #
530
- # {
531
- # subdirectory: "FsxWindowsSubdirectory",
532
- # fsx_filesystem_arn: "FsxFilesystemArn", # required
533
- # security_group_arns: ["Ec2SecurityGroupArn"], # required
534
- # tags: [
535
- # {
536
- # key: "TagKey", # required
537
- # value: "TagValue",
538
- # },
539
- # ],
540
- # user: "SmbUser", # required
541
- # domain: "SmbDomain",
542
- # password: "SmbPassword", # required
543
- # }
544
- #
545
407
  # @!attribute [rw] subdirectory
546
408
  # Specifies a mount path for your file system using forward slashes.
547
409
  # This is where DataSync reads or writes data (depending on if this is
@@ -621,38 +483,6 @@ module Aws::DataSync
621
483
  include Aws::Structure
622
484
  end
623
485
 
624
- # @note When making an API call, you may pass CreateLocationHdfsRequest
625
- # data as a hash:
626
- #
627
- # {
628
- # subdirectory: "HdfsSubdirectory",
629
- # name_nodes: [ # required
630
- # {
631
- # hostname: "HdfsServerHostname", # required
632
- # port: 1, # required
633
- # },
634
- # ],
635
- # block_size: 1,
636
- # replication_factor: 1,
637
- # kms_key_provider_uri: "KmsKeyProviderUri",
638
- # qop_configuration: {
639
- # rpc_protection: "DISABLED", # accepts DISABLED, AUTHENTICATION, INTEGRITY, PRIVACY
640
- # data_transfer_protection: "DISABLED", # accepts DISABLED, AUTHENTICATION, INTEGRITY, PRIVACY
641
- # },
642
- # authentication_type: "SIMPLE", # required, accepts SIMPLE, KERBEROS
643
- # simple_user: "HdfsUser",
644
- # kerberos_principal: "KerberosPrincipal",
645
- # kerberos_keytab: "data",
646
- # kerberos_krb_5_conf: "data",
647
- # agent_arns: ["AgentArn"], # required
648
- # tags: [
649
- # {
650
- # key: "TagKey", # required
651
- # value: "TagValue",
652
- # },
653
- # ],
654
- # }
655
- #
656
486
  # @!attribute [rw] subdirectory
657
487
  # A subdirectory in the HDFS cluster. This subdirectory is used to
658
488
  # read data from or write data to the HDFS cluster. If the
@@ -786,26 +616,6 @@ module Aws::DataSync
786
616
 
787
617
  # CreateLocationNfsRequest
788
618
  #
789
- # @note When making an API call, you may pass CreateLocationNfsRequest
790
- # data as a hash:
791
- #
792
- # {
793
- # subdirectory: "NfsSubdirectory", # required
794
- # server_hostname: "ServerHostname", # required
795
- # on_prem_config: { # required
796
- # agent_arns: ["AgentArn"], # required
797
- # },
798
- # mount_options: {
799
- # version: "AUTOMATIC", # accepts AUTOMATIC, NFS3, NFS4_0, NFS4_1
800
- # },
801
- # tags: [
802
- # {
803
- # key: "TagKey", # required
804
- # value: "TagValue",
805
- # },
806
- # ],
807
- # }
808
- #
809
619
  # @!attribute [rw] subdirectory
810
620
  # The subdirectory in the NFS file system that is used to read data
811
621
  # from the NFS source location or write data to the NFS destination.
@@ -909,27 +719,6 @@ module Aws::DataSync
909
719
 
910
720
  # CreateLocationObjectStorageRequest
911
721
  #
912
- # @note When making an API call, you may pass CreateLocationObjectStorageRequest
913
- # data as a hash:
914
- #
915
- # {
916
- # server_hostname: "ServerHostname", # required
917
- # server_port: 1,
918
- # server_protocol: "HTTPS", # accepts HTTPS, HTTP
919
- # subdirectory: "S3Subdirectory",
920
- # bucket_name: "ObjectStorageBucketName", # required
921
- # access_key: "ObjectStorageAccessKey",
922
- # secret_key: "ObjectStorageSecretKey",
923
- # agent_arns: ["AgentArn"], # required
924
- # tags: [
925
- # {
926
- # key: "TagKey", # required
927
- # value: "TagValue",
928
- # },
929
- # ],
930
- # server_certificate: "data",
931
- # }
932
- #
933
722
  # @!attribute [rw] server_hostname
934
723
  # Specifies the domain name or IP address of the object storage
935
724
  # server. A DataSync agent uses this hostname to mount the object
@@ -1024,25 +813,6 @@ module Aws::DataSync
1024
813
 
1025
814
  # CreateLocationS3Request
1026
815
  #
1027
- # @note When making an API call, you may pass CreateLocationS3Request
1028
- # data as a hash:
1029
- #
1030
- # {
1031
- # subdirectory: "S3Subdirectory",
1032
- # s3_bucket_arn: "S3BucketArn", # required
1033
- # s3_storage_class: "STANDARD", # accepts STANDARD, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
1034
- # s3_config: { # required
1035
- # bucket_access_role_arn: "IamRoleArn", # required
1036
- # },
1037
- # agent_arns: ["AgentArn"],
1038
- # tags: [
1039
- # {
1040
- # key: "TagKey", # required
1041
- # value: "TagValue",
1042
- # },
1043
- # ],
1044
- # }
1045
- #
1046
816
  # @!attribute [rw] subdirectory
1047
817
  # A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon
1048
818
  # S3 is used to read data from the S3 source location or write data to
@@ -1129,27 +899,6 @@ module Aws::DataSync
1129
899
 
1130
900
  # CreateLocationSmbRequest
1131
901
  #
1132
- # @note When making an API call, you may pass CreateLocationSmbRequest
1133
- # data as a hash:
1134
- #
1135
- # {
1136
- # subdirectory: "SmbSubdirectory", # required
1137
- # server_hostname: "ServerHostname", # required
1138
- # user: "SmbUser", # required
1139
- # domain: "SmbDomain",
1140
- # password: "SmbPassword", # required
1141
- # agent_arns: ["AgentArn"], # required
1142
- # mount_options: {
1143
- # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
1144
- # },
1145
- # tags: [
1146
- # {
1147
- # key: "TagKey", # required
1148
- # value: "TagValue",
1149
- # },
1150
- # ],
1151
- # }
1152
- #
1153
902
  # @!attribute [rw] subdirectory
1154
903
  # The subdirectory in the SMB file system that is used to read data
1155
904
  # from the SMB source location or write data to the SMB destination.
@@ -1250,54 +999,6 @@ module Aws::DataSync
1250
999
 
1251
1000
  # CreateTaskRequest
1252
1001
  #
1253
- # @note When making an API call, you may pass CreateTaskRequest
1254
- # data as a hash:
1255
- #
1256
- # {
1257
- # source_location_arn: "LocationArn", # required
1258
- # destination_location_arn: "LocationArn", # required
1259
- # cloud_watch_log_group_arn: "LogGroupArn",
1260
- # name: "TagValue",
1261
- # options: {
1262
- # verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED, NONE
1263
- # overwrite_mode: "ALWAYS", # accepts ALWAYS, NEVER
1264
- # atime: "NONE", # accepts NONE, BEST_EFFORT
1265
- # mtime: "NONE", # accepts NONE, PRESERVE
1266
- # uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
1267
- # gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
1268
- # preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
1269
- # preserve_devices: "NONE", # accepts NONE, PRESERVE
1270
- # posix_permissions: "NONE", # accepts NONE, PRESERVE
1271
- # bytes_per_second: 1,
1272
- # task_queueing: "ENABLED", # accepts ENABLED, DISABLED
1273
- # log_level: "OFF", # accepts OFF, BASIC, TRANSFER
1274
- # transfer_mode: "CHANGED", # accepts CHANGED, ALL
1275
- # security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
1276
- # object_tags: "PRESERVE", # accepts PRESERVE, NONE
1277
- # },
1278
- # excludes: [
1279
- # {
1280
- # filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
1281
- # value: "FilterValue",
1282
- # },
1283
- # ],
1284
- # schedule: {
1285
- # schedule_expression: "ScheduleExpressionCron", # required
1286
- # },
1287
- # tags: [
1288
- # {
1289
- # key: "TagKey", # required
1290
- # value: "TagValue",
1291
- # },
1292
- # ],
1293
- # includes: [
1294
- # {
1295
- # filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
1296
- # value: "FilterValue",
1297
- # },
1298
- # ],
1299
- # }
1300
- #
1301
1002
  # @!attribute [rw] source_location_arn
1302
1003
  # The Amazon Resource Name (ARN) of the source location for the task.
1303
1004
  # @return [String]
@@ -1318,16 +1019,12 @@ module Aws::DataSync
1318
1019
  # @return [String]
1319
1020
  #
1320
1021
  # @!attribute [rw] options
1321
- # The set of configuration options that control the behavior of a
1322
- # single execution of the task that occurs when you call
1323
- # `StartTaskExecution`. You can configure these options to preserve
1324
- # metadata such as user ID (UID) and group ID (GID), file permissions,
1325
- # data integrity verification, and so on.
1022
+ # Specifies the configuration options for a task. Some options include
1023
+ # preserving file or object metadata and verifying data integrity.
1326
1024
  #
1327
- # For each individual task execution, you can override these options
1328
- # by specifying the `OverrideOptions` before starting the task
1329
- # execution. For more information, see the [StartTaskExecution][1]
1330
- # operation.
1025
+ # You can also override these options before starting an individual
1026
+ # run of a task (also known as a *task execution*). For more
1027
+ # information, see [StartTaskExecution][1].
1331
1028
  #
1332
1029
  #
1333
1030
  #
@@ -1335,10 +1032,13 @@ module Aws::DataSync
1335
1032
  # @return [Types::Options]
1336
1033
  #
1337
1034
  # @!attribute [rw] excludes
1338
- # A list of filter rules that determines which files to exclude from a
1339
- # task. The list should contain a single filter string that consists
1340
- # of the patterns to exclude. The patterns are delimited by "\|"
1341
- # (that is, a pipe), for example, `"/folder1|/folder2"`.
1035
+ # Specifies a list of filter rules that exclude specific data during
1036
+ # your transfer. For more information and examples, see [Filtering
1037
+ # data transferred by DataSync][1].
1038
+ #
1039
+ #
1040
+ #
1041
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
1342
1042
  # @return [Array<Types::FilterRule>]
1343
1043
  #
1344
1044
  # @!attribute [rw] schedule
@@ -1352,15 +1052,21 @@ module Aws::DataSync
1352
1052
  # @return [Types::TaskSchedule]
1353
1053
  #
1354
1054
  # @!attribute [rw] tags
1355
- # The key-value pair that represents the tag that you want to add to
1356
- # the resource. The value can be an empty string.
1055
+ # Specifies the tags that you want to apply to the Amazon Resource
1056
+ # Name (ARN) representing the task.
1057
+ #
1058
+ # *Tags* are key-value pairs that help you manage, filter, and search
1059
+ # for your DataSync resources.
1357
1060
  # @return [Array<Types::TagListEntry>]
1358
1061
  #
1359
1062
  # @!attribute [rw] includes
1360
- # A list of filter rules that determines which files to include when
1361
- # running a task. The pattern contains a single filter string that
1362
- # consists of the patterns to include. The patterns are delimited by
1363
- # "\|" (that is, a pipe), for example, `"/folder1|/folder2"`.
1063
+ # Specifies a list of filter rules that include specific data during
1064
+ # your transfer. For more information and examples, see [Filtering
1065
+ # data transferred by DataSync][1].
1066
+ #
1067
+ #
1068
+ #
1069
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
1364
1070
  # @return [Array<Types::FilterRule>]
1365
1071
  #
1366
1072
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateTaskRequest AWS API Documentation
@@ -1395,13 +1101,6 @@ module Aws::DataSync
1395
1101
 
1396
1102
  # DeleteAgentRequest
1397
1103
  #
1398
- # @note When making an API call, you may pass DeleteAgentRequest
1399
- # data as a hash:
1400
- #
1401
- # {
1402
- # agent_arn: "AgentArn", # required
1403
- # }
1404
- #
1405
1104
  # @!attribute [rw] agent_arn
1406
1105
  # The Amazon Resource Name (ARN) of the agent to delete. Use the
1407
1106
  # `ListAgents` operation to return a list of agents for your account
@@ -1422,13 +1121,6 @@ module Aws::DataSync
1422
1121
 
1423
1122
  # DeleteLocation
1424
1123
  #
1425
- # @note When making an API call, you may pass DeleteLocationRequest
1426
- # data as a hash:
1427
- #
1428
- # {
1429
- # location_arn: "LocationArn", # required
1430
- # }
1431
- #
1432
1124
  # @!attribute [rw] location_arn
1433
1125
  # The Amazon Resource Name (ARN) of the location to delete.
1434
1126
  # @return [String]
@@ -1447,15 +1139,9 @@ module Aws::DataSync
1447
1139
 
1448
1140
  # DeleteTask
1449
1141
  #
1450
- # @note When making an API call, you may pass DeleteTaskRequest
1451
- # data as a hash:
1452
- #
1453
- # {
1454
- # task_arn: "TaskArn", # required
1455
- # }
1456
- #
1457
1142
  # @!attribute [rw] task_arn
1458
- # The Amazon Resource Name (ARN) of the task to delete.
1143
+ # Specifies the Amazon Resource Name (ARN) of the task that you want
1144
+ # to delete.
1459
1145
  # @return [String]
1460
1146
  #
1461
1147
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DeleteTaskRequest AWS API Documentation
@@ -1472,13 +1158,6 @@ module Aws::DataSync
1472
1158
 
1473
1159
  # DescribeAgent
1474
1160
  #
1475
- # @note When making an API call, you may pass DescribeAgentRequest
1476
- # data as a hash:
1477
- #
1478
- # {
1479
- # agent_arn: "AgentArn", # required
1480
- # }
1481
- #
1482
1161
  # @!attribute [rw] agent_arn
1483
1162
  # The Amazon Resource Name (ARN) of the agent to describe.
1484
1163
  # @return [String]
@@ -1546,13 +1225,6 @@ module Aws::DataSync
1546
1225
 
1547
1226
  # DescribeLocationEfsRequest
1548
1227
  #
1549
- # @note When making an API call, you may pass DescribeLocationEfsRequest
1550
- # data as a hash:
1551
- #
1552
- # {
1553
- # location_arn: "LocationArn", # required
1554
- # }
1555
- #
1556
1228
  # @!attribute [rw] location_arn
1557
1229
  # The Amazon Resource Name (ARN) of the Amazon EFS file system
1558
1230
  # location that you want information about.
@@ -1614,13 +1286,6 @@ module Aws::DataSync
1614
1286
  include Aws::Structure
1615
1287
  end
1616
1288
 
1617
- # @note When making an API call, you may pass DescribeLocationFsxLustreRequest
1618
- # data as a hash:
1619
- #
1620
- # {
1621
- # location_arn: "LocationArn", # required
1622
- # }
1623
- #
1624
1289
  # @!attribute [rw] location_arn
1625
1290
  # The Amazon Resource Name (ARN) of the FSx for Lustre location to
1626
1291
  # describe.
@@ -1663,13 +1328,6 @@ module Aws::DataSync
1663
1328
  include Aws::Structure
1664
1329
  end
1665
1330
 
1666
- # @note When making an API call, you may pass DescribeLocationFsxOntapRequest
1667
- # data as a hash:
1668
- #
1669
- # {
1670
- # location_arn: "LocationArn", # required
1671
- # }
1672
- #
1673
1331
  # @!attribute [rw] location_arn
1674
1332
  # Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file
1675
1333
  # system location that you want information about.
@@ -1729,13 +1387,6 @@ module Aws::DataSync
1729
1387
  include Aws::Structure
1730
1388
  end
1731
1389
 
1732
- # @note When making an API call, you may pass DescribeLocationFsxOpenZfsRequest
1733
- # data as a hash:
1734
- #
1735
- # {
1736
- # location_arn: "LocationArn", # required
1737
- # }
1738
- #
1739
1390
  # @!attribute [rw] location_arn
1740
1391
  # The Amazon Resource Name (ARN) of the FSx for OpenZFS location to
1741
1392
  # describe.
@@ -1785,13 +1436,6 @@ module Aws::DataSync
1785
1436
  include Aws::Structure
1786
1437
  end
1787
1438
 
1788
- # @note When making an API call, you may pass DescribeLocationFsxWindowsRequest
1789
- # data as a hash:
1790
- #
1791
- # {
1792
- # location_arn: "LocationArn", # required
1793
- # }
1794
- #
1795
1439
  # @!attribute [rw] location_arn
1796
1440
  # The Amazon Resource Name (ARN) of the FSx for Windows File Server
1797
1441
  # location to describe.
@@ -1847,13 +1491,6 @@ module Aws::DataSync
1847
1491
  include Aws::Structure
1848
1492
  end
1849
1493
 
1850
- # @note When making an API call, you may pass DescribeLocationHdfsRequest
1851
- # data as a hash:
1852
- #
1853
- # {
1854
- # location_arn: "LocationArn", # required
1855
- # }
1856
- #
1857
1494
  # @!attribute [rw] location_arn
1858
1495
  # The Amazon Resource Name (ARN) of the HDFS cluster location to
1859
1496
  # describe.
@@ -1944,13 +1581,6 @@ module Aws::DataSync
1944
1581
 
1945
1582
  # DescribeLocationNfsRequest
1946
1583
  #
1947
- # @note When making an API call, you may pass DescribeLocationNfsRequest
1948
- # data as a hash:
1949
- #
1950
- # {
1951
- # location_arn: "LocationArn", # required
1952
- # }
1953
- #
1954
1584
  # @!attribute [rw] location_arn
1955
1585
  # The Amazon Resource Name (ARN) of the NFS location to describe.
1956
1586
  # @return [String]
@@ -2001,13 +1631,6 @@ module Aws::DataSync
2001
1631
 
2002
1632
  # DescribeLocationObjectStorageRequest
2003
1633
  #
2004
- # @note When making an API call, you may pass DescribeLocationObjectStorageRequest
2005
- # data as a hash:
2006
- #
2007
- # {
2008
- # location_arn: "LocationArn", # required
2009
- # }
2010
- #
2011
1634
  # @!attribute [rw] location_arn
2012
1635
  # The Amazon Resource Name (ARN) of the object storage system location
2013
1636
  # that you want information about.
@@ -2076,13 +1699,6 @@ module Aws::DataSync
2076
1699
 
2077
1700
  # DescribeLocationS3Request
2078
1701
  #
2079
- # @note When making an API call, you may pass DescribeLocationS3Request
2080
- # data as a hash:
2081
- #
2082
- # {
2083
- # location_arn: "LocationArn", # required
2084
- # }
2085
- #
2086
1702
  # @!attribute [rw] location_arn
2087
1703
  # The Amazon Resource Name (ARN) of the Amazon S3 bucket location to
2088
1704
  # describe.
@@ -2160,13 +1776,6 @@ module Aws::DataSync
2160
1776
 
2161
1777
  # DescribeLocationSmbRequest
2162
1778
  #
2163
- # @note When making an API call, you may pass DescribeLocationSmbRequest
2164
- # data as a hash:
2165
- #
2166
- # {
2167
- # location_arn: "LocationArn", # required
2168
- # }
2169
- #
2170
1779
  # @!attribute [rw] location_arn
2171
1780
  # The Amazon Resource Name (ARN) of the SMB location to describe.
2172
1781
  # @return [String]
@@ -2229,13 +1838,6 @@ module Aws::DataSync
2229
1838
 
2230
1839
  # DescribeTaskExecutionRequest
2231
1840
  #
2232
- # @note When making an API call, you may pass DescribeTaskExecutionRequest
2233
- # data as a hash:
2234
- #
2235
- # {
2236
- # task_execution_arn: "TaskExecutionArn", # required
2237
- # }
2238
- #
2239
1841
  # @!attribute [rw] task_execution_arn
2240
1842
  # The Amazon Resource Name (ARN) of the task that is being executed.
2241
1843
  # @return [String]
@@ -2269,35 +1871,34 @@ module Aws::DataSync
2269
1871
  # @return [String]
2270
1872
  #
2271
1873
  # @!attribute [rw] options
2272
- # Represents the options that are available to control the behavior of
2273
- # a [StartTaskExecution][1] operation. Behavior includes preserving
2274
- # metadata such as user ID (UID), group ID (GID), and file
2275
- # permissions, and also overwriting files in the destination, data
2276
- # integrity verification, and so on.
2277
- #
2278
- # A task has a set of default options associated with it. If you
2279
- # don't specify an option in [StartTaskExecution][1], the default
2280
- # value is used. You can override the defaults options on each task
2281
- # execution by specifying an overriding `Options` value to
2282
- # [StartTaskExecution][1].
1874
+ # Configures your DataSync task settings. These options include how
1875
+ # DataSync handles files, objects, and their associated metadata. You
1876
+ # also can specify how DataSync verifies data integrity, set bandwidth
1877
+ # limits for your task, among other options.
1878
+ #
1879
+ # Each task setting has a default value. Unless you need to, you
1880
+ # don't have to configure any of these `Options` before starting your
1881
+ # task.
1882
+ # @return [Types::Options]
2283
1883
  #
1884
+ # @!attribute [rw] excludes
1885
+ # A list of filter rules that exclude specific data during your
1886
+ # transfer. For more information and examples, see [Filtering data
1887
+ # transferred by DataSync][1].
2284
1888
  #
2285
1889
  #
2286
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
2287
- # @return [Types::Options]
2288
1890
  #
2289
- # @!attribute [rw] excludes
2290
- # A list of filter rules that determines which files to exclude from a
2291
- # task. The list should contain a single filter string that consists
2292
- # of the patterns to exclude. The patterns are delimited by "\|"
2293
- # (that is, a pipe), for example: `"/folder1|/folder2"`
1891
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
2294
1892
  # @return [Array<Types::FilterRule>]
2295
1893
  #
2296
1894
  # @!attribute [rw] includes
2297
- # A list of filter rules that determines which files to include when
2298
- # running a task. The list should contain a single filter string that
2299
- # consists of the patterns to include. The patterns are delimited by
2300
- # "\|" (that is, a pipe), for example: `"/folder1|/folder2"`
1895
+ # A list of filter rules that include specific data during your
1896
+ # transfer. For more information and examples, see [Filtering data
1897
+ # transferred by DataSync][1].
1898
+ #
1899
+ #
1900
+ #
1901
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
2301
1902
  # @return [Array<Types::FilterRule>]
2302
1903
  #
2303
1904
  # @!attribute [rw] start_time
@@ -2306,11 +1907,11 @@ module Aws::DataSync
2306
1907
  #
2307
1908
  # @!attribute [rw] estimated_files_to_transfer
2308
1909
  # The expected number of files that is to be transferred over the
2309
- # network. This value is calculated during the PREPARING phase, before
2310
- # the TRANSFERRING phase. This value is the expected number of files
2311
- # to be transferred. It's calculated based on comparing the content
2312
- # of the source and destination locations and finding the delta that
2313
- # needs to be transferred.
1910
+ # network. This value is calculated during the `PREPARING` phase
1911
+ # before the `TRANSFERRING` phase of the task execution. This value is
1912
+ # the expected number of files to be transferred. It's calculated
1913
+ # based on comparing the content of the source and destination
1914
+ # locations and finding the delta that needs to be transferred.
2314
1915
  # @return [Integer]
2315
1916
  #
2316
1917
  # @!attribute [rw] estimated_bytes_to_transfer
@@ -2321,12 +1922,13 @@ module Aws::DataSync
2321
1922
  # @!attribute [rw] files_transferred
2322
1923
  # The actual number of files that was transferred over the network.
2323
1924
  # This value is calculated and updated on an ongoing basis during the
2324
- # TRANSFERRING phase. It's updated periodically when each file is
2325
- # read from the source and sent over the network.
1925
+ # `TRANSFERRING` phase of the task execution. It's updated
1926
+ # periodically when each file is read from the source and sent over
1927
+ # the network.
2326
1928
  #
2327
1929
  # If failures occur during a transfer, this value can be less than
2328
- # `EstimatedFilesToTransfer`. This value can also be greater than
2329
- # `EstimatedFilesTransferred` in some cases. This element is
1930
+ # `EstimatedFilesToTransfer`. In some cases, this value can also be
1931
+ # greater than `EstimatedFilesToTransfer`. This element is
2330
1932
  # implementation-specific for some location types, so don't use it as
2331
1933
  # an indicator for a correct file number or to monitor your task
2332
1934
  # execution.
@@ -2338,7 +1940,8 @@ module Aws::DataSync
2338
1940
  # @return [Integer]
2339
1941
  #
2340
1942
  # @!attribute [rw] bytes_transferred
2341
- # The physical number of bytes transferred over the network.
1943
+ # The total number of bytes that are involved in the transfer. For the
1944
+ # number of bytes sent over the network, see `BytesCompressed`.
2342
1945
  # @return [Integer]
2343
1946
  #
2344
1947
  # @!attribute [rw] result
@@ -2348,7 +1951,7 @@ module Aws::DataSync
2348
1951
  # @!attribute [rw] bytes_compressed
2349
1952
  # The physical number of bytes transferred over the network after
2350
1953
  # compression was applied. In most cases, this number is less than
2351
- # `BytesTransferred`.
1954
+ # `BytesTransferred` unless the data isn't compressible.
2352
1955
  # @return [Integer]
2353
1956
  #
2354
1957
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskExecutionResponse AWS API Documentation
@@ -2373,13 +1976,6 @@ module Aws::DataSync
2373
1976
 
2374
1977
  # DescribeTaskRequest
2375
1978
  #
2376
- # @note When making an API call, you may pass DescribeTaskRequest
2377
- # data as a hash:
2378
- #
2379
- # {
2380
- # task_arn: "TaskArn", # required
2381
- # }
2382
- #
2383
1979
  # @!attribute [rw] task_arn
2384
1980
  # The Amazon Resource Name (ARN) of the task to describe.
2385
1981
  # @return [String]
@@ -2410,8 +2006,8 @@ module Aws::DataSync
2410
2006
  # @return [String]
2411
2007
  #
2412
2008
  # @!attribute [rw] current_task_execution_arn
2413
- # The Amazon Resource Name (ARN) of the task execution that is syncing
2414
- # files.
2009
+ # The Amazon Resource Name (ARN) of the task execution that is
2010
+ # transferring files.
2415
2011
  # @return [String]
2416
2012
  #
2417
2013
  # @!attribute [rw] source_location_arn
@@ -2433,25 +2029,32 @@ module Aws::DataSync
2433
2029
  # @return [String]
2434
2030
  #
2435
2031
  # @!attribute [rw] source_network_interface_arns
2436
- # The Amazon Resource Names (ARNs) of the source elastic network
2437
- # interfaces (ENIs) that were created for your subnet.
2032
+ # The Amazon Resource Names (ARNs) of the network interfaces created
2033
+ # for your source location. For more information, see [Network
2034
+ # interface requirements][1].
2035
+ #
2036
+ #
2037
+ #
2038
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces
2438
2039
  # @return [Array<String>]
2439
2040
  #
2440
2041
  # @!attribute [rw] destination_network_interface_arns
2441
- # The Amazon Resource Names (ARNs) of the destination elastic network
2442
- # interfaces (ENIs) that were created for your subnet.
2042
+ # The Amazon Resource Names (ARNs) of the network interfaces created
2043
+ # for your destination location. For more information, see [Network
2044
+ # interface requirements][1].
2045
+ #
2046
+ #
2047
+ #
2048
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces
2443
2049
  # @return [Array<String>]
2444
2050
  #
2445
2051
  # @!attribute [rw] options
2446
- # The set of configuration options that control the behavior of a
2447
- # single execution of the task that occurs when you call
2448
- # `StartTaskExecution`. You can configure these options to preserve
2449
- # metadata such as user ID (UID) and group (GID), file permissions,
2450
- # data integrity verification, and so on.
2052
+ # The configuration options that control the behavior of the
2053
+ # `StartTaskExecution` operation. Some options include preserving file
2054
+ # or object metadata and verifying data integrity.
2451
2055
  #
2452
- # For each individual task execution, you can override these options
2453
- # by specifying the overriding `OverrideOptions` value to
2454
- # [StartTaskExecution][1] operation.
2056
+ # You can override these options for each task execution. For more
2057
+ # information, see [StartTaskExecution][1].
2455
2058
  #
2456
2059
  #
2457
2060
  #
@@ -2459,10 +2062,13 @@ module Aws::DataSync
2459
2062
  # @return [Types::Options]
2460
2063
  #
2461
2064
  # @!attribute [rw] excludes
2462
- # A list of filter rules that determines which files to exclude from a
2463
- # task. The list should contain a single filter string that consists
2464
- # of the patterns to exclude. The patterns are delimited by "\|"
2465
- # (that is, a pipe), for example, `"/folder1|/folder2"`.
2065
+ # A list of filter rules that exclude specific data during your
2066
+ # transfer. For more information and examples, see [Filtering data
2067
+ # transferred by DataSync][1].
2068
+ #
2069
+ #
2070
+ #
2071
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
2466
2072
  # @return [Array<Types::FilterRule>]
2467
2073
  #
2468
2074
  # @!attribute [rw] schedule
@@ -2486,10 +2092,13 @@ module Aws::DataSync
2486
2092
  # @return [Time]
2487
2093
  #
2488
2094
  # @!attribute [rw] includes
2489
- # A list of filter rules that determines which files to include when
2490
- # running a task. The pattern contains a single filter string that
2491
- # consists of the patterns to include. The patterns are delimited by
2492
- # "\|" (that is, a pipe), for example, `"/folder1|/folder2`".
2095
+ # A list of filter rules that include specific data during your
2096
+ # transfer. For more information and examples, see [Filtering data
2097
+ # transferred by DataSync][1].
2098
+ #
2099
+ #
2100
+ #
2101
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
2493
2102
  # @return [Array<Types::FilterRule>]
2494
2103
  #
2495
2104
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskResponse AWS API Documentation
@@ -2518,14 +2127,6 @@ module Aws::DataSync
2518
2127
  # The subnet and security groups that DataSync uses to access your
2519
2128
  # Amazon EFS file system.
2520
2129
  #
2521
- # @note When making an API call, you may pass Ec2Config
2522
- # data as a hash:
2523
- #
2524
- # {
2525
- # subnet_arn: "Ec2SubnetArn", # required
2526
- # security_group_arns: ["Ec2SecurityGroupArn"], # required
2527
- # }
2528
- #
2529
2130
  # @!attribute [rw] subnet_arn
2530
2131
  # Specifies the ARN of a subnet where DataSync creates the [network
2531
2132
  # interfaces][1] for managing traffic during your transfer.
@@ -2565,14 +2166,6 @@ module Aws::DataSync
2565
2166
  # Specifies which files, folders, and objects to include or exclude when
2566
2167
  # transferring files from source to destination.
2567
2168
  #
2568
- # @note When making an API call, you may pass FilterRule
2569
- # data as a hash:
2570
- #
2571
- # {
2572
- # filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
2573
- # value: "FilterValue",
2574
- # }
2575
- #
2576
2169
  # @!attribute [rw] filter_type
2577
2170
  # The type of filter rule to apply. DataSync only supports the
2578
2171
  # SIMPLE\_PATTERN rule type.
@@ -2596,25 +2189,6 @@ module Aws::DataSync
2596
2189
  # Specifies the data transfer protocol that DataSync uses to access your
2597
2190
  # Amazon FSx file system.
2598
2191
  #
2599
- # @note When making an API call, you may pass FsxProtocol
2600
- # data as a hash:
2601
- #
2602
- # {
2603
- # nfs: {
2604
- # mount_options: {
2605
- # version: "AUTOMATIC", # accepts AUTOMATIC, NFS3, NFS4_0, NFS4_1
2606
- # },
2607
- # },
2608
- # smb: {
2609
- # domain: "SmbDomain",
2610
- # mount_options: {
2611
- # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
2612
- # },
2613
- # password: "SmbPassword", # required
2614
- # user: "SmbUser", # required
2615
- # },
2616
- # }
2617
- #
2618
2192
  # @!attribute [rw] nfs
2619
2193
  # Specifies the Network File System (NFS) protocol configuration that
2620
2194
  # DataSync uses to access your FSx for OpenZFS file system or FSx for
@@ -2639,15 +2213,6 @@ module Aws::DataSync
2639
2213
  # DataSync uses to access your Amazon FSx for OpenZFS or Amazon FSx for
2640
2214
  # NetApp ONTAP file system.
2641
2215
  #
2642
- # @note When making an API call, you may pass FsxProtocolNfs
2643
- # data as a hash:
2644
- #
2645
- # {
2646
- # mount_options: {
2647
- # version: "AUTOMATIC", # accepts AUTOMATIC, NFS3, NFS4_0, NFS4_1
2648
- # },
2649
- # }
2650
- #
2651
2216
  # @!attribute [rw] mount_options
2652
2217
  # Specifies how DataSync can access a location using the NFS protocol.
2653
2218
  # @return [Types::NfsMountOptions]
@@ -2668,18 +2233,6 @@ module Aws::DataSync
2668
2233
  #
2669
2234
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access
2670
2235
  #
2671
- # @note When making an API call, you may pass FsxProtocolSmb
2672
- # data as a hash:
2673
- #
2674
- # {
2675
- # domain: "SmbDomain",
2676
- # mount_options: {
2677
- # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
2678
- # },
2679
- # password: "SmbPassword", # required
2680
- # user: "SmbUser", # required
2681
- # }
2682
- #
2683
2236
  # @!attribute [rw] domain
2684
2237
  # Specifies the fully qualified domain name (FQDN) of the Microsoft
2685
2238
  # Active Directory that your storage virtual machine (SVM) belongs to.
@@ -2745,14 +2298,6 @@ module Aws::DataSync
2745
2298
  # directories. The NameNode contains the information to map blocks of
2746
2299
  # data to the DataNodes.
2747
2300
  #
2748
- # @note When making an API call, you may pass HdfsNameNode
2749
- # data as a hash:
2750
- #
2751
- # {
2752
- # hostname: "HdfsServerHostname", # required
2753
- # port: 1, # required
2754
- # }
2755
- #
2756
2301
  # @!attribute [rw] hostname
2757
2302
  # The hostname of the NameNode in the HDFS cluster. This value is the
2758
2303
  # IP address or Domain Name Service (DNS) name of the NameNode. An
@@ -2813,14 +2358,6 @@ module Aws::DataSync
2813
2358
 
2814
2359
  # ListAgentsRequest
2815
2360
  #
2816
- # @note When making an API call, you may pass ListAgentsRequest
2817
- # data as a hash:
2818
- #
2819
- # {
2820
- # max_results: 1,
2821
- # next_token: "NextToken",
2822
- # }
2823
- #
2824
2361
  # @!attribute [rw] max_results
2825
2362
  # The maximum number of agents to list.
2826
2363
  # @return [Integer]
@@ -2861,21 +2398,6 @@ module Aws::DataSync
2861
2398
 
2862
2399
  # ListLocationsRequest
2863
2400
  #
2864
- # @note When making an API call, you may pass ListLocationsRequest
2865
- # data as a hash:
2866
- #
2867
- # {
2868
- # max_results: 1,
2869
- # next_token: "NextToken",
2870
- # filters: [
2871
- # {
2872
- # name: "LocationUri", # required, accepts LocationUri, LocationType, CreationTime
2873
- # values: ["FilterAttributeValue"], # required
2874
- # operator: "Equals", # required, accepts Equals, NotEquals, In, LessThanOrEqual, LessThan, GreaterThanOrEqual, GreaterThan, Contains, NotContains, BeginsWith
2875
- # },
2876
- # ],
2877
- # }
2878
- #
2879
2401
  # @!attribute [rw] max_results
2880
2402
  # The maximum number of locations to return.
2881
2403
  # @return [Integer]
@@ -2924,26 +2446,18 @@ module Aws::DataSync
2924
2446
 
2925
2447
  # ListTagsForResourceRequest
2926
2448
  #
2927
- # @note When making an API call, you may pass ListTagsForResourceRequest
2928
- # data as a hash:
2929
- #
2930
- # {
2931
- # resource_arn: "TaggableResourceArn", # required
2932
- # max_results: 1,
2933
- # next_token: "NextToken",
2934
- # }
2935
- #
2936
2449
  # @!attribute [rw] resource_arn
2937
- # The Amazon Resource Name (ARN) of the resource whose tags to list.
2450
+ # Specifies the Amazon Resource Name (ARN) of the resource that you
2451
+ # want tag information on.
2938
2452
  # @return [String]
2939
2453
  #
2940
2454
  # @!attribute [rw] max_results
2941
- # The maximum number of locations to return.
2455
+ # Specifies how many results that you want in the response.
2942
2456
  # @return [Integer]
2943
2457
  #
2944
2458
  # @!attribute [rw] next_token
2945
- # An opaque string that indicates the position at which to begin the
2946
- # next list of locations.
2459
+ # Specifies an opaque string that indicates the position to begin the
2460
+ # next list of results in the response.
2947
2461
  # @return [String]
2948
2462
  #
2949
2463
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTagsForResourceRequest AWS API Documentation
@@ -2959,12 +2473,12 @@ module Aws::DataSync
2959
2473
  # ListTagsForResourceResponse
2960
2474
  #
2961
2475
  # @!attribute [rw] tags
2962
- # Array of resource tags.
2476
+ # An array of tags applied to the specified resource.
2963
2477
  # @return [Array<Types::TagListEntry>]
2964
2478
  #
2965
2479
  # @!attribute [rw] next_token
2966
- # An opaque string that indicates the position at which to begin
2967
- # returning the next list of resource tags.
2480
+ # The opaque string that indicates the position to begin the next list
2481
+ # of results in the response.
2968
2482
  # @return [String]
2969
2483
  #
2970
2484
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTagsForResourceResponse AWS API Documentation
@@ -2978,15 +2492,6 @@ module Aws::DataSync
2978
2492
 
2979
2493
  # ListTaskExecutions
2980
2494
  #
2981
- # @note When making an API call, you may pass ListTaskExecutionsRequest
2982
- # data as a hash:
2983
- #
2984
- # {
2985
- # task_arn: "TaskArn",
2986
- # max_results: 1,
2987
- # next_token: "NextToken",
2988
- # }
2989
- #
2990
2495
  # @!attribute [rw] task_arn
2991
2496
  # The Amazon Resource Name (ARN) of the task whose tasks you want to
2992
2497
  # list.
@@ -3033,21 +2538,6 @@ module Aws::DataSync
3033
2538
 
3034
2539
  # ListTasksRequest
3035
2540
  #
3036
- # @note When making an API call, you may pass ListTasksRequest
3037
- # data as a hash:
3038
- #
3039
- # {
3040
- # max_results: 1,
3041
- # next_token: "NextToken",
3042
- # filters: [
3043
- # {
3044
- # name: "LocationId", # required, accepts LocationId, CreationTime
3045
- # values: ["FilterAttributeValue"], # required
3046
- # operator: "Equals", # required, accepts Equals, NotEquals, In, LessThanOrEqual, LessThan, GreaterThanOrEqual, GreaterThan, Contains, NotContains, BeginsWith
3047
- # },
3048
- # ],
3049
- # }
3050
- #
3051
2541
  # @!attribute [rw] max_results
3052
2542
  # The maximum number of tasks to return.
3053
2543
  # @return [Integer]
@@ -3105,15 +2595,6 @@ module Aws::DataSync
3105
2595
  #
3106
2596
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html
3107
2597
  #
3108
- # @note When making an API call, you may pass LocationFilter
3109
- # data as a hash:
3110
- #
3111
- # {
3112
- # name: "LocationUri", # required, accepts LocationUri, LocationType, CreationTime
3113
- # values: ["FilterAttributeValue"], # required
3114
- # operator: "Equals", # required, accepts Equals, NotEquals, In, LessThanOrEqual, LessThan, GreaterThanOrEqual, GreaterThan, Contains, NotContains, BeginsWith
3115
- # }
3116
- #
3117
2598
  # @!attribute [rw] name
3118
2599
  # The name of the filter being used. Each API call supports a list of
3119
2600
  # filters that are available for it (for example, `LocationType` for
@@ -3193,13 +2674,6 @@ module Aws::DataSync
3193
2674
 
3194
2675
  # Specifies how DataSync can access a location using the NFS protocol.
3195
2676
  #
3196
- # @note When making an API call, you may pass NfsMountOptions
3197
- # data as a hash:
3198
- #
3199
- # {
3200
- # version: "AUTOMATIC", # accepts AUTOMATIC, NFS3, NFS4_0, NFS4_1
3201
- # }
3202
- #
3203
2677
  # @!attribute [rw] version
3204
2678
  # Specifies the NFS version that you want DataSync to use when
3205
2679
  # mounting your NFS share. If the server refuses to use the version
@@ -3236,13 +2710,6 @@ module Aws::DataSync
3236
2710
  # A list of Amazon Resource Names (ARNs) of agents to use for a Network
3237
2711
  # File System (NFS) location.
3238
2712
  #
3239
- # @note When making an API call, you may pass OnPremConfig
3240
- # data as a hash:
3241
- #
3242
- # {
3243
- # agent_arns: ["AgentArn"], # required
3244
- # }
3245
- #
3246
2713
  # @!attribute [rw] agent_arns
3247
2714
  # ARNs of the agents to use for an NFS location.
3248
2715
  # @return [Array<String>]
@@ -3255,80 +2722,60 @@ module Aws::DataSync
3255
2722
  include Aws::Structure
3256
2723
  end
3257
2724
 
3258
- # Represents the options that are available to control the behavior of a
3259
- # [StartTaskExecution][1] operation. Behavior includes preserving
3260
- # metadata such as user ID (UID), group ID (GID), and file permissions,
3261
- # and also overwriting files in the destination, data integrity
3262
- # verification, and so on.
3263
- #
3264
- # A task has a set of default options associated with it. If you don't
3265
- # specify an option in [StartTaskExecution][1], the default value is
3266
- # used. You can override the defaults options on each task execution by
3267
- # specifying an overriding `Options` value to [StartTaskExecution][1].
3268
- #
3269
- #
3270
- #
3271
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
3272
- #
3273
- # @note When making an API call, you may pass Options
3274
- # data as a hash:
3275
- #
3276
- # {
3277
- # verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED, NONE
3278
- # overwrite_mode: "ALWAYS", # accepts ALWAYS, NEVER
3279
- # atime: "NONE", # accepts NONE, BEST_EFFORT
3280
- # mtime: "NONE", # accepts NONE, PRESERVE
3281
- # uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
3282
- # gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
3283
- # preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
3284
- # preserve_devices: "NONE", # accepts NONE, PRESERVE
3285
- # posix_permissions: "NONE", # accepts NONE, PRESERVE
3286
- # bytes_per_second: 1,
3287
- # task_queueing: "ENABLED", # accepts ENABLED, DISABLED
3288
- # log_level: "OFF", # accepts OFF, BASIC, TRANSFER
3289
- # transfer_mode: "CHANGED", # accepts CHANGED, ALL
3290
- # security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
3291
- # object_tags: "PRESERVE", # accepts PRESERVE, NONE
3292
- # }
2725
+ # Configures your DataSync task settings. These options include how
2726
+ # DataSync handles files, objects, and their associated metadata. You
2727
+ # also can specify how DataSync verifies data integrity, set bandwidth
2728
+ # limits for your task, among other options.
2729
+ #
2730
+ # Each task setting has a default value. Unless you need to, you don't
2731
+ # have to configure any of these `Options` before starting your task.
3293
2732
  #
3294
2733
  # @!attribute [rw] verify_mode
3295
- # A value that determines whether a data integrity verification should
3296
- # be performed at the end of a task execution after all data and
3297
- # metadata have been transferred. For more information, see [Configure
3298
- # task settings][1].
2734
+ # Specifies how and when DataSync checks the integrity of your data
2735
+ # during a transfer.
3299
2736
  #
3300
2737
  # Default value: `POINT_IN_TIME_CONSISTENT`
3301
2738
  #
3302
- # `ONLY_FILES_TRANSFERRED` (recommended): Perform verification only on
3303
- # files that were transferred.
2739
+ # `ONLY_FILES_TRANSFERRED` (recommended): DataSync calculates the
2740
+ # checksum of transferred files and metadata at the source location.
2741
+ # At the end of the transfer, DataSync then compares this checksum to
2742
+ # the checksum calculated on those files at the destination.
3304
2743
  #
3305
- # `POINT_IN_TIME_CONSISTENT`\: Scan the entire source and entire
3306
- # destination at the end of the transfer to verify that source and
3307
- # destination are fully synchronized. This option isn't supported
3308
- # when transferring to S3 Glacier Flexible Retrieval or S3 Glacier
3309
- # Deep Archive storage classes.
2744
+ # We recommend this option when transferring to S3 Glacier Flexible
2745
+ # Retrieval or S3 Glacier Deep Archive storage classes. For more
2746
+ # information, see [Storage class considerations with Amazon S3
2747
+ # locations][1].
3310
2748
  #
3311
- # `NONE`\: No additional verification is done at the end of the
3312
- # transfer, but all data transmissions are integrity-checked with
3313
- # checksum verification during the transfer.
2749
+ # `POINT_IN_TIME_CONSISTENT`\: At the end of the transfer, DataSync
2750
+ # scans the entire source and destination to verify that both
2751
+ # locations are fully synchronized.
3314
2752
  #
2753
+ # You can't use this option when transferring to S3 Glacier Flexible
2754
+ # Retrieval or S3 Glacier Deep Archive storage classes. For more
2755
+ # information, see [Storage class considerations with Amazon S3
2756
+ # locations][1].
3315
2757
  #
2758
+ # `NONE`\: DataSync doesn't run additional verification at the end of
2759
+ # the transfer. All data transmissions are still integrity-checked
2760
+ # with checksum verification during the transfer.
3316
2761
  #
3317
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html
2762
+ #
2763
+ #
2764
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
3318
2765
  # @return [String]
3319
2766
  #
3320
2767
  # @!attribute [rw] overwrite_mode
3321
- # A value that determines whether files at the destination should be
3322
- # overwritten or preserved when copying files. If set to `NEVER` a
3323
- # destination file will not be replaced by a source file, even if the
3324
- # destination file differs from the source file. If you modify files
2768
+ # Specifies whether data at the destination location should be
2769
+ # overwritten or preserved. If set to `NEVER`, a destination file for
2770
+ # example will not be replaced by a source file (even if the
2771
+ # destination file differs from the source file). If you modify files
3325
2772
  # in the destination and you sync the files, you can use this value to
3326
2773
  # protect against overwriting those changes.
3327
2774
  #
3328
- # Some storage classes have specific behaviors that can affect your S3
3329
- # storage cost. For detailed information, see [Considerations when
3330
- # working with Amazon S3 storage classes in DataSync ][1] in the
3331
- # *DataSync User Guide*.
2775
+ # Some storage classes have specific behaviors that can affect your
2776
+ # Amazon S3 storage cost. For detailed information, see
2777
+ # [Considerations when working with Amazon S3 storage classes in
2778
+ # DataSync ][1].
3332
2779
  #
3333
2780
  #
3334
2781
  #
@@ -3336,13 +2783,16 @@ module Aws::DataSync
3336
2783
  # @return [String]
3337
2784
  #
3338
2785
  # @!attribute [rw] atime
3339
- # A file metadata value that shows the last time a file was accessed
3340
- # (that is, when the file was read or written to). If you set `Atime`
3341
- # to `BEST_EFFORT`, DataSync attempts to preserve the original `Atime`
3342
- # attribute on all source files (that is, the version before the
3343
- # `PREPARING` phase). However, `Atime`'s behavior is not fully
3344
- # standard across platforms, so DataSync can only do this on a
3345
- # best-effort basis.
2786
+ # Specifies whether to preserve metadata indicating the last time a
2787
+ # file was read or written to. If you set `Atime` to `BEST_EFFORT`,
2788
+ # DataSync attempts to preserve the original `Atime` attribute on all
2789
+ # source files (that is, the version before the `PREPARING` phase of
2790
+ # the task execution).
2791
+ #
2792
+ # <note markdown="1"> The behavior of `Atime` isn't fully standard across platforms, so
2793
+ # DataSync can only do this on a best-effort basis.
2794
+ #
2795
+ # </note>
3346
2796
  #
3347
2797
  # Default value: `BEST_EFFORT`
3348
2798
  #
@@ -3360,10 +2810,10 @@ module Aws::DataSync
3360
2810
  # @return [String]
3361
2811
  #
3362
2812
  # @!attribute [rw] mtime
3363
- # A value that indicates the last time that a file was modified (that
3364
- # is, a file was written to) before the `PREPARING` phase. This option
3365
- # is required for cases when you need to run the same task more than
3366
- # one time.
2813
+ # Specifies whether to preserve metadata indicating the last time that
2814
+ # a file was written to before the `PREPARING` phase of your task
2815
+ # execution. This option is required when you need to run the a task
2816
+ # more than once.
3367
2817
  #
3368
2818
  # Default Value: `PRESERVE`
3369
2819
  #
@@ -3380,7 +2830,7 @@ module Aws::DataSync
3380
2830
  # @return [String]
3381
2831
  #
3382
2832
  # @!attribute [rw] uid
3383
- # The POSIX user ID (UID) of the file's owner.
2833
+ # Specifies the POSIX user ID (UID) of the file's owner.
3384
2834
  #
3385
2835
  # For more information, see [Metadata copied by DataSync][1].
3386
2836
  #
@@ -3398,7 +2848,7 @@ module Aws::DataSync
3398
2848
  # @return [String]
3399
2849
  #
3400
2850
  # @!attribute [rw] gid
3401
- # The POSIX group ID (GID) of the file's owners.
2851
+ # Specifies the POSIX group ID (GID) of the file's owners.
3402
2852
  #
3403
2853
  # For more information, see [Metadata copied by DataSync][1].
3404
2854
  #
@@ -3416,13 +2866,12 @@ module Aws::DataSync
3416
2866
  # @return [String]
3417
2867
  #
3418
2868
  # @!attribute [rw] preserve_deleted_files
3419
- # A value that specifies whether files in the destination that don't
3420
- # exist in the source file system should be preserved. This option can
3421
- # affect your storage cost. If your task deletes objects, you might
2869
+ # Specifies whether files in the destination location that don't
2870
+ # exist in the source should be preserved. This option can affect your
2871
+ # Amazon S3 storage cost. If your task deletes objects, you might
3422
2872
  # incur minimum storage duration charges for certain storage classes.
3423
2873
  # For detailed information, see [Considerations when working with
3424
- # Amazon S3 storage classes in DataSync ][1] in the *DataSync User
3425
- # Guide*.
2874
+ # Amazon S3 storage classes in DataSync ][1].
3426
2875
  #
3427
2876
  # Default value: `PRESERVE`
3428
2877
  #
@@ -3437,14 +2886,13 @@ module Aws::DataSync
3437
2886
  # @return [String]
3438
2887
  #
3439
2888
  # @!attribute [rw] preserve_devices
3440
- # A value that determines whether DataSync should preserve the
3441
- # metadata of block and character devices in the source file system,
3442
- # and re-create the files with that device name and metadata on the
3443
- # destination. DataSync does not copy the contents of such devices,
3444
- # only the name and metadata.
2889
+ # Specifies whether DataSync should preserve the metadata of block and
2890
+ # character devices in the source location and recreate the files with
2891
+ # that device name and metadata on the destination. DataSync copies
2892
+ # only the name and metadata of such devices.
3445
2893
  #
3446
- # <note markdown="1"> DataSync can't sync the actual contents of such devices, because
3447
- # they are nonterminal and don't return an end-of-file (EOF) marker.
2894
+ # <note markdown="1"> DataSync can't copy the actual contents of these devices because
2895
+ # they're nonterminal and don't return an end-of-file (EOF) marker.
3448
2896
  #
3449
2897
  # </note>
3450
2898
  #
@@ -3453,13 +2901,12 @@ module Aws::DataSync
3453
2901
  # `NONE`\: Ignore special devices (recommended).
3454
2902
  #
3455
2903
  # `PRESERVE`\: Preserve character and block device metadata. This
3456
- # option isn't currently supported for Amazon EFS.
2904
+ # option currently isn't supported for Amazon EFS.
3457
2905
  # @return [String]
3458
2906
  #
3459
2907
  # @!attribute [rw] posix_permissions
3460
- # A value that determines which users or groups can access a file for
3461
- # a specific purpose such as reading, writing, or execution of the
3462
- # file.
2908
+ # Specifies which users or groups can access a file for a specific
2909
+ # purpose such as reading, writing, or execution of the file.
3463
2910
  #
3464
2911
  # For more information, see [Metadata copied by DataSync][1].
3465
2912
  #
@@ -3479,15 +2926,14 @@ module Aws::DataSync
3479
2926
  # @return [String]
3480
2927
  #
3481
2928
  # @!attribute [rw] bytes_per_second
3482
- # A value that limits the bandwidth used by DataSync. For example, if
3483
- # you want DataSync to use a maximum of 1 MB, set this value to
3484
- # `1048576` (`=1024*1024`).
2929
+ # Limits the bandwidth used by a DataSync task. For example, if you
2930
+ # want DataSync to use a maximum of 1 MB, set this value to `1048576`
2931
+ # (`=1024*1024`).
3485
2932
  # @return [Integer]
3486
2933
  #
3487
2934
  # @!attribute [rw] task_queueing
3488
- # A value that determines whether tasks should be queued before
3489
- # executing the tasks. If set to `ENABLED`, the tasks will be queued.
3490
- # The default is `ENABLED`.
2935
+ # Specifies whether tasks should be queued before executing the tasks.
2936
+ # The default is `ENABLED`, which means the tasks will be queued.
3491
2937
  #
3492
2938
  # If you use the same agent to run multiple tasks, you can enable the
3493
2939
  # tasks to run in series. For more information, see [Queueing task
@@ -3499,12 +2945,13 @@ module Aws::DataSync
3499
2945
  # @return [String]
3500
2946
  #
3501
2947
  # @!attribute [rw] log_level
3502
- # A value that determines the type of logs that DataSync publishes to
3503
- # a log stream in the Amazon CloudWatch log group that you provide.
3504
- # For more information about providing a log group for DataSync, see
3505
- # [CloudWatchLogGroupArn][1]. If set to `OFF`, no logs are published.
3506
- # `BASIC` publishes logs on errors for individual files transferred,
3507
- # and `TRANSFER` publishes logs for every file or object that is
2948
+ # Specifies the type of logs that DataSync publishes to a Amazon
2949
+ # CloudWatch Logs log group. To specify the log group, see
2950
+ # [CloudWatchLogGroupArn][1].
2951
+ #
2952
+ # If you set `LogLevel` to `OFF`, no logs are published. `BASIC`
2953
+ # publishes logs on errors for individual files transferred.
2954
+ # `TRANSFER` publishes logs for every file or object that is
3508
2955
  # transferred and integrity checked.
3509
2956
  #
3510
2957
  #
@@ -3513,60 +2960,57 @@ module Aws::DataSync
3513
2960
  # @return [String]
3514
2961
  #
3515
2962
  # @!attribute [rw] transfer_mode
3516
- # A value that determines whether DataSync transfers only the data and
3517
- # metadata that differ between the source and the destination
3518
- # location, or whether DataSync transfers all the content from the
3519
- # source, without comparing to the destination location.
2963
+ # Determines whether DataSync transfers only the data and metadata
2964
+ # that differ between the source and the destination location or
2965
+ # transfers all the content from the source (without comparing what's
2966
+ # in the destination).
3520
2967
  #
3521
2968
  # `CHANGED`\: DataSync copies only data or metadata that is new or
3522
2969
  # different content from the source location to the destination
3523
2970
  # location.
3524
2971
  #
3525
2972
  # `ALL`\: DataSync copies all source location content to the
3526
- # destination, without comparing to existing content on the
3527
- # destination.
2973
+ # destination (without comparing what's in the destination).
3528
2974
  # @return [String]
3529
2975
  #
3530
2976
  # @!attribute [rw] security_descriptor_copy_flags
3531
- # A value that determines which components of the SMB security
3532
- # descriptor are copied from source to destination objects.
2977
+ # Specifies which components of the SMB security descriptor are copied
2978
+ # from source to destination objects.
3533
2979
  #
3534
2980
  # This value is only used for transfers between SMB and Amazon FSx for
3535
- # Windows File Server locations, or between two Amazon FSx for Windows
3536
- # File Server locations. For more information about how DataSync
3537
- # handles metadata, see [How DataSync Handles Metadata and Special
3538
- # Files][1].
2981
+ # Windows File Server locations or between two FSx for Windows File
2982
+ # Server locations. For more information, see [how DataSync handles
2983
+ # metadata][1].
3539
2984
  #
3540
2985
  # Default value: `OWNER_DACL`
3541
2986
  #
3542
2987
  # `OWNER_DACL`\: For each copied object, DataSync copies the following
3543
2988
  # metadata:
3544
2989
  #
3545
- # * Object owner.
2990
+ # * The object owner.
3546
2991
  #
3547
2992
  # * NTFS discretionary access control lists (DACLs), which determine
3548
2993
  # whether to grant access to an object.
3549
2994
  #
3550
- # When choosing this option, DataSync does NOT copy the NTFS system
3551
- # access control lists (SACLs), which are used by administrators to
3552
- # log attempts to access a secured object.
2995
+ # DataSync won't copy NTFS system access control lists (SACLs) with
2996
+ # this option.
3553
2997
  #
3554
2998
  # `OWNER_DACL_SACL`\: For each copied object, DataSync copies the
3555
2999
  # following metadata:
3556
3000
  #
3557
- # * Object owner.
3001
+ # * The object owner.
3558
3002
  #
3559
3003
  # * NTFS discretionary access control lists (DACLs), which determine
3560
3004
  # whether to grant access to an object.
3561
3005
  #
3562
- # * NTFS system access control lists (SACLs), which are used by
3563
- # administrators to log attempts to access a secured object.
3006
+ # * SACLs, which are used by administrators to log attempts to access
3007
+ # a secured object.
3564
3008
  #
3565
- # Copying SACLs requires granting additional permissions to the
3566
- # Windows user that DataSync uses to access your SMB location. For
3567
- # information about choosing a user that ensures sufficient
3568
- # permissions to files, folders, and metadata, see
3569
- # [user](create-smb-location.html#SMBuser).
3009
+ # Copying SACLs requires granting additional permissions to the
3010
+ # Windows user that DataSync uses to access your SMB location. For
3011
+ # information about choosing a user that ensures sufficient
3012
+ # permissions to files, folders, and metadata, see
3013
+ # [user](create-smb-location.html#SMBuser).
3570
3014
  #
3571
3015
  # `NONE`\: None of the SMB security descriptor components are copied.
3572
3016
  # Destination objects are owned by the user that was provided for
@@ -3579,7 +3023,7 @@ module Aws::DataSync
3579
3023
  # @return [String]
3580
3024
  #
3581
3025
  # @!attribute [rw] object_tags
3582
- # Specifies whether object tags are maintained when transferring
3026
+ # Specifies whether object tags are preserved when transferring
3583
3027
  # between object storage systems. If you want your DataSync task to
3584
3028
  # ignore object tags, specify the `NONE` value.
3585
3029
  #
@@ -3654,14 +3098,6 @@ module Aws::DataSync
3654
3098
  # Procedure Call (RPC) and data transfer privacy settings configured on
3655
3099
  # the Hadoop Distributed File System (HDFS) cluster.
3656
3100
  #
3657
- # @note When making an API call, you may pass QopConfiguration
3658
- # data as a hash:
3659
- #
3660
- # {
3661
- # rpc_protection: "DISABLED", # accepts DISABLED, AUTHENTICATION, INTEGRITY, PRIVACY
3662
- # data_transfer_protection: "DISABLED", # accepts DISABLED, AUTHENTICATION, INTEGRITY, PRIVACY
3663
- # }
3664
- #
3665
3101
  # @!attribute [rw] rpc_protection
3666
3102
  # The RPC protection setting configured on the HDFS cluster. This
3667
3103
  # setting corresponds to your `hadoop.rpc.protection` setting in your
@@ -3689,13 +3125,6 @@ module Aws::DataSync
3689
3125
  # For detailed information about using such a role, see Creating a
3690
3126
  # Location for Amazon S3 in the *DataSync User Guide*.
3691
3127
  #
3692
- # @note When making an API call, you may pass S3Config
3693
- # data as a hash:
3694
- #
3695
- # {
3696
- # bucket_access_role_arn: "IamRoleArn", # required
3697
- # }
3698
- #
3699
3128
  # @!attribute [rw] bucket_access_role_arn
3700
3129
  # The ARN of the IAM role for accessing the S3 bucket.
3701
3130
  # @return [String]
@@ -3710,13 +3139,6 @@ module Aws::DataSync
3710
3139
 
3711
3140
  # Specifies how DataSync can access a location using the SMB protocol.
3712
3141
  #
3713
- # @note When making an API call, you may pass SmbMountOptions
3714
- # data as a hash:
3715
- #
3716
- # {
3717
- # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
3718
- # }
3719
- #
3720
3142
  # @!attribute [rw] version
3721
3143
  # Specifies the SMB version that you want DataSync to use when
3722
3144
  # mounting your SMB share. If you don't specify a version, DataSync
@@ -3734,85 +3156,53 @@ module Aws::DataSync
3734
3156
 
3735
3157
  # StartTaskExecutionRequest
3736
3158
  #
3737
- # @note When making an API call, you may pass StartTaskExecutionRequest
3738
- # data as a hash:
3739
- #
3740
- # {
3741
- # task_arn: "TaskArn", # required
3742
- # override_options: {
3743
- # verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED, NONE
3744
- # overwrite_mode: "ALWAYS", # accepts ALWAYS, NEVER
3745
- # atime: "NONE", # accepts NONE, BEST_EFFORT
3746
- # mtime: "NONE", # accepts NONE, PRESERVE
3747
- # uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
3748
- # gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
3749
- # preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
3750
- # preserve_devices: "NONE", # accepts NONE, PRESERVE
3751
- # posix_permissions: "NONE", # accepts NONE, PRESERVE
3752
- # bytes_per_second: 1,
3753
- # task_queueing: "ENABLED", # accepts ENABLED, DISABLED
3754
- # log_level: "OFF", # accepts OFF, BASIC, TRANSFER
3755
- # transfer_mode: "CHANGED", # accepts CHANGED, ALL
3756
- # security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
3757
- # object_tags: "PRESERVE", # accepts PRESERVE, NONE
3758
- # },
3759
- # includes: [
3760
- # {
3761
- # filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
3762
- # value: "FilterValue",
3763
- # },
3764
- # ],
3765
- # excludes: [
3766
- # {
3767
- # filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
3768
- # value: "FilterValue",
3769
- # },
3770
- # ],
3771
- # }
3772
- #
3773
3159
  # @!attribute [rw] task_arn
3774
- # The Amazon Resource Name (ARN) of the task to start.
3160
+ # Specifies the Amazon Resource Name (ARN) of the task that you want
3161
+ # to start.
3775
3162
  # @return [String]
3776
3163
  #
3777
3164
  # @!attribute [rw] override_options
3778
- # Represents the options that are available to control the behavior of
3779
- # a [StartTaskExecution][1] operation. Behavior includes preserving
3780
- # metadata such as user ID (UID), group ID (GID), and file
3781
- # permissions, and also overwriting files in the destination, data
3782
- # integrity verification, and so on.
3783
- #
3784
- # A task has a set of default options associated with it. If you
3785
- # don't specify an option in [StartTaskExecution][1], the default
3786
- # value is used. You can override the defaults options on each task
3787
- # execution by specifying an overriding `Options` value to
3788
- # [StartTaskExecution][1].
3789
- #
3790
- #
3791
- #
3792
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
3165
+ # Configures your DataSync task settings. These options include how
3166
+ # DataSync handles files, objects, and their associated metadata. You
3167
+ # also can specify how DataSync verifies data integrity, set bandwidth
3168
+ # limits for your task, among other options.
3169
+ #
3170
+ # Each task setting has a default value. Unless you need to, you
3171
+ # don't have to configure any of these `Options` before starting your
3172
+ # task.
3793
3173
  # @return [Types::Options]
3794
3174
  #
3795
3175
  # @!attribute [rw] includes
3796
- # A list of filter rules that determines which files to include when
3797
- # running a task. The pattern should contain a single filter string
3798
- # that consists of the patterns to include. The patterns are delimited
3799
- # by "\|" (that is, a pipe), for example, `"/folder1|/folder2"`.
3176
+ # Specifies a list of filter rules that determines which files to
3177
+ # include when running a task. The pattern should contain a single
3178
+ # filter string that consists of the patterns to include. The patterns
3179
+ # are delimited by "\|" (that is, a pipe), for example,
3180
+ # `"/folder1|/folder2"`.
3800
3181
  # @return [Array<Types::FilterRule>]
3801
3182
  #
3802
3183
  # @!attribute [rw] excludes
3803
- # A list of filter rules that determines which files to exclude from a
3804
- # task. The list contains a single filter string that consists of the
3805
- # patterns to exclude. The patterns are delimited by "\|" (that is,
3806
- # a pipe), for example, `"/folder1|/folder2"`.
3184
+ # Specifies a list of filter rules that determines which files to
3185
+ # exclude from a task. The list contains a single filter string that
3186
+ # consists of the patterns to exclude. The patterns are delimited by
3187
+ # "\|" (that is, a pipe), for example, `"/folder1|/folder2"`.
3807
3188
  # @return [Array<Types::FilterRule>]
3808
3189
  #
3190
+ # @!attribute [rw] tags
3191
+ # Specifies the tags that you want to apply to the Amazon Resource
3192
+ # Name (ARN) representing the task execution.
3193
+ #
3194
+ # *Tags* are key-value pairs that help you manage, filter, and search
3195
+ # for your DataSync resources.
3196
+ # @return [Array<Types::TagListEntry>]
3197
+ #
3809
3198
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/StartTaskExecutionRequest AWS API Documentation
3810
3199
  #
3811
3200
  class StartTaskExecutionRequest < Struct.new(
3812
3201
  :task_arn,
3813
3202
  :override_options,
3814
3203
  :includes,
3815
- :excludes)
3204
+ :excludes,
3205
+ :tags)
3816
3206
  SENSITIVE = []
3817
3207
  include Aws::Structure
3818
3208
  end
@@ -3820,8 +3210,7 @@ module Aws::DataSync
3820
3210
  # StartTaskExecutionResponse
3821
3211
  #
3822
3212
  # @!attribute [rw] task_execution_arn
3823
- # The Amazon Resource Name (ARN) of the specific task execution that
3824
- # was started.
3213
+ # The ARN of the running task execution.
3825
3214
  # @return [String]
3826
3215
  #
3827
3216
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/StartTaskExecutionResponse AWS API Documentation
@@ -3832,21 +3221,8 @@ module Aws::DataSync
3832
3221
  include Aws::Structure
3833
3222
  end
3834
3223
 
3835
- # Represents a single entry in a list of Amazon Web Services resource
3836
- # tags. `TagListEntry` returns an array that contains a list of tasks
3837
- # when the [ListTagsForResource][1] operation is called.
3838
- #
3839
- #
3840
- #
3841
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTagsForResource.html
3842
- #
3843
- # @note When making an API call, you may pass TagListEntry
3844
- # data as a hash:
3845
- #
3846
- # {
3847
- # key: "TagKey", # required
3848
- # value: "TagValue",
3849
- # }
3224
+ # A key-value pair representing a single tag that's been applied to an
3225
+ # Amazon Web Services resource.
3850
3226
  #
3851
3227
  # @!attribute [rw] key
3852
3228
  # The key for an Amazon Web Services resource tag.
@@ -3867,25 +3243,13 @@ module Aws::DataSync
3867
3243
 
3868
3244
  # TagResourceRequest
3869
3245
  #
3870
- # @note When making an API call, you may pass TagResourceRequest
3871
- # data as a hash:
3872
- #
3873
- # {
3874
- # resource_arn: "TaggableResourceArn", # required
3875
- # tags: [ # required
3876
- # {
3877
- # key: "TagKey", # required
3878
- # value: "TagValue",
3879
- # },
3880
- # ],
3881
- # }
3882
- #
3883
3246
  # @!attribute [rw] resource_arn
3884
- # The Amazon Resource Name (ARN) of the resource to apply the tag to.
3247
+ # Specifies the Amazon Resource Name (ARN) of the resource to apply
3248
+ # the tag to.
3885
3249
  # @return [String]
3886
3250
  #
3887
3251
  # @!attribute [rw] tags
3888
- # The tags to apply.
3252
+ # Specifies the tags that you want to apply to the resource.
3889
3253
  # @return [Array<Types::TagListEntry>]
3890
3254
  #
3891
3255
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TagResourceRequest AWS API Documentation
@@ -4001,15 +3365,6 @@ module Aws::DataSync
4001
3365
  #
4002
3366
  # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html
4003
3367
  #
4004
- # @note When making an API call, you may pass TaskFilter
4005
- # data as a hash:
4006
- #
4007
- # {
4008
- # name: "LocationId", # required, accepts LocationId, CreationTime
4009
- # values: ["FilterAttributeValue"], # required
4010
- # operator: "Equals", # required, accepts Equals, NotEquals, In, LessThanOrEqual, LessThan, GreaterThanOrEqual, GreaterThan, Contains, NotContains, BeginsWith
4011
- # }
4012
- #
4013
3368
  # @!attribute [rw] name
4014
3369
  # The name of the filter being used. Each API call supports a list of
4015
3370
  # filters that are available for it. For example, `LocationId` for
@@ -4075,13 +3430,6 @@ module Aws::DataSync
4075
3430
  #
4076
3431
  # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html
4077
3432
  #
4078
- # @note When making an API call, you may pass TaskSchedule
4079
- # data as a hash:
4080
- #
4081
- # {
4082
- # schedule_expression: "ScheduleExpressionCron", # required
4083
- # }
4084
- #
4085
3433
  # @!attribute [rw] schedule_expression
4086
3434
  # A cron expression that specifies when DataSync initiates a scheduled
4087
3435
  # transfer from a source to a destination location.
@@ -4097,21 +3445,13 @@ module Aws::DataSync
4097
3445
 
4098
3446
  # UntagResourceRequest
4099
3447
  #
4100
- # @note When making an API call, you may pass UntagResourceRequest
4101
- # data as a hash:
4102
- #
4103
- # {
4104
- # resource_arn: "TaggableResourceArn", # required
4105
- # keys: ["TagKey"], # required
4106
- # }
4107
- #
4108
3448
  # @!attribute [rw] resource_arn
4109
- # The Amazon Resource Name (ARN) of the resource to remove the tag
4110
- # from.
3449
+ # Specifies the Amazon Resource Name (ARN) of the resource to remove
3450
+ # the tags from.
4111
3451
  # @return [String]
4112
3452
  #
4113
3453
  # @!attribute [rw] keys
4114
- # The keys in the key-value pair in the tag to remove.
3454
+ # Specifies the keys in the tags that you want to remove.
4115
3455
  # @return [Array<String>]
4116
3456
  #
4117
3457
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UntagResourceRequest AWS API Documentation
@@ -4129,14 +3469,6 @@ module Aws::DataSync
4129
3469
 
4130
3470
  # UpdateAgentRequest
4131
3471
  #
4132
- # @note When making an API call, you may pass UpdateAgentRequest
4133
- # data as a hash:
4134
- #
4135
- # {
4136
- # agent_arn: "AgentArn", # required
4137
- # name: "TagValue",
4138
- # }
4139
- #
4140
3472
  # @!attribute [rw] agent_arn
4141
3473
  # The Amazon Resource Name (ARN) of the agent to update.
4142
3474
  # @return [String]
@@ -4158,33 +3490,6 @@ module Aws::DataSync
4158
3490
  #
4159
3491
  class UpdateAgentResponse < Aws::EmptyStructure; end
4160
3492
 
4161
- # @note When making an API call, you may pass UpdateLocationHdfsRequest
4162
- # data as a hash:
4163
- #
4164
- # {
4165
- # location_arn: "LocationArn", # required
4166
- # subdirectory: "HdfsSubdirectory",
4167
- # name_nodes: [
4168
- # {
4169
- # hostname: "HdfsServerHostname", # required
4170
- # port: 1, # required
4171
- # },
4172
- # ],
4173
- # block_size: 1,
4174
- # replication_factor: 1,
4175
- # kms_key_provider_uri: "KmsKeyProviderUri",
4176
- # qop_configuration: {
4177
- # rpc_protection: "DISABLED", # accepts DISABLED, AUTHENTICATION, INTEGRITY, PRIVACY
4178
- # data_transfer_protection: "DISABLED", # accepts DISABLED, AUTHENTICATION, INTEGRITY, PRIVACY
4179
- # },
4180
- # authentication_type: "SIMPLE", # accepts SIMPLE, KERBEROS
4181
- # simple_user: "HdfsUser",
4182
- # kerberos_principal: "KerberosPrincipal",
4183
- # kerberos_keytab: "data",
4184
- # kerberos_krb_5_conf: "data",
4185
- # agent_arns: ["AgentArn"],
4186
- # }
4187
- #
4188
3493
  # @!attribute [rw] location_arn
4189
3494
  # The Amazon Resource Name (ARN) of the source HDFS cluster location.
4190
3495
  # @return [String]
@@ -4278,20 +3583,6 @@ module Aws::DataSync
4278
3583
  #
4279
3584
  class UpdateLocationHdfsResponse < Aws::EmptyStructure; end
4280
3585
 
4281
- # @note When making an API call, you may pass UpdateLocationNfsRequest
4282
- # data as a hash:
4283
- #
4284
- # {
4285
- # location_arn: "LocationArn", # required
4286
- # subdirectory: "NfsSubdirectory",
4287
- # on_prem_config: {
4288
- # agent_arns: ["AgentArn"], # required
4289
- # },
4290
- # mount_options: {
4291
- # version: "AUTOMATIC", # accepts AUTOMATIC, NFS3, NFS4_0, NFS4_1
4292
- # },
4293
- # }
4294
- #
4295
3586
  # @!attribute [rw] location_arn
4296
3587
  # The Amazon Resource Name (ARN) of the NFS location to update.
4297
3588
  # @return [String]
@@ -4353,20 +3644,6 @@ module Aws::DataSync
4353
3644
  #
4354
3645
  class UpdateLocationNfsResponse < Aws::EmptyStructure; end
4355
3646
 
4356
- # @note When making an API call, you may pass UpdateLocationObjectStorageRequest
4357
- # data as a hash:
4358
- #
4359
- # {
4360
- # location_arn: "LocationArn", # required
4361
- # server_port: 1,
4362
- # server_protocol: "HTTPS", # accepts HTTPS, HTTP
4363
- # subdirectory: "S3Subdirectory",
4364
- # access_key: "ObjectStorageAccessKey",
4365
- # secret_key: "ObjectStorageSecretKey",
4366
- # agent_arns: ["AgentArn"],
4367
- # server_certificate: "data",
4368
- # }
4369
- #
4370
3647
  # @!attribute [rw] location_arn
4371
3648
  # Specifies the ARN of the object storage system location that you're
4372
3649
  # updating.
@@ -4436,21 +3713,6 @@ module Aws::DataSync
4436
3713
  #
4437
3714
  class UpdateLocationObjectStorageResponse < Aws::EmptyStructure; end
4438
3715
 
4439
- # @note When making an API call, you may pass UpdateLocationSmbRequest
4440
- # data as a hash:
4441
- #
4442
- # {
4443
- # location_arn: "LocationArn", # required
4444
- # subdirectory: "SmbSubdirectory",
4445
- # user: "SmbUser",
4446
- # domain: "SmbDomain",
4447
- # password: "SmbPassword",
4448
- # agent_arns: ["AgentArn"],
4449
- # mount_options: {
4450
- # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
4451
- # },
4452
- # }
4453
- #
4454
3716
  # @!attribute [rw] location_arn
4455
3717
  # The Amazon Resource Name (ARN) of the SMB location to update.
4456
3718
  # @return [String]
@@ -4524,51 +3786,20 @@ module Aws::DataSync
4524
3786
  #
4525
3787
  class UpdateLocationSmbResponse < Aws::EmptyStructure; end
4526
3788
 
4527
- # @note When making an API call, you may pass UpdateTaskExecutionRequest
4528
- # data as a hash:
4529
- #
4530
- # {
4531
- # task_execution_arn: "TaskExecutionArn", # required
4532
- # options: { # required
4533
- # verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED, NONE
4534
- # overwrite_mode: "ALWAYS", # accepts ALWAYS, NEVER
4535
- # atime: "NONE", # accepts NONE, BEST_EFFORT
4536
- # mtime: "NONE", # accepts NONE, PRESERVE
4537
- # uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
4538
- # gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
4539
- # preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
4540
- # preserve_devices: "NONE", # accepts NONE, PRESERVE
4541
- # posix_permissions: "NONE", # accepts NONE, PRESERVE
4542
- # bytes_per_second: 1,
4543
- # task_queueing: "ENABLED", # accepts ENABLED, DISABLED
4544
- # log_level: "OFF", # accepts OFF, BASIC, TRANSFER
4545
- # transfer_mode: "CHANGED", # accepts CHANGED, ALL
4546
- # security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
4547
- # object_tags: "PRESERVE", # accepts PRESERVE, NONE
4548
- # },
4549
- # }
4550
- #
4551
3789
  # @!attribute [rw] task_execution_arn
4552
3790
  # The Amazon Resource Name (ARN) of the specific task execution that
4553
3791
  # is being updated.
4554
3792
  # @return [String]
4555
3793
  #
4556
3794
  # @!attribute [rw] options
4557
- # Represents the options that are available to control the behavior of
4558
- # a [StartTaskExecution][1] operation. Behavior includes preserving
4559
- # metadata such as user ID (UID), group ID (GID), and file
4560
- # permissions, and also overwriting files in the destination, data
4561
- # integrity verification, and so on.
4562
- #
4563
- # A task has a set of default options associated with it. If you
4564
- # don't specify an option in [StartTaskExecution][1], the default
4565
- # value is used. You can override the defaults options on each task
4566
- # execution by specifying an overriding `Options` value to
4567
- # [StartTaskExecution][1].
4568
- #
4569
- #
4570
- #
4571
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
3795
+ # Configures your DataSync task settings. These options include how
3796
+ # DataSync handles files, objects, and their associated metadata. You
3797
+ # also can specify how DataSync verifies data integrity, set bandwidth
3798
+ # limits for your task, among other options.
3799
+ #
3800
+ # Each task setting has a default value. Unless you need to, you
3801
+ # don't have to configure any of these `Options` before starting your
3802
+ # task.
4572
3803
  # @return [Types::Options]
4573
3804
  #
4574
3805
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskExecutionRequest AWS API Documentation
@@ -4586,75 +3817,30 @@ module Aws::DataSync
4586
3817
 
4587
3818
  # UpdateTaskResponse
4588
3819
  #
4589
- # @note When making an API call, you may pass UpdateTaskRequest
4590
- # data as a hash:
4591
- #
4592
- # {
4593
- # task_arn: "TaskArn", # required
4594
- # options: {
4595
- # verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED, NONE
4596
- # overwrite_mode: "ALWAYS", # accepts ALWAYS, NEVER
4597
- # atime: "NONE", # accepts NONE, BEST_EFFORT
4598
- # mtime: "NONE", # accepts NONE, PRESERVE
4599
- # uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
4600
- # gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
4601
- # preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
4602
- # preserve_devices: "NONE", # accepts NONE, PRESERVE
4603
- # posix_permissions: "NONE", # accepts NONE, PRESERVE
4604
- # bytes_per_second: 1,
4605
- # task_queueing: "ENABLED", # accepts ENABLED, DISABLED
4606
- # log_level: "OFF", # accepts OFF, BASIC, TRANSFER
4607
- # transfer_mode: "CHANGED", # accepts CHANGED, ALL
4608
- # security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
4609
- # object_tags: "PRESERVE", # accepts PRESERVE, NONE
4610
- # },
4611
- # excludes: [
4612
- # {
4613
- # filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
4614
- # value: "FilterValue",
4615
- # },
4616
- # ],
4617
- # schedule: {
4618
- # schedule_expression: "ScheduleExpressionCron", # required
4619
- # },
4620
- # name: "TagValue",
4621
- # cloud_watch_log_group_arn: "LogGroupArn",
4622
- # includes: [
4623
- # {
4624
- # filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
4625
- # value: "FilterValue",
4626
- # },
4627
- # ],
4628
- # }
4629
- #
4630
3820
  # @!attribute [rw] task_arn
4631
3821
  # The Amazon Resource Name (ARN) of the resource name of the task to
4632
3822
  # update.
4633
3823
  # @return [String]
4634
3824
  #
4635
3825
  # @!attribute [rw] options
4636
- # Represents the options that are available to control the behavior of
4637
- # a [StartTaskExecution][1] operation. Behavior includes preserving
4638
- # metadata such as user ID (UID), group ID (GID), and file
4639
- # permissions, and also overwriting files in the destination, data
4640
- # integrity verification, and so on.
4641
- #
4642
- # A task has a set of default options associated with it. If you
4643
- # don't specify an option in [StartTaskExecution][1], the default
4644
- # value is used. You can override the defaults options on each task
4645
- # execution by specifying an overriding `Options` value to
4646
- # [StartTaskExecution][1].
3826
+ # Configures your DataSync task settings. These options include how
3827
+ # DataSync handles files, objects, and their associated metadata. You
3828
+ # also can specify how DataSync verifies data integrity, set bandwidth
3829
+ # limits for your task, among other options.
3830
+ #
3831
+ # Each task setting has a default value. Unless you need to, you
3832
+ # don't have to configure any of these `Options` before starting your
3833
+ # task.
3834
+ # @return [Types::Options]
4647
3835
  #
3836
+ # @!attribute [rw] excludes
3837
+ # Specifies a list of filter rules that exclude specific data during
3838
+ # your transfer. For more information and examples, see [Filtering
3839
+ # data transferred by DataSync][1].
4648
3840
  #
4649
3841
  #
4650
- # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
4651
- # @return [Types::Options]
4652
3842
  #
4653
- # @!attribute [rw] excludes
4654
- # A list of filter rules that determines which files to exclude from a
4655
- # task. The list should contain a single filter string that consists
4656
- # of the patterns to exclude. The patterns are delimited by "\|"
4657
- # (that is, a pipe), for example, `"/folder1|/folder2"`.
3843
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
4658
3844
  # @return [Array<Types::FilterRule>]
4659
3845
  #
4660
3846
  # @!attribute [rw] schedule
@@ -4680,10 +3866,13 @@ module Aws::DataSync
4680
3866
  # @return [String]
4681
3867
  #
4682
3868
  # @!attribute [rw] includes
4683
- # A list of filter rules that determines which files to include when
4684
- # running a task. The pattern contains a single filter string that
4685
- # consists of the patterns to include. The patterns are delimited by
4686
- # "\|" (that is, a pipe), for example, `"/folder1|/folder2"`.
3869
+ # Specifies a list of filter rules that include specific data during
3870
+ # your transfer. For more information and examples, see [Filtering
3871
+ # data transferred by DataSync][1].
3872
+ #
3873
+ #
3874
+ #
3875
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html
4687
3876
  # @return [Array<Types::FilterRule>]
4688
3877
  #
4689
3878
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskRequest AWS API Documentation