aws-sdk-datasync 1.30.0 → 1.34.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -138,6 +138,7 @@ module Aws::DataSync
138
138
  SmbDomain = Shapes::StringShape.new(name: 'SmbDomain')
139
139
  SmbMountOptions = Shapes::StructureShape.new(name: 'SmbMountOptions')
140
140
  SmbPassword = Shapes::StringShape.new(name: 'SmbPassword')
141
+ SmbSecurityDescriptorCopyFlags = Shapes::StringShape.new(name: 'SmbSecurityDescriptorCopyFlags')
141
142
  SmbSubdirectory = Shapes::StringShape.new(name: 'SmbSubdirectory')
142
143
  SmbUser = Shapes::StringShape.new(name: 'SmbUser')
143
144
  SmbVersion = Shapes::StringShape.new(name: 'SmbVersion')
@@ -525,6 +526,7 @@ module Aws::DataSync
525
526
  Options.add_member(:task_queueing, Shapes::ShapeRef.new(shape: TaskQueueing, location_name: "TaskQueueing"))
526
527
  Options.add_member(:log_level, Shapes::ShapeRef.new(shape: LogLevel, location_name: "LogLevel"))
527
528
  Options.add_member(:transfer_mode, Shapes::ShapeRef.new(shape: TransferMode, location_name: "TransferMode"))
529
+ Options.add_member(:security_descriptor_copy_flags, Shapes::ShapeRef.new(shape: SmbSecurityDescriptorCopyFlags, location_name: "SecurityDescriptorCopyFlags"))
528
530
  Options.struct_class = Types::Options
529
531
 
530
532
  OutputTagList.member = Shapes::ShapeRef.new(shape: TagListEntry)
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -11,8 +11,12 @@ module Aws::DataSync
11
11
  module Types
12
12
 
13
13
  # Represents a single entry in a list of agents. `AgentListEntry`
14
- # returns an array that contains a list of agents when the ListAgents
15
- # operation is called.
14
+ # returns an array that contains a list of agents when the
15
+ # [ListAgents][1] operation is called.
16
+ #
17
+ #
18
+ #
19
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html
16
20
  #
17
21
  # @!attribute [rw] agent_arn
18
22
  # The Amazon Resource Name (ARN) of the agent.
@@ -141,7 +145,11 @@ module Aws::DataSync
141
145
  #
142
146
  # @!attribute [rw] security_group_arns
143
147
  # The ARNs of the security groups used to protect your data transfer
144
- # task subnets. See CreateAgentRequest$SubnetArns.
148
+ # task subnets. See [SecurityGroupArns][1].
149
+ #
150
+ #
151
+ #
152
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_Ec2Config.html#DataSync-Type-Ec2Config-SecurityGroupArns
145
153
  # @return [Array<String>]
146
154
  #
147
155
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateAgentRequest AWS API Documentation
@@ -312,6 +320,10 @@ module Aws::DataSync
312
320
  # @!attribute [rw] user
313
321
  # The user who has the permissions to access files and folders in the
314
322
  # FSx for Windows File Server file system.
323
+ #
324
+ # For information about choosing a user name that ensures sufficient
325
+ # permissions to files, folders, and metadata, see
326
+ # [user](create-fsx-location.html#FSxWuser).
315
327
  # @return [String]
316
328
  #
317
329
  # @!attribute [rw] domain
@@ -624,11 +636,13 @@ module Aws::DataSync
624
636
  # For more information about S3 storage classes, see [Amazon S3
625
637
  # Storage Classes][1]. Some storage classes have behaviors that can
626
638
  # affect your S3 storage cost. For detailed information, see
627
- # using-storage-classes.
639
+ # [Considerations when working with S3 storage classes in
640
+ # DataSync][2].
628
641
  #
629
642
  #
630
643
  #
631
644
  # [1]: http://aws.amazon.com/s3/storage-classes/
645
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
632
646
  # @return [String]
633
647
  #
634
648
  # @!attribute [rw] s3_config
@@ -643,7 +657,11 @@ module Aws::DataSync
643
657
  # If you are using DataSync on an AWS Outpost, specify the Amazon
644
658
  # Resource Names (ARNs) of the DataSync agents deployed on your
645
659
  # Outpost. For more information about launching a DataSync agent on an
646
- # AWS Outpost, see outposts-agent.
660
+ # AWS Outpost, see [Deploy your DataSync agent on AWS Outposts][1].
661
+ #
662
+ #
663
+ #
664
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent
647
665
  # @return [Array<String>]
648
666
  #
649
667
  # @!attribute [rw] tags
@@ -741,6 +759,10 @@ module Aws::DataSync
741
759
  # @!attribute [rw] user
742
760
  # The user who can mount the share, has the permissions to access
743
761
  # files and folders in the SMB share.
762
+ #
763
+ # For information about choosing a user name that ensures sufficient
764
+ # permissions to files, folders, and metadata, see
765
+ # [user](create-smb-location.html#SMBuser).
744
766
  # @return [String]
745
767
  #
746
768
  # @!attribute [rw] domain
@@ -821,6 +843,7 @@ module Aws::DataSync
821
843
  # task_queueing: "ENABLED", # accepts ENABLED, DISABLED
822
844
  # log_level: "OFF", # accepts OFF, BASIC, TRANSFER
823
845
  # transfer_mode: "CHANGED", # accepts CHANGED, ALL
846
+ # security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
824
847
  # },
825
848
  # excludes: [
826
849
  # {
@@ -867,7 +890,12 @@ module Aws::DataSync
867
890
  #
868
891
  # For each individual task execution, you can override these options
869
892
  # by specifying the `OverrideOptions` before starting the task
870
- # execution. For more information, see the operation.
893
+ # execution. For more information, see the [StartTaskExecution][1]
894
+ # operation.
895
+ #
896
+ #
897
+ #
898
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
871
899
  # @return [Types::Options]
872
900
  #
873
901
  # @!attribute [rw] excludes
@@ -880,7 +908,11 @@ module Aws::DataSync
880
908
  # @!attribute [rw] schedule
881
909
  # Specifies a schedule used to periodically transfer files from a
882
910
  # source to a destination location. The schedule should be specified
883
- # in UTC time. For more information, see task-scheduling.
911
+ # in UTC time. For more information, see [Scheduling your task][1].
912
+ #
913
+ #
914
+ #
915
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
884
916
  # @return [Types::TaskSchedule]
885
917
  #
886
918
  # @!attribute [rw] tags
@@ -1035,7 +1067,7 @@ module Aws::DataSync
1035
1067
  # @return [String]
1036
1068
  #
1037
1069
  # @!attribute [rw] last_connection_time
1038
- # The time that the agent last connected to DataSyc.
1070
+ # The time that the agent last connected to DataSync.
1039
1071
  # @return [Time]
1040
1072
  #
1041
1073
  # @!attribute [rw] creation_time
@@ -1357,12 +1389,13 @@ module Aws::DataSync
1357
1389
  # when this location is used as a task destination. For more
1358
1390
  # information about S3 storage classes, see [Amazon S3 Storage
1359
1391
  # Classes][1]. Some storage classes have behaviors that can affect
1360
- # your S3 storage cost. For detailed information, see
1361
- # using-storage-classes.
1392
+ # your S3 storage cost. For detailed information, see [Considerations
1393
+ # when working with S3 storage classes in DataSync][2].
1362
1394
  #
1363
1395
  #
1364
1396
  #
1365
1397
  # [1]: http://aws.amazon.com/s3/storage-classes/
1398
+ # [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
1366
1399
  # @return [String]
1367
1400
  #
1368
1401
  # @!attribute [rw] s3_config
@@ -1377,7 +1410,11 @@ module Aws::DataSync
1377
1410
  # If you are using DataSync on an AWS Outpost, the Amazon Resource
1378
1411
  # Name (ARNs) of the EC2 agents deployed on your Outpost. For more
1379
1412
  # information about launching a DataSync agent on an AWS Outpost, see
1380
- # outposts-agent.
1413
+ # [Deploy your DataSync agent on AWS Outposts][1].
1414
+ #
1415
+ #
1416
+ #
1417
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent
1381
1418
  # @return [Array<String>]
1382
1419
  #
1383
1420
  # @!attribute [rw] creation_time
@@ -1426,7 +1463,7 @@ module Aws::DataSync
1426
1463
  # @return [String]
1427
1464
  #
1428
1465
  # @!attribute [rw] location_uri
1429
- # The URL of the source SBM location that was described.
1466
+ # The URL of the source SMB location that was described.
1430
1467
  # @return [String]
1431
1468
  #
1432
1469
  # @!attribute [rw] agent_arns
@@ -1509,15 +1546,20 @@ module Aws::DataSync
1509
1546
  #
1510
1547
  # @!attribute [rw] options
1511
1548
  # Represents the options that are available to control the behavior of
1512
- # a StartTaskExecution operation. Behavior includes preserving
1549
+ # a [StartTaskExecution][1] operation. Behavior includes preserving
1513
1550
  # metadata such as user ID (UID), group ID (GID), and file
1514
1551
  # permissions, and also overwriting files in the destination, data
1515
1552
  # integrity verification, and so on.
1516
1553
  #
1517
1554
  # A task has a set of default options associated with it. If you
1518
- # don't specify an option in StartTaskExecution, the default value is
1519
- # used. You can override the defaults options on each task execution
1520
- # by specifying an overriding `Options` value to StartTaskExecution.
1555
+ # don't specify an option in [StartTaskExecution][1], the default
1556
+ # value is used. You can override the defaults options on each task
1557
+ # execution by specifying an overriding `Options` value to
1558
+ # [StartTaskExecution][1].
1559
+ #
1560
+ #
1561
+ #
1562
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
1521
1563
  # @return [Types::Options]
1522
1564
  #
1523
1565
  # @!attribute [rw] excludes
@@ -1677,7 +1719,12 @@ module Aws::DataSync
1677
1719
  # data integrity verification, and so on.
1678
1720
  #
1679
1721
  # For each individual task execution, you can override these options
1680
- # by specifying the overriding `OverrideOptions` value to operation.
1722
+ # by specifying the overriding `OverrideOptions` value to
1723
+ # [StartTaskExecution][1] operation.
1724
+ #
1725
+ #
1726
+ #
1727
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
1681
1728
  # @return [Types::Options]
1682
1729
  #
1683
1730
  # @!attribute [rw] excludes
@@ -1762,7 +1809,7 @@ module Aws::DataSync
1762
1809
  include Aws::Structure
1763
1810
  end
1764
1811
 
1765
- # Specifies which files, folders and objects to include or exclude when
1812
+ # Specifies which files, folders, and objects to include or exclude when
1766
1813
  # transferring files from source to destination.
1767
1814
  #
1768
1815
  # @note When making an API call, you may pass FilterRule
@@ -2139,7 +2186,11 @@ module Aws::DataSync
2139
2186
  # @!attribute [rw] operator
2140
2187
  # The operator that is used to compare filter values (for example,
2141
2188
  # `Equals` or `Contains`). For more about API filtering operators, see
2142
- # query-resources.
2189
+ # [API filters for ListTasks and ListLocations][1].
2190
+ #
2191
+ #
2192
+ #
2193
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html
2143
2194
  # @return [String]
2144
2195
  #
2145
2196
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/LocationFilter AWS API Documentation
@@ -2154,7 +2205,11 @@ module Aws::DataSync
2154
2205
 
2155
2206
  # Represents a single entry in a list of locations. `LocationListEntry`
2156
2207
  # returns an array that contains a list of locations when the
2157
- # ListLocations operation is called.
2208
+ # [ListLocations][1] operation is called.
2209
+ #
2210
+ #
2211
+ #
2212
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html
2158
2213
  #
2159
2214
  # @!attribute [rw] location_arn
2160
2215
  # The Amazon Resource Name (ARN) of the location. For Network File
@@ -2165,7 +2220,7 @@ module Aws::DataSync
2165
2220
  #
2166
2221
  # @!attribute [rw] location_uri
2167
2222
  # Represents a list of URLs of a location. `LocationUri` returns an
2168
- # array that contains a list of locations when the ListLocations
2223
+ # array that contains a list of locations when the [ListLocations][1]
2169
2224
  # operation is called.
2170
2225
  #
2171
2226
  # Format: `TYPE://GLOBAL_ID/SUBDIR`.
@@ -2183,6 +2238,12 @@ module Aws::DataSync
2183
2238
  # is the *nix convention. For NFS and Amazon EFS, it's the export
2184
2239
  # path to mount the location. For Amazon S3, it's the prefix path
2185
2240
  # that you mount to and treat as the root of the location.
2241
+ #
2242
+ #
2243
+ #
2244
+ #
2245
+ #
2246
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html
2186
2247
  # @return [String]
2187
2248
  #
2188
2249
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/LocationListEntry AWS API Documentation
@@ -2258,15 +2319,19 @@ module Aws::DataSync
2258
2319
  end
2259
2320
 
2260
2321
  # Represents the options that are available to control the behavior of a
2261
- # StartTaskExecution operation. Behavior includes preserving metadata
2262
- # such as user ID (UID), group ID (GID), and file permissions, and also
2263
- # overwriting files in the destination, data integrity verification, and
2264
- # so on.
2322
+ # [StartTaskExecution][1] operation. Behavior includes preserving
2323
+ # metadata such as user ID (UID), group ID (GID), and file permissions,
2324
+ # and also overwriting files in the destination, data integrity
2325
+ # verification, and so on.
2265
2326
  #
2266
2327
  # A task has a set of default options associated with it. If you don't
2267
- # specify an option in StartTaskExecution, the default value is used.
2268
- # You can override the defaults options on each task execution by
2269
- # specifying an overriding `Options` value to StartTaskExecution.
2328
+ # specify an option in [StartTaskExecution][1], the default value is
2329
+ # used. You can override the defaults options on each task execution by
2330
+ # specifying an overriding `Options` value to [StartTaskExecution][1].
2331
+ #
2332
+ #
2333
+ #
2334
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
2270
2335
  #
2271
2336
  # @note When making an API call, you may pass Options
2272
2337
  # data as a hash:
@@ -2285,13 +2350,14 @@ module Aws::DataSync
2285
2350
  # task_queueing: "ENABLED", # accepts ENABLED, DISABLED
2286
2351
  # log_level: "OFF", # accepts OFF, BASIC, TRANSFER
2287
2352
  # transfer_mode: "CHANGED", # accepts CHANGED, ALL
2353
+ # security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
2288
2354
  # }
2289
2355
  #
2290
2356
  # @!attribute [rw] verify_mode
2291
2357
  # A value that determines whether a data integrity verification should
2292
2358
  # be performed at the end of a task execution after all data and
2293
- # metadata have been transferred. For more information, see
2294
- # create-task
2359
+ # metadata have been transferred. For more information, see [Configure
2360
+ # task settings][1].
2295
2361
  #
2296
2362
  # Default value: POINT\_IN\_TIME\_CONSISTENT.
2297
2363
  #
@@ -2307,6 +2373,10 @@ module Aws::DataSync
2307
2373
  # NONE: No additional verification is done at the end of the transfer,
2308
2374
  # but all data transmissions are integrity-checked with checksum
2309
2375
  # verification during the transfer.
2376
+ #
2377
+ #
2378
+ #
2379
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html
2310
2380
  # @return [String]
2311
2381
  #
2312
2382
  # @!attribute [rw] overwrite_mode
@@ -2318,8 +2388,13 @@ module Aws::DataSync
2318
2388
  # protect against overwriting those changes.
2319
2389
  #
2320
2390
  # Some storage classes have specific behaviors that can affect your S3
2321
- # storage cost. For detailed information, see using-storage-classes in
2322
- # the *AWS DataSync User Guide*.
2391
+ # storage cost. For detailed information, see [Considerations when
2392
+ # working with Amazon S3 storage classes in DataSync ][1] in the *AWS
2393
+ # DataSync User Guide*.
2394
+ #
2395
+ #
2396
+ #
2397
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
2323
2398
  # @return [String]
2324
2399
  #
2325
2400
  # @!attribute [rw] atime
@@ -2347,7 +2422,9 @@ module Aws::DataSync
2347
2422
  #
2348
2423
  # @!attribute [rw] mtime
2349
2424
  # A value that indicates the last time that a file was modified (that
2350
- # is, a file was written to) before the PREPARING phase.
2425
+ # is, a file was written to) before the PREPARING phase. This option
2426
+ # is required for cases when you need to run the same task more than
2427
+ # one time.
2351
2428
  #
2352
2429
  # Default value: PRESERVE.
2353
2430
  #
@@ -2363,7 +2440,10 @@ module Aws::DataSync
2363
2440
  # @return [String]
2364
2441
  #
2365
2442
  # @!attribute [rw] uid
2366
- # The user ID (UID) of the file's owner.
2443
+ # The POSIX user ID (UID) of the file's owner. This option should
2444
+ # only be set for NFS, EFS, and S3 locations. To learn more about what
2445
+ # metadata is copied by DataSync, see [Metadata Copied by
2446
+ # DataSync][1].
2367
2447
  #
2368
2448
  # Default value: INT\_VALUE. This preserves the integer value of the
2369
2449
  # ID.
@@ -2372,10 +2452,17 @@ module Aws::DataSync
2372
2452
  # (recommended).
2373
2453
  #
2374
2454
  # NONE: Ignore UID and GID.
2455
+ #
2456
+ #
2457
+ #
2458
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied
2375
2459
  # @return [String]
2376
2460
  #
2377
2461
  # @!attribute [rw] gid
2378
- # The group ID (GID) of the file's owners.
2462
+ # The POSIX group ID (GID) of the file's owners. This option should
2463
+ # only be set for NFS, EFS, and S3 locations. For more information
2464
+ # about what metadata is copied by DataSync, see [Metadata Copied by
2465
+ # DataSync][1].
2379
2466
  #
2380
2467
  # Default value: INT\_VALUE. This preserves the integer value of the
2381
2468
  # ID.
@@ -2384,6 +2471,10 @@ module Aws::DataSync
2384
2471
  # (recommended).
2385
2472
  #
2386
2473
  # NONE: Ignore UID and GID.
2474
+ #
2475
+ #
2476
+ #
2477
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied
2387
2478
  # @return [String]
2388
2479
  #
2389
2480
  # @!attribute [rw] preserve_deleted_files
@@ -2391,21 +2482,27 @@ module Aws::DataSync
2391
2482
  # exist in the source file system should be preserved. This option can
2392
2483
  # affect your storage cost. If your task deletes objects, you might
2393
2484
  # incur minimum storage duration charges for certain storage classes.
2394
- # For detailed information, see using-storage-classes in the *AWS
2395
- # DataSync User Guide*.
2485
+ # For detailed information, see [Considerations when working with
2486
+ # Amazon S3 storage classes in DataSync ][1] in the *AWS DataSync User
2487
+ # Guide*.
2396
2488
  #
2397
2489
  # Default value: PRESERVE.
2398
2490
  #
2399
2491
  # PRESERVE: Ignore such destination files (recommended).
2400
2492
  #
2401
2493
  # REMOVE: Delete destination files that aren’t present in the source.
2494
+ #
2495
+ #
2496
+ #
2497
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
2402
2498
  # @return [String]
2403
2499
  #
2404
2500
  # @!attribute [rw] preserve_devices
2405
2501
  # A value that determines whether AWS DataSync should preserve the
2406
2502
  # metadata of block and character devices in the source file system,
2407
- # and recreate the files with that device name and metadata on the
2408
- # destination.
2503
+ # and re-create the files with that device name and metadata on the
2504
+ # destination. DataSync does not copy the contents of such devices,
2505
+ # only the name and metadata.
2409
2506
  #
2410
2507
  # <note markdown="1"> AWS DataSync can't sync the actual contents of such devices,
2411
2508
  # because they are nonterminal and don't return an end-of-file (EOF)
@@ -2424,7 +2521,9 @@ module Aws::DataSync
2424
2521
  # @!attribute [rw] posix_permissions
2425
2522
  # A value that determines which users or groups can access a file for
2426
2523
  # a specific purpose such as reading, writing, or execution of the
2427
- # file.
2524
+ # file. This option should only be set for NFS, EFS, and S3 locations.
2525
+ # For more information about what metadata is copied by DataSync, see
2526
+ # [Metadata Copied by DataSync][1].
2428
2527
  #
2429
2528
  # Default value: PRESERVE.
2430
2529
  #
@@ -2435,6 +2534,10 @@ module Aws::DataSync
2435
2534
  # <note markdown="1"> AWS DataSync can preserve extant permissions of a source location.
2436
2535
  #
2437
2536
  # </note>
2537
+ #
2538
+ #
2539
+ #
2540
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied
2438
2541
  # @return [String]
2439
2542
  #
2440
2543
  # @!attribute [rw] bytes_per_second
@@ -2449,8 +2552,12 @@ module Aws::DataSync
2449
2552
  # The default is `ENABLED`.
2450
2553
  #
2451
2554
  # If you use the same agent to run multiple tasks, you can enable the
2452
- # tasks to run in series. For more information, see
2453
- # queue-task-execution.
2555
+ # tasks to run in series. For more information, see [Queueing task
2556
+ # executions][1].
2557
+ #
2558
+ #
2559
+ #
2560
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#queue-task-execution
2454
2561
  # @return [String]
2455
2562
  #
2456
2563
  # @!attribute [rw] log_level
@@ -2481,6 +2588,57 @@ module Aws::DataSync
2481
2588
  # without comparing to existing content on the destination.
2482
2589
  # @return [String]
2483
2590
  #
2591
+ # @!attribute [rw] security_descriptor_copy_flags
2592
+ # A value that determines which components of the SMB security
2593
+ # descriptor are copied from source to destination objects.
2594
+ #
2595
+ # This value is only used for transfers between SMB and Amazon FSx for
2596
+ # Windows File Server locations, or between two Amazon FSx for Windows
2597
+ # File Server locations. For more information about how DataSync
2598
+ # handles metadata, see [How DataSync Handles Metadata and Special
2599
+ # Files][1].
2600
+ #
2601
+ # Default value: OWNER\_DACL.
2602
+ #
2603
+ # **OWNER\_DACL**\: For each copied object, DataSync copies the
2604
+ # following metadata:
2605
+ #
2606
+ # * Object owner.
2607
+ #
2608
+ # * NTFS discretionary access control lists (DACLs), which determine
2609
+ # whether to grant access to an object.
2610
+ #
2611
+ # When choosing this option, DataSync does NOT copy the NTFS system
2612
+ # access control lists (SACLs), which are used by administrators to
2613
+ # log attempts to access a secured object.
2614
+ #
2615
+ # **OWNER\_DACL\_SACL**\: For each copied object, DataSync copies the
2616
+ # following metadata:
2617
+ #
2618
+ # * Object owner.
2619
+ #
2620
+ # * NTFS discretionary access control lists (DACLs), which determine
2621
+ # whether to grant access to an object.
2622
+ #
2623
+ # * NTFS system access control lists (SACLs), which are used by
2624
+ # administrators to log attempts to access a secured object.
2625
+ #
2626
+ # Copying SACLs requires granting additional permissions to the
2627
+ # Windows user that DataSync uses to access your SMB location. For
2628
+ # information about choosing a user that ensures sufficient
2629
+ # permissions to files, folders, and metadata, see
2630
+ # [user](create-smb-location.html#SMBuser).
2631
+ #
2632
+ # **NONE**\: None of the SMB security descriptor components are
2633
+ # copied. Destination objects are owned by the user that was provided
2634
+ # for accessing the destination location. DACLs and SACLs are set
2635
+ # based on the destination server’s configuration.
2636
+ #
2637
+ #
2638
+ #
2639
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html
2640
+ # @return [String]
2641
+ #
2484
2642
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/Options AWS API Documentation
2485
2643
  #
2486
2644
  class Options < Struct.new(
@@ -2496,7 +2654,8 @@ module Aws::DataSync
2496
2654
  :bytes_per_second,
2497
2655
  :task_queueing,
2498
2656
  :log_level,
2499
- :transfer_mode)
2657
+ :transfer_mode,
2658
+ :security_descriptor_copy_flags)
2500
2659
  SENSITIVE = []
2501
2660
  include Aws::Structure
2502
2661
  end
@@ -2558,7 +2717,11 @@ module Aws::DataSync
2558
2717
  #
2559
2718
  # @!attribute [rw] bucket_access_role_arn
2560
2719
  # The Amazon S3 bucket to access. This bucket is used as a parameter
2561
- # in the CreateLocationS3 operation.
2720
+ # in the [CreateLocationS3][1] operation.
2721
+ #
2722
+ #
2723
+ #
2724
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationS3.html
2562
2725
  # @return [String]
2563
2726
  #
2564
2727
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/S3Config AWS API Documentation
@@ -2615,6 +2778,7 @@ module Aws::DataSync
2615
2778
  # task_queueing: "ENABLED", # accepts ENABLED, DISABLED
2616
2779
  # log_level: "OFF", # accepts OFF, BASIC, TRANSFER
2617
2780
  # transfer_mode: "CHANGED", # accepts CHANGED, ALL
2781
+ # security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
2618
2782
  # },
2619
2783
  # includes: [
2620
2784
  # {
@@ -2630,15 +2794,20 @@ module Aws::DataSync
2630
2794
  #
2631
2795
  # @!attribute [rw] override_options
2632
2796
  # Represents the options that are available to control the behavior of
2633
- # a StartTaskExecution operation. Behavior includes preserving
2797
+ # a [StartTaskExecution][1] operation. Behavior includes preserving
2634
2798
  # metadata such as user ID (UID), group ID (GID), and file
2635
2799
  # permissions, and also overwriting files in the destination, data
2636
2800
  # integrity verification, and so on.
2637
2801
  #
2638
2802
  # A task has a set of default options associated with it. If you
2639
- # don't specify an option in StartTaskExecution, the default value is
2640
- # used. You can override the defaults options on each task execution
2641
- # by specifying an overriding `Options` value to StartTaskExecution.
2803
+ # don't specify an option in [StartTaskExecution][1], the default
2804
+ # value is used. You can override the defaults options on each task
2805
+ # execution by specifying an overriding `Options` value to
2806
+ # [StartTaskExecution][1].
2807
+ #
2808
+ #
2809
+ #
2810
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
2642
2811
  # @return [Types::Options]
2643
2812
  #
2644
2813
  # @!attribute [rw] includes
@@ -2675,7 +2844,11 @@ module Aws::DataSync
2675
2844
 
2676
2845
  # Represents a single entry in a list of AWS resource tags.
2677
2846
  # `TagListEntry` returns an array that contains a list of tasks when the
2678
- # ListTagsForResource operation is called.
2847
+ # [ListTagsForResource][1] operation is called.
2848
+ #
2849
+ #
2850
+ #
2851
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTagsForResource.html
2679
2852
  #
2680
2853
  # @note When making an API call, you may pass TagListEntry
2681
2854
  # data as a hash:
@@ -2740,8 +2913,12 @@ module Aws::DataSync
2740
2913
 
2741
2914
  # Represents a single entry in a list of task executions.
2742
2915
  # `TaskExecutionListEntry` returns an array that contains a list of
2743
- # specific invocations of a task when ListTaskExecutions operation is
2744
- # called.
2916
+ # specific invocations of a task when the [ListTaskExecutions][1]
2917
+ # operation is called.
2918
+ #
2919
+ #
2920
+ #
2921
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html
2745
2922
  #
2746
2923
  # @!attribute [rw] task_execution_arn
2747
2924
  # The Amazon Resource Name (ARN) of the task that was executed.
@@ -2851,7 +3028,11 @@ module Aws::DataSync
2851
3028
  # @!attribute [rw] operator
2852
3029
  # The operator that is used to compare filter values (for example,
2853
3030
  # `Equals` or `Contains`). For more about API filtering operators, see
2854
- # query-resources.
3031
+ # [API filters for ListTasks and ListLocations][1].
3032
+ #
3033
+ #
3034
+ #
3035
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html
2855
3036
  # @return [String]
2856
3037
  #
2857
3038
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskFilter AWS API Documentation
@@ -2865,9 +3046,13 @@ module Aws::DataSync
2865
3046
  end
2866
3047
 
2867
3048
  # Represents a single entry in a list of tasks. `TaskListEntry` returns
2868
- # an array that contains a list of tasks when the ListTasks operation is
2869
- # called. A task includes the source and destination file systems to
2870
- # sync and the options to use for the tasks.
3049
+ # an array that contains a list of tasks when the [ListTasks][1]
3050
+ # operation is called. A task includes the source and destination file
3051
+ # systems to sync and the options to use for the tasks.
3052
+ #
3053
+ #
3054
+ #
3055
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTasks.html
2871
3056
  #
2872
3057
  # @!attribute [rw] task_arn
2873
3058
  # The Amazon Resource Name (ARN) of the task.
@@ -3240,6 +3425,7 @@ module Aws::DataSync
3240
3425
  # task_queueing: "ENABLED", # accepts ENABLED, DISABLED
3241
3426
  # log_level: "OFF", # accepts OFF, BASIC, TRANSFER
3242
3427
  # transfer_mode: "CHANGED", # accepts CHANGED, ALL
3428
+ # security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
3243
3429
  # },
3244
3430
  # }
3245
3431
  #
@@ -3250,15 +3436,20 @@ module Aws::DataSync
3250
3436
  #
3251
3437
  # @!attribute [rw] options
3252
3438
  # Represents the options that are available to control the behavior of
3253
- # a StartTaskExecution operation. Behavior includes preserving
3439
+ # a [StartTaskExecution][1] operation. Behavior includes preserving
3254
3440
  # metadata such as user ID (UID), group ID (GID), and file
3255
3441
  # permissions, and also overwriting files in the destination, data
3256
3442
  # integrity verification, and so on.
3257
3443
  #
3258
3444
  # A task has a set of default options associated with it. If you
3259
- # don't specify an option in StartTaskExecution, the default value is
3260
- # used. You can override the defaults options on each task execution
3261
- # by specifying an overriding `Options` value to StartTaskExecution.
3445
+ # don't specify an option in [StartTaskExecution][1], the default
3446
+ # value is used. You can override the defaults options on each task
3447
+ # execution by specifying an overriding `Options` value to
3448
+ # [StartTaskExecution][1].
3449
+ #
3450
+ #
3451
+ #
3452
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
3262
3453
  # @return [Types::Options]
3263
3454
  #
3264
3455
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskExecutionRequest AWS API Documentation
@@ -3295,6 +3486,7 @@ module Aws::DataSync
3295
3486
  # task_queueing: "ENABLED", # accepts ENABLED, DISABLED
3296
3487
  # log_level: "OFF", # accepts OFF, BASIC, TRANSFER
3297
3488
  # transfer_mode: "CHANGED", # accepts CHANGED, ALL
3489
+ # security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
3298
3490
  # },
3299
3491
  # excludes: [
3300
3492
  # {
@@ -3316,15 +3508,20 @@ module Aws::DataSync
3316
3508
  #
3317
3509
  # @!attribute [rw] options
3318
3510
  # Represents the options that are available to control the behavior of
3319
- # a StartTaskExecution operation. Behavior includes preserving
3511
+ # a [StartTaskExecution][1] operation. Behavior includes preserving
3320
3512
  # metadata such as user ID (UID), group ID (GID), and file
3321
3513
  # permissions, and also overwriting files in the destination, data
3322
3514
  # integrity verification, and so on.
3323
3515
  #
3324
3516
  # A task has a set of default options associated with it. If you
3325
- # don't specify an option in StartTaskExecution, the default value is
3326
- # used. You can override the defaults options on each task execution
3327
- # by specifying an overriding `Options` value to StartTaskExecution.
3517
+ # don't specify an option in [StartTaskExecution][1], the default
3518
+ # value is used. You can override the defaults options on each task
3519
+ # execution by specifying an overriding `Options` value to
3520
+ # [StartTaskExecution][1].
3521
+ #
3522
+ #
3523
+ #
3524
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
3328
3525
  # @return [Types::Options]
3329
3526
  #
3330
3527
  # @!attribute [rw] excludes
@@ -3339,8 +3536,12 @@ module Aws::DataSync
3339
3536
  # source to a destination location. You can configure your task to
3340
3537
  # execute hourly, daily, weekly or on specific days of the week. You
3341
3538
  # control when in the day or hour you want the task to execute. The
3342
- # time you specify is UTC time. For more information, see
3343
- # task-scheduling.
3539
+ # time you specify is UTC time. For more information, see [Scheduling
3540
+ # your task][1].
3541
+ #
3542
+ #
3543
+ #
3544
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
3344
3545
  # @return [Types::TaskSchedule]
3345
3546
  #
3346
3547
  # @!attribute [rw] name