aws-sdk-datasync 1.27.0 → 1.32.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')
@@ -172,6 +173,14 @@ module Aws::DataSync
172
173
  UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
173
174
  UpdateAgentRequest = Shapes::StructureShape.new(name: 'UpdateAgentRequest')
174
175
  UpdateAgentResponse = Shapes::StructureShape.new(name: 'UpdateAgentResponse')
176
+ UpdateLocationNfsRequest = Shapes::StructureShape.new(name: 'UpdateLocationNfsRequest')
177
+ UpdateLocationNfsResponse = Shapes::StructureShape.new(name: 'UpdateLocationNfsResponse')
178
+ UpdateLocationObjectStorageRequest = Shapes::StructureShape.new(name: 'UpdateLocationObjectStorageRequest')
179
+ UpdateLocationObjectStorageResponse = Shapes::StructureShape.new(name: 'UpdateLocationObjectStorageResponse')
180
+ UpdateLocationSmbRequest = Shapes::StructureShape.new(name: 'UpdateLocationSmbRequest')
181
+ UpdateLocationSmbResponse = Shapes::StructureShape.new(name: 'UpdateLocationSmbResponse')
182
+ UpdateTaskExecutionRequest = Shapes::StructureShape.new(name: 'UpdateTaskExecutionRequest')
183
+ UpdateTaskExecutionResponse = Shapes::StructureShape.new(name: 'UpdateTaskExecutionResponse')
175
184
  UpdateTaskRequest = Shapes::StructureShape.new(name: 'UpdateTaskRequest')
176
185
  UpdateTaskResponse = Shapes::StructureShape.new(name: 'UpdateTaskResponse')
177
186
  VerifyMode = Shapes::StringShape.new(name: 'VerifyMode')
@@ -517,6 +526,7 @@ module Aws::DataSync
517
526
  Options.add_member(:task_queueing, Shapes::ShapeRef.new(shape: TaskQueueing, location_name: "TaskQueueing"))
518
527
  Options.add_member(:log_level, Shapes::ShapeRef.new(shape: LogLevel, location_name: "LogLevel"))
519
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"))
520
530
  Options.struct_class = Types::Options
521
531
 
522
532
  OutputTagList.member = Shapes::ShapeRef.new(shape: TagListEntry)
@@ -605,6 +615,42 @@ module Aws::DataSync
605
615
 
606
616
  UpdateAgentResponse.struct_class = Types::UpdateAgentResponse
607
617
 
618
+ UpdateLocationNfsRequest.add_member(:location_arn, Shapes::ShapeRef.new(shape: LocationArn, required: true, location_name: "LocationArn"))
619
+ UpdateLocationNfsRequest.add_member(:subdirectory, Shapes::ShapeRef.new(shape: NfsSubdirectory, location_name: "Subdirectory"))
620
+ UpdateLocationNfsRequest.add_member(:on_prem_config, Shapes::ShapeRef.new(shape: OnPremConfig, location_name: "OnPremConfig"))
621
+ UpdateLocationNfsRequest.add_member(:mount_options, Shapes::ShapeRef.new(shape: NfsMountOptions, location_name: "MountOptions"))
622
+ UpdateLocationNfsRequest.struct_class = Types::UpdateLocationNfsRequest
623
+
624
+ UpdateLocationNfsResponse.struct_class = Types::UpdateLocationNfsResponse
625
+
626
+ UpdateLocationObjectStorageRequest.add_member(:location_arn, Shapes::ShapeRef.new(shape: LocationArn, required: true, location_name: "LocationArn"))
627
+ UpdateLocationObjectStorageRequest.add_member(:server_port, Shapes::ShapeRef.new(shape: ObjectStorageServerPort, location_name: "ServerPort"))
628
+ UpdateLocationObjectStorageRequest.add_member(:server_protocol, Shapes::ShapeRef.new(shape: ObjectStorageServerProtocol, location_name: "ServerProtocol"))
629
+ UpdateLocationObjectStorageRequest.add_member(:subdirectory, Shapes::ShapeRef.new(shape: S3Subdirectory, location_name: "Subdirectory"))
630
+ UpdateLocationObjectStorageRequest.add_member(:access_key, Shapes::ShapeRef.new(shape: ObjectStorageAccessKey, location_name: "AccessKey"))
631
+ UpdateLocationObjectStorageRequest.add_member(:secret_key, Shapes::ShapeRef.new(shape: ObjectStorageSecretKey, location_name: "SecretKey"))
632
+ UpdateLocationObjectStorageRequest.add_member(:agent_arns, Shapes::ShapeRef.new(shape: AgentArnList, location_name: "AgentArns"))
633
+ UpdateLocationObjectStorageRequest.struct_class = Types::UpdateLocationObjectStorageRequest
634
+
635
+ UpdateLocationObjectStorageResponse.struct_class = Types::UpdateLocationObjectStorageResponse
636
+
637
+ UpdateLocationSmbRequest.add_member(:location_arn, Shapes::ShapeRef.new(shape: LocationArn, required: true, location_name: "LocationArn"))
638
+ UpdateLocationSmbRequest.add_member(:subdirectory, Shapes::ShapeRef.new(shape: SmbSubdirectory, location_name: "Subdirectory"))
639
+ UpdateLocationSmbRequest.add_member(:user, Shapes::ShapeRef.new(shape: SmbUser, location_name: "User"))
640
+ UpdateLocationSmbRequest.add_member(:domain, Shapes::ShapeRef.new(shape: SmbDomain, location_name: "Domain"))
641
+ UpdateLocationSmbRequest.add_member(:password, Shapes::ShapeRef.new(shape: SmbPassword, location_name: "Password"))
642
+ UpdateLocationSmbRequest.add_member(:agent_arns, Shapes::ShapeRef.new(shape: AgentArnList, location_name: "AgentArns"))
643
+ UpdateLocationSmbRequest.add_member(:mount_options, Shapes::ShapeRef.new(shape: SmbMountOptions, location_name: "MountOptions"))
644
+ UpdateLocationSmbRequest.struct_class = Types::UpdateLocationSmbRequest
645
+
646
+ UpdateLocationSmbResponse.struct_class = Types::UpdateLocationSmbResponse
647
+
648
+ UpdateTaskExecutionRequest.add_member(:task_execution_arn, Shapes::ShapeRef.new(shape: TaskExecutionArn, required: true, location_name: "TaskExecutionArn"))
649
+ UpdateTaskExecutionRequest.add_member(:options, Shapes::ShapeRef.new(shape: Options, required: true, location_name: "Options"))
650
+ UpdateTaskExecutionRequest.struct_class = Types::UpdateTaskExecutionRequest
651
+
652
+ UpdateTaskExecutionResponse.struct_class = Types::UpdateTaskExecutionResponse
653
+
608
654
  UpdateTaskRequest.add_member(:task_arn, Shapes::ShapeRef.new(shape: TaskArn, required: true, location_name: "TaskArn"))
609
655
  UpdateTaskRequest.add_member(:options, Shapes::ShapeRef.new(shape: Options, location_name: "Options"))
610
656
  UpdateTaskRequest.add_member(:excludes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Excludes"))
@@ -965,6 +1011,36 @@ module Aws::DataSync
965
1011
  o.errors << Shapes::ShapeRef.new(shape: InternalException)
966
1012
  end)
967
1013
 
1014
+ api.add_operation(:update_location_nfs, Seahorse::Model::Operation.new.tap do |o|
1015
+ o.name = "UpdateLocationNfs"
1016
+ o.http_method = "POST"
1017
+ o.http_request_uri = "/"
1018
+ o.input = Shapes::ShapeRef.new(shape: UpdateLocationNfsRequest)
1019
+ o.output = Shapes::ShapeRef.new(shape: UpdateLocationNfsResponse)
1020
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1021
+ o.errors << Shapes::ShapeRef.new(shape: InternalException)
1022
+ end)
1023
+
1024
+ api.add_operation(:update_location_object_storage, Seahorse::Model::Operation.new.tap do |o|
1025
+ o.name = "UpdateLocationObjectStorage"
1026
+ o.http_method = "POST"
1027
+ o.http_request_uri = "/"
1028
+ o.input = Shapes::ShapeRef.new(shape: UpdateLocationObjectStorageRequest)
1029
+ o.output = Shapes::ShapeRef.new(shape: UpdateLocationObjectStorageResponse)
1030
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1031
+ o.errors << Shapes::ShapeRef.new(shape: InternalException)
1032
+ end)
1033
+
1034
+ api.add_operation(:update_location_smb, Seahorse::Model::Operation.new.tap do |o|
1035
+ o.name = "UpdateLocationSmb"
1036
+ o.http_method = "POST"
1037
+ o.http_request_uri = "/"
1038
+ o.input = Shapes::ShapeRef.new(shape: UpdateLocationSmbRequest)
1039
+ o.output = Shapes::ShapeRef.new(shape: UpdateLocationSmbResponse)
1040
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1041
+ o.errors << Shapes::ShapeRef.new(shape: InternalException)
1042
+ end)
1043
+
968
1044
  api.add_operation(:update_task, Seahorse::Model::Operation.new.tap do |o|
969
1045
  o.name = "UpdateTask"
970
1046
  o.http_method = "POST"
@@ -974,6 +1050,16 @@ module Aws::DataSync
974
1050
  o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
975
1051
  o.errors << Shapes::ShapeRef.new(shape: InternalException)
976
1052
  end)
1053
+
1054
+ api.add_operation(:update_task_execution, Seahorse::Model::Operation.new.tap do |o|
1055
+ o.name = "UpdateTaskExecution"
1056
+ o.http_method = "POST"
1057
+ o.http_request_uri = "/"
1058
+ o.input = Shapes::ShapeRef.new(shape: UpdateTaskExecutionRequest)
1059
+ o.output = Shapes::ShapeRef.new(shape: UpdateTaskExecutionResponse)
1060
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1061
+ o.errors << Shapes::ShapeRef.new(shape: InternalException)
1062
+ end)
977
1063
  end
978
1064
 
979
1065
  end
@@ -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
@@ -287,18 +295,19 @@ module Aws::DataSync
287
295
  #
288
296
  # @!attribute [rw] subdirectory
289
297
  # A subdirectory in the location’s path. This subdirectory in the
290
- # Amazon FSx for Windows file system is used to read data from the
291
- # Amazon FSx for Windows source location or write data to the FSx for
292
- # Windows destination.
298
+ # Amazon FSx for Windows File Server file system is used to read data
299
+ # from the Amazon FSx for Windows File Server source location or write
300
+ # data to the FSx for Windows File Server destination.
293
301
  # @return [String]
294
302
  #
295
303
  # @!attribute [rw] fsx_filesystem_arn
296
- # The Amazon Resource Name (ARN) for the FSx for Windows file system.
304
+ # The Amazon Resource Name (ARN) for the FSx for Windows File Server
305
+ # file system.
297
306
  # @return [String]
298
307
  #
299
308
  # @!attribute [rw] security_group_arns
300
309
  # The Amazon Resource Names (ARNs) of the security groups that are to
301
- # use to configure the FSx for Windows file system.
310
+ # use to configure the FSx for Windows File Server file system.
302
311
  # @return [Array<String>]
303
312
  #
304
313
  # @!attribute [rw] tags
@@ -310,17 +319,21 @@ module Aws::DataSync
310
319
  #
311
320
  # @!attribute [rw] user
312
321
  # The user who has the permissions to access files and folders in the
313
- # FSx for Windows file system.
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).
314
327
  # @return [String]
315
328
  #
316
329
  # @!attribute [rw] domain
317
- # The name of the Windows domain that the FSx for Windows server
330
+ # The name of the Windows domain that the FSx for Windows File Server
318
331
  # belongs to.
319
332
  # @return [String]
320
333
  #
321
334
  # @!attribute [rw] password
322
335
  # The password of the user who has the permissions to access files and
323
- # folders in the FSx for Windows file system.
336
+ # folders in the FSx for Windows File Server file system.
324
337
  # @return [String]
325
338
  #
326
339
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationFsxWindowsRequest AWS API Documentation
@@ -338,8 +351,8 @@ module Aws::DataSync
338
351
  end
339
352
 
340
353
  # @!attribute [rw] location_arn
341
- # The Amazon Resource Name (ARN) of the FSx for Windows file system
342
- # location that is created.
354
+ # The Amazon Resource Name (ARN) of the FSx for Windows File Server
355
+ # file system location that is created.
343
356
  # @return [String]
344
357
  #
345
358
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationFsxWindowsResponse AWS API Documentation
@@ -379,7 +392,7 @@ module Aws::DataSync
379
392
  # a subdirectory of that path. The path should be such that it can be
380
393
  # mounted by other NFS clients in your network.
381
394
  #
382
- # To see all the paths exported by your NFS server. run "`showmount
395
+ # To see all the paths exported by your NFS server, run "`showmount
383
396
  # -e nfs-server-name`" from an NFS client that has access to your
384
397
  # server. You can specify any directory that appears in the results,
385
398
  # and any subdirectory of that directory. Ensure that the NFS export
@@ -610,8 +623,8 @@ module Aws::DataSync
610
623
  # @return [String]
611
624
  #
612
625
  # @!attribute [rw] s3_bucket_arn
613
- # The Amazon Resource Name (ARN) of the Amazon S3 bucket. If the
614
- # bucket is on an AWS Outpost, this must be an access point ARN.
626
+ # The ARN of the Amazon S3 bucket. If the bucket is on an AWS Outpost,
627
+ # this must be an access point ARN.
615
628
  # @return [String]
616
629
  #
617
630
  # @!attribute [rw] s3_storage_class
@@ -621,13 +634,15 @@ module Aws::DataSync
621
634
  # Outposts, the storage class defaults to AWS S3 Outposts.
622
635
  #
623
636
  # For more information about S3 storage classes, see [Amazon S3
624
- # Storage Classes][1] in the *Amazon Simple Storage Service Developer
625
- # Guide*. Some storage classes have behaviors that can affect your S3
626
- # storage cost. For detailed information, see using-storage-classes.
637
+ # Storage Classes][1]. Some storage classes have behaviors that can
638
+ # affect your S3 storage cost. For detailed information, see
639
+ # [Considerations when working with S3 storage classes in
640
+ # DataSync][2].
627
641
  #
628
642
  #
629
643
  #
630
- # [1]: https://aws.amazon.com/s3/storage-classes/
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
631
646
  # @return [String]
632
647
  #
633
648
  # @!attribute [rw] s3_config
@@ -640,9 +655,13 @@ module Aws::DataSync
640
655
  #
641
656
  # @!attribute [rw] agent_arns
642
657
  # If you are using DataSync on an AWS Outpost, specify the Amazon
643
- # Resource Names (ARNs) of the DataSync agents deployed on your AWS
658
+ # Resource Names (ARNs) of the DataSync agents deployed on your
644
659
  # Outpost. For more information about launching a DataSync agent on an
645
- # Amazon 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
646
665
  # @return [Array<String>]
647
666
  #
648
667
  # @!attribute [rw] tags
@@ -740,6 +759,10 @@ module Aws::DataSync
740
759
  # @!attribute [rw] user
741
760
  # The user who can mount the share, has the permissions to access
742
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).
743
766
  # @return [String]
744
767
  #
745
768
  # @!attribute [rw] domain
@@ -820,6 +843,7 @@ module Aws::DataSync
820
843
  # task_queueing: "ENABLED", # accepts ENABLED, DISABLED
821
844
  # log_level: "OFF", # accepts OFF, BASIC, TRANSFER
822
845
  # transfer_mode: "CHANGED", # accepts CHANGED, ALL
846
+ # security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
823
847
  # },
824
848
  # excludes: [
825
849
  # {
@@ -866,20 +890,29 @@ module Aws::DataSync
866
890
  #
867
891
  # For each individual task execution, you can override these options
868
892
  # by specifying the `OverrideOptions` before starting the task
869
- # 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
870
899
  # @return [Types::Options]
871
900
  #
872
901
  # @!attribute [rw] excludes
873
902
  # A list of filter rules that determines which files to exclude from a
874
903
  # task. The list should contain a single filter string that consists
875
904
  # of the patterns to exclude. The patterns are delimited by "\|"
876
- # (that is, a pipe), for example, `"/folder1|/folder2"`
905
+ # (that is, a pipe), for example, `"/folder1|/folder2"`.
877
906
  # @return [Array<Types::FilterRule>]
878
907
  #
879
908
  # @!attribute [rw] schedule
880
909
  # Specifies a schedule used to periodically transfer files from a
881
910
  # source to a destination location. The schedule should be specified
882
- # 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
883
916
  # @return [Types::TaskSchedule]
884
917
  #
885
918
  # @!attribute [rw] tags
@@ -1034,7 +1067,7 @@ module Aws::DataSync
1034
1067
  # @return [String]
1035
1068
  #
1036
1069
  # @!attribute [rw] last_connection_time
1037
- # The time that the agent last connected to DataSyc.
1070
+ # The time that the agent last connected to DataSync.
1038
1071
  # @return [Time]
1039
1072
  #
1040
1073
  # @!attribute [rw] creation_time
@@ -1130,8 +1163,8 @@ module Aws::DataSync
1130
1163
  # }
1131
1164
  #
1132
1165
  # @!attribute [rw] location_arn
1133
- # The Amazon Resource Name (ARN) of the FSx for Windows location to
1134
- # describe.
1166
+ # The Amazon Resource Name (ARN) of the FSx for Windows File Server
1167
+ # location to describe.
1135
1168
  # @return [String]
1136
1169
  #
1137
1170
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationFsxWindowsRequest AWS API Documentation
@@ -1143,30 +1176,31 @@ module Aws::DataSync
1143
1176
  end
1144
1177
 
1145
1178
  # @!attribute [rw] location_arn
1146
- # The Amazon Resource Name (ARN) of the FSx for Windows location that
1147
- # was described.
1179
+ # The Amazon Resource Name (ARN) of the FSx for Windows File Server
1180
+ # location that was described.
1148
1181
  # @return [String]
1149
1182
  #
1150
1183
  # @!attribute [rw] location_uri
1151
- # The URL of the FSx for Windows location that was described.
1184
+ # The URL of the FSx for Windows File Server location that was
1185
+ # described.
1152
1186
  # @return [String]
1153
1187
  #
1154
1188
  # @!attribute [rw] security_group_arns
1155
1189
  # The Amazon Resource Names (ARNs) of the security groups that are
1156
- # configured for the FSx for Windows file system.
1190
+ # configured for the FSx for Windows File Server file system.
1157
1191
  # @return [Array<String>]
1158
1192
  #
1159
1193
  # @!attribute [rw] creation_time
1160
- # The time that the FSx for Windows location was created.
1194
+ # The time that the FSx for Windows File Server location was created.
1161
1195
  # @return [Time]
1162
1196
  #
1163
1197
  # @!attribute [rw] user
1164
1198
  # The user who has the permissions to access files and folders in the
1165
- # FSx for Windows file system.
1199
+ # FSx for Windows File Server file system.
1166
1200
  # @return [String]
1167
1201
  #
1168
1202
  # @!attribute [rw] domain
1169
- # The name of the Windows domain that the FSx for Windows server
1203
+ # The name of the Windows domain that the FSx for Windows File Server
1170
1204
  # belongs to.
1171
1205
  # @return [String]
1172
1206
  #
@@ -1354,13 +1388,14 @@ module Aws::DataSync
1354
1388
  # The Amazon S3 storage class that you chose to store your files in
1355
1389
  # when this location is used as a task destination. For more
1356
1390
  # information about S3 storage classes, see [Amazon S3 Storage
1357
- # Classes][1] in the *Amazon Simple Storage Service Developer Guide*.
1358
- # Some storage classes have behaviors that can affect your S3 storage
1359
- # cost. For detailed information, see using-storage-classes.
1391
+ # Classes][1]. Some storage classes have behaviors that can affect
1392
+ # your S3 storage cost. For detailed information, see [Considerations
1393
+ # when working with S3 storage classes in DataSync][2].
1360
1394
  #
1361
1395
  #
1362
1396
  #
1363
- # [1]: https://aws.amazon.com/s3/storage-classes/
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
1364
1399
  # @return [String]
1365
1400
  #
1366
1401
  # @!attribute [rw] s3_config
@@ -1372,10 +1407,14 @@ module Aws::DataSync
1372
1407
  # @return [Types::S3Config]
1373
1408
  #
1374
1409
  # @!attribute [rw] agent_arns
1375
- # If you are using DataSync on an Amazon Outpost, the Amazon Resource
1376
- # Name (ARNs) of the EC2 agents deployed on your AWS Outpost. For more
1377
- # information about launching a DataSync agent on an Amazon Outpost,
1378
- # see outposts-agent.
1410
+ # If you are using DataSync on an AWS Outpost, the Amazon Resource
1411
+ # Name (ARNs) of the EC2 agents deployed on your Outpost. For more
1412
+ # information about launching a DataSync agent on an AWS Outpost, see
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
1379
1418
  # @return [Array<String>]
1380
1419
  #
1381
1420
  # @!attribute [rw] creation_time
@@ -1424,7 +1463,7 @@ module Aws::DataSync
1424
1463
  # @return [String]
1425
1464
  #
1426
1465
  # @!attribute [rw] location_uri
1427
- # The URL of the source SBM location that was described.
1466
+ # The URL of the source SMB location that was described.
1428
1467
  # @return [String]
1429
1468
  #
1430
1469
  # @!attribute [rw] agent_arns
@@ -1507,15 +1546,20 @@ module Aws::DataSync
1507
1546
  #
1508
1547
  # @!attribute [rw] options
1509
1548
  # Represents the options that are available to control the behavior of
1510
- # a StartTaskExecution operation. Behavior includes preserving
1549
+ # a [StartTaskExecution][1] operation. Behavior includes preserving
1511
1550
  # metadata such as user ID (UID), group ID (GID), and file
1512
1551
  # permissions, and also overwriting files in the destination, data
1513
1552
  # integrity verification, and so on.
1514
1553
  #
1515
1554
  # A task has a set of default options associated with it. If you
1516
- # don't specify an option in StartTaskExecution, the default value is
1517
- # used. You can override the defaults options on each task execution
1518
- # 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
1519
1563
  # @return [Types::Options]
1520
1564
  #
1521
1565
  # @!attribute [rw] excludes
@@ -1627,7 +1671,7 @@ module Aws::DataSync
1627
1671
  # The status of the task that was described.
1628
1672
  #
1629
1673
  # For detailed information about task execution statuses, see
1630
- # Understanding Task Statuses in the *AWS DataSync User Guide.*
1674
+ # Understanding Task Statuses in the *AWS DataSync User Guide*.
1631
1675
  # @return [String]
1632
1676
  #
1633
1677
  # @!attribute [rw] name
@@ -1675,7 +1719,12 @@ module Aws::DataSync
1675
1719
  # data integrity verification, and so on.
1676
1720
  #
1677
1721
  # For each individual task execution, you can override these options
1678
- # 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
1679
1728
  # @return [Types::Options]
1680
1729
  #
1681
1730
  # @!attribute [rw] excludes
@@ -1760,7 +1809,7 @@ module Aws::DataSync
1760
1809
  include Aws::Structure
1761
1810
  end
1762
1811
 
1763
- # Specifies which files, folders and objects to include or exclude when
1812
+ # Specifies which files, folders, and objects to include or exclude when
1764
1813
  # transferring files from source to destination.
1765
1814
  #
1766
1815
  # @note When making an API call, you may pass FilterRule
@@ -2137,7 +2186,11 @@ module Aws::DataSync
2137
2186
  # @!attribute [rw] operator
2138
2187
  # The operator that is used to compare filter values (for example,
2139
2188
  # `Equals` or `Contains`). For more about API filtering operators, see
2140
- # 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
2141
2194
  # @return [String]
2142
2195
  #
2143
2196
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/LocationFilter AWS API Documentation
@@ -2152,7 +2205,11 @@ module Aws::DataSync
2152
2205
 
2153
2206
  # Represents a single entry in a list of locations. `LocationListEntry`
2154
2207
  # returns an array that contains a list of locations when the
2155
- # 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
2156
2213
  #
2157
2214
  # @!attribute [rw] location_arn
2158
2215
  # The Amazon Resource Name (ARN) of the location. For Network File
@@ -2163,7 +2220,7 @@ module Aws::DataSync
2163
2220
  #
2164
2221
  # @!attribute [rw] location_uri
2165
2222
  # Represents a list of URLs of a location. `LocationUri` returns an
2166
- # array that contains a list of locations when the ListLocations
2223
+ # array that contains a list of locations when the [ListLocations][1]
2167
2224
  # operation is called.
2168
2225
  #
2169
2226
  # Format: `TYPE://GLOBAL_ID/SUBDIR`.
@@ -2181,6 +2238,12 @@ module Aws::DataSync
2181
2238
  # is the *nix convention. For NFS and Amazon EFS, it's the export
2182
2239
  # path to mount the location. For Amazon S3, it's the prefix path
2183
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
2184
2247
  # @return [String]
2185
2248
  #
2186
2249
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/LocationListEntry AWS API Documentation
@@ -2256,15 +2319,19 @@ module Aws::DataSync
2256
2319
  end
2257
2320
 
2258
2321
  # Represents the options that are available to control the behavior of a
2259
- # StartTaskExecution operation. Behavior includes preserving metadata
2260
- # such as user ID (UID), group ID (GID), and file permissions, and also
2261
- # overwriting files in the destination, data integrity verification, and
2262
- # 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.
2263
2326
  #
2264
2327
  # A task has a set of default options associated with it. If you don't
2265
- # specify an option in StartTaskExecution, the default value is used.
2266
- # You can override the defaults options on each task execution by
2267
- # 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
2268
2335
  #
2269
2336
  # @note When making an API call, you may pass Options
2270
2337
  # data as a hash:
@@ -2283,13 +2350,14 @@ module Aws::DataSync
2283
2350
  # task_queueing: "ENABLED", # accepts ENABLED, DISABLED
2284
2351
  # log_level: "OFF", # accepts OFF, BASIC, TRANSFER
2285
2352
  # transfer_mode: "CHANGED", # accepts CHANGED, ALL
2353
+ # security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
2286
2354
  # }
2287
2355
  #
2288
2356
  # @!attribute [rw] verify_mode
2289
2357
  # A value that determines whether a data integrity verification should
2290
2358
  # be performed at the end of a task execution after all data and
2291
- # metadata have been transferred. For more information, see
2292
- # create-task
2359
+ # metadata have been transferred. For more information, see [Configure
2360
+ # task settings][1].
2293
2361
  #
2294
2362
  # Default value: POINT\_IN\_TIME\_CONSISTENT.
2295
2363
  #
@@ -2305,6 +2373,10 @@ module Aws::DataSync
2305
2373
  # NONE: No additional verification is done at the end of the transfer,
2306
2374
  # but all data transmissions are integrity-checked with checksum
2307
2375
  # verification during the transfer.
2376
+ #
2377
+ #
2378
+ #
2379
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html
2308
2380
  # @return [String]
2309
2381
  #
2310
2382
  # @!attribute [rw] overwrite_mode
@@ -2316,8 +2388,13 @@ module Aws::DataSync
2316
2388
  # protect against overwriting those changes.
2317
2389
  #
2318
2390
  # Some storage classes have specific behaviors that can affect your S3
2319
- # storage cost. For detailed information, see using-storage-classes in
2320
- # 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
2321
2398
  # @return [String]
2322
2399
  #
2323
2400
  # @!attribute [rw] atime
@@ -2345,7 +2422,9 @@ module Aws::DataSync
2345
2422
  #
2346
2423
  # @!attribute [rw] mtime
2347
2424
  # A value that indicates the last time that a file was modified (that
2348
- # 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.
2349
2428
  #
2350
2429
  # Default value: PRESERVE.
2351
2430
  #
@@ -2361,7 +2440,10 @@ module Aws::DataSync
2361
2440
  # @return [String]
2362
2441
  #
2363
2442
  # @!attribute [rw] uid
2364
- # 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].
2365
2447
  #
2366
2448
  # Default value: INT\_VALUE. This preserves the integer value of the
2367
2449
  # ID.
@@ -2370,10 +2452,17 @@ module Aws::DataSync
2370
2452
  # (recommended).
2371
2453
  #
2372
2454
  # NONE: Ignore UID and GID.
2455
+ #
2456
+ #
2457
+ #
2458
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied
2373
2459
  # @return [String]
2374
2460
  #
2375
2461
  # @!attribute [rw] gid
2376
- # 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].
2377
2466
  #
2378
2467
  # Default value: INT\_VALUE. This preserves the integer value of the
2379
2468
  # ID.
@@ -2382,6 +2471,10 @@ module Aws::DataSync
2382
2471
  # (recommended).
2383
2472
  #
2384
2473
  # NONE: Ignore UID and GID.
2474
+ #
2475
+ #
2476
+ #
2477
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied
2385
2478
  # @return [String]
2386
2479
  #
2387
2480
  # @!attribute [rw] preserve_deleted_files
@@ -2389,21 +2482,27 @@ module Aws::DataSync
2389
2482
  # exist in the source file system should be preserved. This option can
2390
2483
  # affect your storage cost. If your task deletes objects, you might
2391
2484
  # incur minimum storage duration charges for certain storage classes.
2392
- # For detailed information, see using-storage-classes in the *AWS
2393
- # 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*.
2394
2488
  #
2395
2489
  # Default value: PRESERVE.
2396
2490
  #
2397
2491
  # PRESERVE: Ignore such destination files (recommended).
2398
2492
  #
2399
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
2400
2498
  # @return [String]
2401
2499
  #
2402
2500
  # @!attribute [rw] preserve_devices
2403
2501
  # A value that determines whether AWS DataSync should preserve the
2404
2502
  # metadata of block and character devices in the source file system,
2405
- # and recreate the files with that device name and metadata on the
2406
- # 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.
2407
2506
  #
2408
2507
  # <note markdown="1"> AWS DataSync can't sync the actual contents of such devices,
2409
2508
  # because they are nonterminal and don't return an end-of-file (EOF)
@@ -2422,7 +2521,9 @@ module Aws::DataSync
2422
2521
  # @!attribute [rw] posix_permissions
2423
2522
  # A value that determines which users or groups can access a file for
2424
2523
  # a specific purpose such as reading, writing, or execution of the
2425
- # 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].
2426
2527
  #
2427
2528
  # Default value: PRESERVE.
2428
2529
  #
@@ -2433,6 +2534,10 @@ module Aws::DataSync
2433
2534
  # <note markdown="1"> AWS DataSync can preserve extant permissions of a source location.
2434
2535
  #
2435
2536
  # </note>
2537
+ #
2538
+ #
2539
+ #
2540
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied
2436
2541
  # @return [String]
2437
2542
  #
2438
2543
  # @!attribute [rw] bytes_per_second
@@ -2447,8 +2552,12 @@ module Aws::DataSync
2447
2552
  # The default is `ENABLED`.
2448
2553
  #
2449
2554
  # If you use the same agent to run multiple tasks, you can enable the
2450
- # tasks to run in series. For more information, see
2451
- # 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
2452
2561
  # @return [String]
2453
2562
  #
2454
2563
  # @!attribute [rw] log_level
@@ -2479,6 +2588,57 @@ module Aws::DataSync
2479
2588
  # without comparing to existing content on the destination.
2480
2589
  # @return [String]
2481
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
+ #
2482
2642
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/Options AWS API Documentation
2483
2643
  #
2484
2644
  class Options < Struct.new(
@@ -2494,7 +2654,8 @@ module Aws::DataSync
2494
2654
  :bytes_per_second,
2495
2655
  :task_queueing,
2496
2656
  :log_level,
2497
- :transfer_mode)
2657
+ :transfer_mode,
2658
+ :security_descriptor_copy_flags)
2498
2659
  SENSITIVE = []
2499
2660
  include Aws::Structure
2500
2661
  end
@@ -2556,7 +2717,11 @@ module Aws::DataSync
2556
2717
  #
2557
2718
  # @!attribute [rw] bucket_access_role_arn
2558
2719
  # The Amazon S3 bucket to access. This bucket is used as a parameter
2559
- # 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
2560
2725
  # @return [String]
2561
2726
  #
2562
2727
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/S3Config AWS API Documentation
@@ -2613,6 +2778,7 @@ module Aws::DataSync
2613
2778
  # task_queueing: "ENABLED", # accepts ENABLED, DISABLED
2614
2779
  # log_level: "OFF", # accepts OFF, BASIC, TRANSFER
2615
2780
  # transfer_mode: "CHANGED", # accepts CHANGED, ALL
2781
+ # security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
2616
2782
  # },
2617
2783
  # includes: [
2618
2784
  # {
@@ -2628,15 +2794,20 @@ module Aws::DataSync
2628
2794
  #
2629
2795
  # @!attribute [rw] override_options
2630
2796
  # Represents the options that are available to control the behavior of
2631
- # a StartTaskExecution operation. Behavior includes preserving
2797
+ # a [StartTaskExecution][1] operation. Behavior includes preserving
2632
2798
  # metadata such as user ID (UID), group ID (GID), and file
2633
2799
  # permissions, and also overwriting files in the destination, data
2634
2800
  # integrity verification, and so on.
2635
2801
  #
2636
2802
  # A task has a set of default options associated with it. If you
2637
- # don't specify an option in StartTaskExecution, the default value is
2638
- # used. You can override the defaults options on each task execution
2639
- # 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
2640
2811
  # @return [Types::Options]
2641
2812
  #
2642
2813
  # @!attribute [rw] includes
@@ -2673,7 +2844,11 @@ module Aws::DataSync
2673
2844
 
2674
2845
  # Represents a single entry in a list of AWS resource tags.
2675
2846
  # `TagListEntry` returns an array that contains a list of tasks when the
2676
- # 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
2677
2852
  #
2678
2853
  # @note When making an API call, you may pass TagListEntry
2679
2854
  # data as a hash:
@@ -2738,8 +2913,12 @@ module Aws::DataSync
2738
2913
 
2739
2914
  # Represents a single entry in a list of task executions.
2740
2915
  # `TaskExecutionListEntry` returns an array that contains a list of
2741
- # specific invocations of a task when ListTaskExecutions operation is
2742
- # 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
2743
2922
  #
2744
2923
  # @!attribute [rw] task_execution_arn
2745
2924
  # The Amazon Resource Name (ARN) of the task that was executed.
@@ -2782,7 +2961,7 @@ module Aws::DataSync
2782
2961
  # @return [Integer]
2783
2962
  #
2784
2963
  # @!attribute [rw] transfer_status
2785
- # The status of the TRANSFERRING Phase.
2964
+ # The status of the TRANSFERRING phase.
2786
2965
  # @return [String]
2787
2966
  #
2788
2967
  # @!attribute [rw] verify_duration
@@ -2791,7 +2970,7 @@ module Aws::DataSync
2791
2970
  # @return [Integer]
2792
2971
  #
2793
2972
  # @!attribute [rw] verify_status
2794
- # The status of the VERIFYING Phase.
2973
+ # The status of the VERIFYING phase.
2795
2974
  # @return [String]
2796
2975
  #
2797
2976
  # @!attribute [rw] error_code
@@ -2849,7 +3028,11 @@ module Aws::DataSync
2849
3028
  # @!attribute [rw] operator
2850
3029
  # The operator that is used to compare filter values (for example,
2851
3030
  # `Equals` or `Contains`). For more about API filtering operators, see
2852
- # 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
2853
3036
  # @return [String]
2854
3037
  #
2855
3038
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskFilter AWS API Documentation
@@ -2863,9 +3046,13 @@ module Aws::DataSync
2863
3046
  end
2864
3047
 
2865
3048
  # Represents a single entry in a list of tasks. `TaskListEntry` returns
2866
- # an array that contains a list of tasks when the ListTasks operation is
2867
- # called. A task includes the source and destination file systems to
2868
- # 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
2869
3056
  #
2870
3057
  # @!attribute [rw] task_arn
2871
3058
  # The Amazon Resource Name (ARN) of the task.
@@ -2980,6 +3167,304 @@ module Aws::DataSync
2980
3167
  #
2981
3168
  class UpdateAgentResponse < Aws::EmptyStructure; end
2982
3169
 
3170
+ # @note When making an API call, you may pass UpdateLocationNfsRequest
3171
+ # data as a hash:
3172
+ #
3173
+ # {
3174
+ # location_arn: "LocationArn", # required
3175
+ # subdirectory: "NfsSubdirectory",
3176
+ # on_prem_config: {
3177
+ # agent_arns: ["AgentArn"], # required
3178
+ # },
3179
+ # mount_options: {
3180
+ # version: "AUTOMATIC", # accepts AUTOMATIC, NFS3, NFS4_0, NFS4_1
3181
+ # },
3182
+ # }
3183
+ #
3184
+ # @!attribute [rw] location_arn
3185
+ # The Amazon Resource Name (ARN) of the NFS location to update.
3186
+ # @return [String]
3187
+ #
3188
+ # @!attribute [rw] subdirectory
3189
+ # The subdirectory in the NFS file system that is used to read data
3190
+ # from the NFS source location or write data to the NFS destination.
3191
+ # The NFS path should be a path that's exported by the NFS server, or
3192
+ # a subdirectory of that path. The path should be such that it can be
3193
+ # mounted by other NFS clients in your network.
3194
+ #
3195
+ # To see all the paths exported by your NFS server, run "`showmount
3196
+ # -e nfs-server-name`" from an NFS client that has access to your
3197
+ # server. You can specify any directory that appears in the results,
3198
+ # and any subdirectory of that directory. Ensure that the NFS export
3199
+ # is accessible without Kerberos authentication.
3200
+ #
3201
+ # To transfer all the data in the folder that you specified, DataSync
3202
+ # must have permissions to read all the data. To ensure this, either
3203
+ # configure the NFS export with `no_root_squash`, or ensure that the
3204
+ # files you want DataSync to access have permissions that allow read
3205
+ # access for all users. Doing either option enables the agent to read
3206
+ # the files. For the agent to access directories, you must
3207
+ # additionally enable all execute access.
3208
+ #
3209
+ # If you are copying data to or from your AWS Snowcone device, see
3210
+ # [NFS Server on AWS Snowcone][1] for more information.
3211
+ #
3212
+ # For information about NFS export configuration, see 18.7. The
3213
+ # /etc/exports Configuration File in the Red Hat Enterprise Linux
3214
+ # documentation.
3215
+ #
3216
+ #
3217
+ #
3218
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone
3219
+ # @return [String]
3220
+ #
3221
+ # @!attribute [rw] on_prem_config
3222
+ # A list of Amazon Resource Names (ARNs) of agents to use for a
3223
+ # Network File System (NFS) location.
3224
+ # @return [Types::OnPremConfig]
3225
+ #
3226
+ # @!attribute [rw] mount_options
3227
+ # Represents the mount options that are available for DataSync to
3228
+ # access an NFS location.
3229
+ # @return [Types::NfsMountOptions]
3230
+ #
3231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationNfsRequest AWS API Documentation
3232
+ #
3233
+ class UpdateLocationNfsRequest < Struct.new(
3234
+ :location_arn,
3235
+ :subdirectory,
3236
+ :on_prem_config,
3237
+ :mount_options)
3238
+ SENSITIVE = []
3239
+ include Aws::Structure
3240
+ end
3241
+
3242
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationNfsResponse AWS API Documentation
3243
+ #
3244
+ class UpdateLocationNfsResponse < Aws::EmptyStructure; end
3245
+
3246
+ # @note When making an API call, you may pass UpdateLocationObjectStorageRequest
3247
+ # data as a hash:
3248
+ #
3249
+ # {
3250
+ # location_arn: "LocationArn", # required
3251
+ # server_port: 1,
3252
+ # server_protocol: "HTTPS", # accepts HTTPS, HTTP
3253
+ # subdirectory: "S3Subdirectory",
3254
+ # access_key: "ObjectStorageAccessKey",
3255
+ # secret_key: "ObjectStorageSecretKey",
3256
+ # agent_arns: ["AgentArn"],
3257
+ # }
3258
+ #
3259
+ # @!attribute [rw] location_arn
3260
+ # The Amazon Resource Name (ARN) of the self-managed object storage
3261
+ # server location to be updated.
3262
+ # @return [String]
3263
+ #
3264
+ # @!attribute [rw] server_port
3265
+ # The port that your self-managed object storage server accepts
3266
+ # inbound network traffic on. The server port is set by default to TCP
3267
+ # 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your
3268
+ # self-managed object storage server requires one.
3269
+ # @return [Integer]
3270
+ #
3271
+ # @!attribute [rw] server_protocol
3272
+ # The protocol that the object storage server uses to communicate.
3273
+ # Valid values are `HTTP` or `HTTPS`.
3274
+ # @return [String]
3275
+ #
3276
+ # @!attribute [rw] subdirectory
3277
+ # The subdirectory in the self-managed object storage server that is
3278
+ # used to read data from.
3279
+ # @return [String]
3280
+ #
3281
+ # @!attribute [rw] access_key
3282
+ # Optional. The access key is used if credentials are required to
3283
+ # access the self-managed object storage server. If your object
3284
+ # storage requires a user name and password to authenticate, use
3285
+ # `AccessKey` and `SecretKey` to provide the user name and password,
3286
+ # respectively.
3287
+ # @return [String]
3288
+ #
3289
+ # @!attribute [rw] secret_key
3290
+ # Optional. The secret key is used if credentials are required to
3291
+ # access the self-managed object storage server. If your object
3292
+ # storage requires a user name and password to authenticate, use
3293
+ # `AccessKey` and `SecretKey` to provide the user name and password,
3294
+ # respectively.
3295
+ # @return [String]
3296
+ #
3297
+ # @!attribute [rw] agent_arns
3298
+ # The Amazon Resource Name (ARN) of the agents associated with the
3299
+ # self-managed object storage server location.
3300
+ # @return [Array<String>]
3301
+ #
3302
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationObjectStorageRequest AWS API Documentation
3303
+ #
3304
+ class UpdateLocationObjectStorageRequest < Struct.new(
3305
+ :location_arn,
3306
+ :server_port,
3307
+ :server_protocol,
3308
+ :subdirectory,
3309
+ :access_key,
3310
+ :secret_key,
3311
+ :agent_arns)
3312
+ SENSITIVE = [:secret_key]
3313
+ include Aws::Structure
3314
+ end
3315
+
3316
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationObjectStorageResponse AWS API Documentation
3317
+ #
3318
+ class UpdateLocationObjectStorageResponse < Aws::EmptyStructure; end
3319
+
3320
+ # @note When making an API call, you may pass UpdateLocationSmbRequest
3321
+ # data as a hash:
3322
+ #
3323
+ # {
3324
+ # location_arn: "LocationArn", # required
3325
+ # subdirectory: "SmbSubdirectory",
3326
+ # user: "SmbUser",
3327
+ # domain: "SmbDomain",
3328
+ # password: "SmbPassword",
3329
+ # agent_arns: ["AgentArn"],
3330
+ # mount_options: {
3331
+ # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
3332
+ # },
3333
+ # }
3334
+ #
3335
+ # @!attribute [rw] location_arn
3336
+ # The Amazon Resource Name (ARN) of the SMB location to update.
3337
+ # @return [String]
3338
+ #
3339
+ # @!attribute [rw] subdirectory
3340
+ # The subdirectory in the SMB file system that is used to read data
3341
+ # from the SMB source location or write data to the SMB destination.
3342
+ # The SMB path should be a path that's exported by the SMB server, or
3343
+ # a subdirectory of that path. The path should be such that it can be
3344
+ # mounted by other SMB clients in your network.
3345
+ #
3346
+ # <note markdown="1"> `Subdirectory` must be specified with forward slashes. For example,
3347
+ # `/path/to/folder`.
3348
+ #
3349
+ # </note>
3350
+ #
3351
+ # To transfer all the data in the folder that you specified, DataSync
3352
+ # must have permissions to mount the SMB share and to access all the
3353
+ # data in that share. To ensure this, do either of the following:
3354
+ #
3355
+ # * Ensure that the user/password specified belongs to the user who
3356
+ # can mount the share and who has the appropriate permissions for
3357
+ # all of the files and directories that you want DataSync to access.
3358
+ #
3359
+ # * Use credentials of a member of the Backup Operators group to mount
3360
+ # the share.
3361
+ #
3362
+ # Doing either of these options enables the agent to access the data.
3363
+ # For the agent to access directories, you must also enable all
3364
+ # execute access.
3365
+ # @return [String]
3366
+ #
3367
+ # @!attribute [rw] user
3368
+ # The user who can mount the share has the permissions to access files
3369
+ # and folders in the SMB share.
3370
+ # @return [String]
3371
+ #
3372
+ # @!attribute [rw] domain
3373
+ # The name of the Windows domain that the SMB server belongs to.
3374
+ # @return [String]
3375
+ #
3376
+ # @!attribute [rw] password
3377
+ # The password of the user who can mount the share has the permissions
3378
+ # to access files and folders in the SMB share.
3379
+ # @return [String]
3380
+ #
3381
+ # @!attribute [rw] agent_arns
3382
+ # The Amazon Resource Names (ARNs) of agents to use for a Simple
3383
+ # Message Block (SMB) location.
3384
+ # @return [Array<String>]
3385
+ #
3386
+ # @!attribute [rw] mount_options
3387
+ # Represents the mount options that are available for DataSync to
3388
+ # access an SMB location.
3389
+ # @return [Types::SmbMountOptions]
3390
+ #
3391
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationSmbRequest AWS API Documentation
3392
+ #
3393
+ class UpdateLocationSmbRequest < Struct.new(
3394
+ :location_arn,
3395
+ :subdirectory,
3396
+ :user,
3397
+ :domain,
3398
+ :password,
3399
+ :agent_arns,
3400
+ :mount_options)
3401
+ SENSITIVE = [:password]
3402
+ include Aws::Structure
3403
+ end
3404
+
3405
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationSmbResponse AWS API Documentation
3406
+ #
3407
+ class UpdateLocationSmbResponse < Aws::EmptyStructure; end
3408
+
3409
+ # @note When making an API call, you may pass UpdateTaskExecutionRequest
3410
+ # data as a hash:
3411
+ #
3412
+ # {
3413
+ # task_execution_arn: "TaskExecutionArn", # required
3414
+ # options: { # required
3415
+ # verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED, NONE
3416
+ # overwrite_mode: "ALWAYS", # accepts ALWAYS, NEVER
3417
+ # atime: "NONE", # accepts NONE, BEST_EFFORT
3418
+ # mtime: "NONE", # accepts NONE, PRESERVE
3419
+ # uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
3420
+ # gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
3421
+ # preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
3422
+ # preserve_devices: "NONE", # accepts NONE, PRESERVE
3423
+ # posix_permissions: "NONE", # accepts NONE, PRESERVE
3424
+ # bytes_per_second: 1,
3425
+ # task_queueing: "ENABLED", # accepts ENABLED, DISABLED
3426
+ # log_level: "OFF", # accepts OFF, BASIC, TRANSFER
3427
+ # transfer_mode: "CHANGED", # accepts CHANGED, ALL
3428
+ # security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
3429
+ # },
3430
+ # }
3431
+ #
3432
+ # @!attribute [rw] task_execution_arn
3433
+ # The Amazon Resource Name (ARN) of the specific task execution that
3434
+ # is being updated.
3435
+ # @return [String]
3436
+ #
3437
+ # @!attribute [rw] options
3438
+ # Represents the options that are available to control the behavior of
3439
+ # a [StartTaskExecution][1] operation. Behavior includes preserving
3440
+ # metadata such as user ID (UID), group ID (GID), and file
3441
+ # permissions, and also overwriting files in the destination, data
3442
+ # integrity verification, and so on.
3443
+ #
3444
+ # A task has a set of default options associated with it. If you
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
3453
+ # @return [Types::Options]
3454
+ #
3455
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskExecutionRequest AWS API Documentation
3456
+ #
3457
+ class UpdateTaskExecutionRequest < Struct.new(
3458
+ :task_execution_arn,
3459
+ :options)
3460
+ SENSITIVE = []
3461
+ include Aws::Structure
3462
+ end
3463
+
3464
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskExecutionResponse AWS API Documentation
3465
+ #
3466
+ class UpdateTaskExecutionResponse < Aws::EmptyStructure; end
3467
+
2983
3468
  # UpdateTaskResponse
2984
3469
  #
2985
3470
  # @note When making an API call, you may pass UpdateTaskRequest
@@ -3001,6 +3486,7 @@ module Aws::DataSync
3001
3486
  # task_queueing: "ENABLED", # accepts ENABLED, DISABLED
3002
3487
  # log_level: "OFF", # accepts OFF, BASIC, TRANSFER
3003
3488
  # transfer_mode: "CHANGED", # accepts CHANGED, ALL
3489
+ # security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
3004
3490
  # },
3005
3491
  # excludes: [
3006
3492
  # {
@@ -3022,15 +3508,20 @@ module Aws::DataSync
3022
3508
  #
3023
3509
  # @!attribute [rw] options
3024
3510
  # Represents the options that are available to control the behavior of
3025
- # a StartTaskExecution operation. Behavior includes preserving
3511
+ # a [StartTaskExecution][1] operation. Behavior includes preserving
3026
3512
  # metadata such as user ID (UID), group ID (GID), and file
3027
3513
  # permissions, and also overwriting files in the destination, data
3028
3514
  # integrity verification, and so on.
3029
3515
  #
3030
3516
  # A task has a set of default options associated with it. If you
3031
- # don't specify an option in StartTaskExecution, the default value is
3032
- # used. You can override the defaults options on each task execution
3033
- # 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
3034
3525
  # @return [Types::Options]
3035
3526
  #
3036
3527
  # @!attribute [rw] excludes
@@ -3045,8 +3536,12 @@ module Aws::DataSync
3045
3536
  # source to a destination location. You can configure your task to
3046
3537
  # execute hourly, daily, weekly or on specific days of the week. You
3047
3538
  # control when in the day or hour you want the task to execute. The
3048
- # time you specify is UTC time. For more information, see
3049
- # 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
3050
3545
  # @return [Types::TaskSchedule]
3051
3546
  #
3052
3547
  # @!attribute [rw] name