aws-sdk-datasync 1.31.0 → 1.35.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-datasync/client.rb +213 -93
- data/lib/aws-sdk-datasync/client_api.rb +6 -0
- data/lib/aws-sdk-datasync/types.rb +390 -138
- data/lib/aws-sdk-datasync.rb +1 -1
- metadata +7 -8
@@ -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')
|
@@ -289,6 +290,7 @@ module Aws::DataSync
|
|
289
290
|
CreateTaskRequest.add_member(:excludes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Excludes"))
|
290
291
|
CreateTaskRequest.add_member(:schedule, Shapes::ShapeRef.new(shape: TaskSchedule, location_name: "Schedule"))
|
291
292
|
CreateTaskRequest.add_member(:tags, Shapes::ShapeRef.new(shape: InputTagList, location_name: "Tags"))
|
293
|
+
CreateTaskRequest.add_member(:includes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Includes"))
|
292
294
|
CreateTaskRequest.struct_class = Types::CreateTaskRequest
|
293
295
|
|
294
296
|
CreateTaskResponse.add_member(:task_arn, Shapes::ShapeRef.new(shape: TaskArn, location_name: "TaskArn"))
|
@@ -421,6 +423,7 @@ module Aws::DataSync
|
|
421
423
|
DescribeTaskResponse.add_member(:error_code, Shapes::ShapeRef.new(shape: string, location_name: "ErrorCode"))
|
422
424
|
DescribeTaskResponse.add_member(:error_detail, Shapes::ShapeRef.new(shape: string, location_name: "ErrorDetail"))
|
423
425
|
DescribeTaskResponse.add_member(:creation_time, Shapes::ShapeRef.new(shape: Time, location_name: "CreationTime"))
|
426
|
+
DescribeTaskResponse.add_member(:includes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Includes"))
|
424
427
|
DescribeTaskResponse.struct_class = Types::DescribeTaskResponse
|
425
428
|
|
426
429
|
DestinationNetworkInterfaceArns.member = Shapes::ShapeRef.new(shape: NetworkInterfaceArn)
|
@@ -525,6 +528,7 @@ module Aws::DataSync
|
|
525
528
|
Options.add_member(:task_queueing, Shapes::ShapeRef.new(shape: TaskQueueing, location_name: "TaskQueueing"))
|
526
529
|
Options.add_member(:log_level, Shapes::ShapeRef.new(shape: LogLevel, location_name: "LogLevel"))
|
527
530
|
Options.add_member(:transfer_mode, Shapes::ShapeRef.new(shape: TransferMode, location_name: "TransferMode"))
|
531
|
+
Options.add_member(:security_descriptor_copy_flags, Shapes::ShapeRef.new(shape: SmbSecurityDescriptorCopyFlags, location_name: "SecurityDescriptorCopyFlags"))
|
528
532
|
Options.struct_class = Types::Options
|
529
533
|
|
530
534
|
OutputTagList.member = Shapes::ShapeRef.new(shape: TagListEntry)
|
@@ -550,6 +554,7 @@ module Aws::DataSync
|
|
550
554
|
StartTaskExecutionRequest.add_member(:task_arn, Shapes::ShapeRef.new(shape: TaskArn, required: true, location_name: "TaskArn"))
|
551
555
|
StartTaskExecutionRequest.add_member(:override_options, Shapes::ShapeRef.new(shape: Options, location_name: "OverrideOptions"))
|
552
556
|
StartTaskExecutionRequest.add_member(:includes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Includes"))
|
557
|
+
StartTaskExecutionRequest.add_member(:excludes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Excludes"))
|
553
558
|
StartTaskExecutionRequest.struct_class = Types::StartTaskExecutionRequest
|
554
559
|
|
555
560
|
StartTaskExecutionResponse.add_member(:task_execution_arn, Shapes::ShapeRef.new(shape: TaskExecutionArn, location_name: "TaskExecutionArn"))
|
@@ -655,6 +660,7 @@ module Aws::DataSync
|
|
655
660
|
UpdateTaskRequest.add_member(:schedule, Shapes::ShapeRef.new(shape: TaskSchedule, location_name: "Schedule"))
|
656
661
|
UpdateTaskRequest.add_member(:name, Shapes::ShapeRef.new(shape: TagValue, location_name: "Name"))
|
657
662
|
UpdateTaskRequest.add_member(:cloud_watch_log_group_arn, Shapes::ShapeRef.new(shape: LogGroupArn, location_name: "CloudWatchLogGroupArn"))
|
663
|
+
UpdateTaskRequest.add_member(:includes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Includes"))
|
658
664
|
UpdateTaskRequest.struct_class = Types::UpdateTaskRequest
|
659
665
|
|
660
666
|
UpdateTaskResponse.struct_class = Types::UpdateTaskResponse
|
@@ -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
|
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.
|
@@ -84,7 +88,7 @@ module Aws::DataSync
|
|
84
88
|
# Your agent activation key. You can get the activation key either by
|
85
89
|
# sending an HTTP GET request with redirects that enable you to get
|
86
90
|
# the agent IP address (port 80). Alternatively, you can get it from
|
87
|
-
# the
|
91
|
+
# the DataSync console.
|
88
92
|
#
|
89
93
|
# The redirect URL returned in the response provides you the
|
90
94
|
# activation key for your agent in the query string parameter
|
@@ -93,8 +97,8 @@ module Aws::DataSync
|
|
93
97
|
# pass to this API call determine the actual configuration of your
|
94
98
|
# agent.
|
95
99
|
#
|
96
|
-
# For more information, see Activating an Agent in the *
|
97
|
-
#
|
100
|
+
# For more information, see Activating an Agent in the *DataSync User
|
101
|
+
# Guide.*
|
98
102
|
# @return [String]
|
99
103
|
#
|
100
104
|
# @!attribute [rw] agent_name
|
@@ -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
|
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
|
@@ -161,8 +169,8 @@ module Aws::DataSync
|
|
161
169
|
#
|
162
170
|
# @!attribute [rw] agent_arn
|
163
171
|
# The Amazon Resource Name (ARN) of the agent. Use the `ListAgents`
|
164
|
-
# operation to return a list of agents for your account and
|
165
|
-
# Region.
|
172
|
+
# operation to return a list of agents for your account and Amazon Web
|
173
|
+
# Services Region.
|
166
174
|
# @return [String]
|
167
175
|
#
|
168
176
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateAgentResponse AWS API Documentation
|
@@ -196,7 +204,7 @@ module Aws::DataSync
|
|
196
204
|
# @!attribute [rw] subdirectory
|
197
205
|
# A subdirectory in the location’s path. This subdirectory in the EFS
|
198
206
|
# file system is used to read data from the EFS source location or
|
199
|
-
# write data to the EFS destination. By default,
|
207
|
+
# write data to the EFS destination. By default, DataSync uses the
|
200
208
|
# root directory.
|
201
209
|
#
|
202
210
|
# <note markdown="1"> `Subdirectory` must be specified with forward slashes. For example,
|
@@ -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
|
@@ -394,8 +406,8 @@ module Aws::DataSync
|
|
394
406
|
# files. For the agent to access directories, you must additionally
|
395
407
|
# enable all execute access.
|
396
408
|
#
|
397
|
-
# If you are copying data to or from your
|
398
|
-
#
|
409
|
+
# If you are copying data to or from your Snowcone device, see [NFS
|
410
|
+
# Server on Snowcone][1] for more information.
|
399
411
|
#
|
400
412
|
# For information about NFS export configuration, see 18.7. The
|
401
413
|
# /etc/exports Configuration File in the Red Hat Enterprise Linux
|
@@ -412,8 +424,8 @@ module Aws::DataSync
|
|
412
424
|
# installed on-premises uses this host name to mount the NFS server in
|
413
425
|
# a network.
|
414
426
|
#
|
415
|
-
# If you are copying data to or from your
|
416
|
-
#
|
427
|
+
# If you are copying data to or from your Snowcone device, see [NFS
|
428
|
+
# Server on Snowcone][1] for more information.
|
417
429
|
#
|
418
430
|
# <note markdown="1"> This name must either be DNS-compliant or must be an IP version 4
|
419
431
|
# (IPv4) address.
|
@@ -429,8 +441,8 @@ module Aws::DataSync
|
|
429
441
|
# Contains a list of Amazon Resource Names (ARNs) of agents that are
|
430
442
|
# used to connect to an NFS server.
|
431
443
|
#
|
432
|
-
# If you are copying data to or from your
|
433
|
-
#
|
444
|
+
# If you are copying data to or from your Snowcone device, see [NFS
|
445
|
+
# Server on Snowcone][1] for more information.
|
434
446
|
#
|
435
447
|
#
|
436
448
|
#
|
@@ -611,39 +623,47 @@ module Aws::DataSync
|
|
611
623
|
# @return [String]
|
612
624
|
#
|
613
625
|
# @!attribute [rw] s3_bucket_arn
|
614
|
-
# The ARN of the Amazon S3 bucket. If the bucket is on an
|
615
|
-
# this must be an access point ARN.
|
626
|
+
# The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web
|
627
|
+
# Services Outpost, this must be an access point ARN.
|
616
628
|
# @return [String]
|
617
629
|
#
|
618
630
|
# @!attribute [rw] s3_storage_class
|
619
631
|
# The Amazon S3 storage class that you want to store your files in
|
620
|
-
# when this location is used as a task destination. For buckets in
|
621
|
-
# Regions, the storage class defaults to Standard.
|
622
|
-
# Outposts, the storage class defaults to
|
632
|
+
# when this location is used as a task destination. For buckets in
|
633
|
+
# Amazon Web Services Regions, the storage class defaults to Standard.
|
634
|
+
# For buckets on Outposts, the storage class defaults to Amazon Web
|
635
|
+
# Services S3 Outposts.
|
623
636
|
#
|
624
637
|
# For more information about S3 storage classes, see [Amazon S3
|
625
638
|
# Storage Classes][1]. Some storage classes have behaviors that can
|
626
639
|
# affect your S3 storage cost. For detailed information, see
|
627
|
-
#
|
640
|
+
# [Considerations when working with S3 storage classes in
|
641
|
+
# DataSync][2].
|
628
642
|
#
|
629
643
|
#
|
630
644
|
#
|
631
645
|
# [1]: http://aws.amazon.com/s3/storage-classes/
|
646
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
|
632
647
|
# @return [String]
|
633
648
|
#
|
634
649
|
# @!attribute [rw] s3_config
|
635
|
-
# The Amazon Resource Name (ARN) of the
|
636
|
-
#
|
650
|
+
# The Amazon Resource Name (ARN) of the Identity and Access Management
|
651
|
+
# (IAM) role that is used to access an Amazon S3 bucket.
|
637
652
|
#
|
638
653
|
# For detailed information about using such a role, see Creating a
|
639
|
-
# Location for Amazon S3 in the *
|
654
|
+
# Location for Amazon S3 in the *DataSync User Guide*.
|
640
655
|
# @return [Types::S3Config]
|
641
656
|
#
|
642
657
|
# @!attribute [rw] agent_arns
|
643
|
-
# If you are using DataSync on an
|
644
|
-
# Resource Names (ARNs) of the DataSync agents deployed on
|
645
|
-
# Outpost. For more information about launching a DataSync agent
|
646
|
-
#
|
658
|
+
# If you are using DataSync on an Amazon Web Services Outpost, specify
|
659
|
+
# the Amazon Resource Names (ARNs) of the DataSync agents deployed on
|
660
|
+
# your Outpost. For more information about launching a DataSync agent
|
661
|
+
# on an Amazon Web Services Outpost, see [Deploy your DataSync agent
|
662
|
+
# on Outposts][1].
|
663
|
+
#
|
664
|
+
#
|
665
|
+
#
|
666
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent
|
647
667
|
# @return [Array<String>]
|
648
668
|
#
|
649
669
|
# @!attribute [rw] tags
|
@@ -741,6 +761,10 @@ module Aws::DataSync
|
|
741
761
|
# @!attribute [rw] user
|
742
762
|
# The user who can mount the share, has the permissions to access
|
743
763
|
# files and folders in the SMB share.
|
764
|
+
#
|
765
|
+
# For information about choosing a user name that ensures sufficient
|
766
|
+
# permissions to files, folders, and metadata, see
|
767
|
+
# [user](create-smb-location.html#SMBuser).
|
744
768
|
# @return [String]
|
745
769
|
#
|
746
770
|
# @!attribute [rw] domain
|
@@ -821,6 +845,7 @@ module Aws::DataSync
|
|
821
845
|
# task_queueing: "ENABLED", # accepts ENABLED, DISABLED
|
822
846
|
# log_level: "OFF", # accepts OFF, BASIC, TRANSFER
|
823
847
|
# transfer_mode: "CHANGED", # accepts CHANGED, ALL
|
848
|
+
# security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
|
824
849
|
# },
|
825
850
|
# excludes: [
|
826
851
|
# {
|
@@ -837,6 +862,12 @@ module Aws::DataSync
|
|
837
862
|
# value: "TagValue",
|
838
863
|
# },
|
839
864
|
# ],
|
865
|
+
# includes: [
|
866
|
+
# {
|
867
|
+
# filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
|
868
|
+
# value: "FilterValue",
|
869
|
+
# },
|
870
|
+
# ],
|
840
871
|
# }
|
841
872
|
#
|
842
873
|
# @!attribute [rw] source_location_arn
|
@@ -844,8 +875,8 @@ module Aws::DataSync
|
|
844
875
|
# @return [String]
|
845
876
|
#
|
846
877
|
# @!attribute [rw] destination_location_arn
|
847
|
-
# The Amazon Resource Name (ARN) of an
|
848
|
-
# location.
|
878
|
+
# The Amazon Resource Name (ARN) of an Amazon Web Services storage
|
879
|
+
# resource's location.
|
849
880
|
# @return [String]
|
850
881
|
#
|
851
882
|
# @!attribute [rw] cloud_watch_log_group_arn
|
@@ -867,7 +898,12 @@ module Aws::DataSync
|
|
867
898
|
#
|
868
899
|
# For each individual task execution, you can override these options
|
869
900
|
# by specifying the `OverrideOptions` before starting the task
|
870
|
-
# execution. For more information, see the
|
901
|
+
# execution. For more information, see the [StartTaskExecution][1]
|
902
|
+
# operation.
|
903
|
+
#
|
904
|
+
#
|
905
|
+
#
|
906
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
871
907
|
# @return [Types::Options]
|
872
908
|
#
|
873
909
|
# @!attribute [rw] excludes
|
@@ -880,7 +916,11 @@ module Aws::DataSync
|
|
880
916
|
# @!attribute [rw] schedule
|
881
917
|
# Specifies a schedule used to periodically transfer files from a
|
882
918
|
# source to a destination location. The schedule should be specified
|
883
|
-
# in UTC time. For more information, see task
|
919
|
+
# in UTC time. For more information, see [Scheduling your task][1].
|
920
|
+
#
|
921
|
+
#
|
922
|
+
#
|
923
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
|
884
924
|
# @return [Types::TaskSchedule]
|
885
925
|
#
|
886
926
|
# @!attribute [rw] tags
|
@@ -888,6 +928,13 @@ module Aws::DataSync
|
|
888
928
|
# the resource. The value can be an empty string.
|
889
929
|
# @return [Array<Types::TagListEntry>]
|
890
930
|
#
|
931
|
+
# @!attribute [rw] includes
|
932
|
+
# A list of filter rules that determines which files to include when
|
933
|
+
# running a task. The pattern should contain a single filter string
|
934
|
+
# that consists of the patterns to include. The patterns are delimited
|
935
|
+
# by "\|" (that is, a pipe). For example: `"/folder1|/folder2`"
|
936
|
+
# @return [Array<Types::FilterRule>]
|
937
|
+
#
|
891
938
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateTaskRequest AWS API Documentation
|
892
939
|
#
|
893
940
|
class CreateTaskRequest < Struct.new(
|
@@ -898,7 +945,8 @@ module Aws::DataSync
|
|
898
945
|
:options,
|
899
946
|
:excludes,
|
900
947
|
:schedule,
|
901
|
-
:tags
|
948
|
+
:tags,
|
949
|
+
:includes)
|
902
950
|
SENSITIVE = []
|
903
951
|
include Aws::Structure
|
904
952
|
end
|
@@ -929,7 +977,7 @@ module Aws::DataSync
|
|
929
977
|
# @!attribute [rw] agent_arn
|
930
978
|
# The Amazon Resource Name (ARN) of the agent to delete. Use the
|
931
979
|
# `ListAgents` operation to return a list of agents for your account
|
932
|
-
# and
|
980
|
+
# and Amazon Web Services Region.
|
933
981
|
# @return [String]
|
934
982
|
#
|
935
983
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DeleteAgentRequest AWS API Documentation
|
@@ -1035,7 +1083,7 @@ module Aws::DataSync
|
|
1035
1083
|
# @return [String]
|
1036
1084
|
#
|
1037
1085
|
# @!attribute [rw] last_connection_time
|
1038
|
-
# The time that the agent last connected to
|
1086
|
+
# The time that the agent last connected to DataSync.
|
1039
1087
|
# @return [Time]
|
1040
1088
|
#
|
1041
1089
|
# @!attribute [rw] creation_time
|
@@ -1357,27 +1405,33 @@ module Aws::DataSync
|
|
1357
1405
|
# when this location is used as a task destination. For more
|
1358
1406
|
# information about S3 storage classes, see [Amazon S3 Storage
|
1359
1407
|
# Classes][1]. Some storage classes have behaviors that can affect
|
1360
|
-
# your S3 storage cost. For detailed information, see
|
1361
|
-
#
|
1408
|
+
# your S3 storage cost. For detailed information, see [Considerations
|
1409
|
+
# when working with S3 storage classes in DataSync][2].
|
1362
1410
|
#
|
1363
1411
|
#
|
1364
1412
|
#
|
1365
1413
|
# [1]: http://aws.amazon.com/s3/storage-classes/
|
1414
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
|
1366
1415
|
# @return [String]
|
1367
1416
|
#
|
1368
1417
|
# @!attribute [rw] s3_config
|
1369
|
-
# The Amazon Resource Name (ARN) of the
|
1370
|
-
#
|
1418
|
+
# The Amazon Resource Name (ARN) of the Identity and Access Management
|
1419
|
+
# (IAM) role that is used to access an Amazon S3 bucket.
|
1371
1420
|
#
|
1372
1421
|
# For detailed information about using such a role, see Creating a
|
1373
|
-
# Location for Amazon S3 in the *
|
1422
|
+
# Location for Amazon S3 in the *DataSync User Guide*.
|
1374
1423
|
# @return [Types::S3Config]
|
1375
1424
|
#
|
1376
1425
|
# @!attribute [rw] agent_arns
|
1377
|
-
# If you are using DataSync on an
|
1378
|
-
# Name (ARNs) of the EC2 agents deployed on your
|
1379
|
-
# information about launching a DataSync agent on an
|
1380
|
-
#
|
1426
|
+
# If you are using DataSync on an Amazon Web Services Outpost, the
|
1427
|
+
# Amazon Resource Name (ARNs) of the EC2 agents deployed on your
|
1428
|
+
# Outpost. For more information about launching a DataSync agent on an
|
1429
|
+
# Amazon Web Services Outpost, see [Deploy your DataSync agent on
|
1430
|
+
# Outposts][1].
|
1431
|
+
#
|
1432
|
+
#
|
1433
|
+
#
|
1434
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent
|
1381
1435
|
# @return [Array<String>]
|
1382
1436
|
#
|
1383
1437
|
# @!attribute [rw] creation_time
|
@@ -1426,7 +1480,7 @@ module Aws::DataSync
|
|
1426
1480
|
# @return [String]
|
1427
1481
|
#
|
1428
1482
|
# @!attribute [rw] location_uri
|
1429
|
-
# The URL of the source
|
1483
|
+
# The URL of the source SMB location that was described.
|
1430
1484
|
# @return [String]
|
1431
1485
|
#
|
1432
1486
|
# @!attribute [rw] agent_arns
|
@@ -1504,20 +1558,25 @@ module Aws::DataSync
|
|
1504
1558
|
# The status of the task execution.
|
1505
1559
|
#
|
1506
1560
|
# For detailed information about task execution statuses, see
|
1507
|
-
# Understanding Task Statuses in the *
|
1561
|
+
# Understanding Task Statuses in the *DataSync User Guide.*
|
1508
1562
|
# @return [String]
|
1509
1563
|
#
|
1510
1564
|
# @!attribute [rw] options
|
1511
1565
|
# Represents the options that are available to control the behavior of
|
1512
|
-
# a StartTaskExecution operation. Behavior includes preserving
|
1566
|
+
# a [StartTaskExecution][1] operation. Behavior includes preserving
|
1513
1567
|
# metadata such as user ID (UID), group ID (GID), and file
|
1514
1568
|
# permissions, and also overwriting files in the destination, data
|
1515
1569
|
# integrity verification, and so on.
|
1516
1570
|
#
|
1517
1571
|
# A task has a set of default options associated with it. If you
|
1518
|
-
# don't specify an option in StartTaskExecution, the default
|
1519
|
-
# used. You can override the defaults options on each task
|
1520
|
-
# by specifying an overriding `Options` value to
|
1572
|
+
# don't specify an option in [StartTaskExecution][1], the default
|
1573
|
+
# value is used. You can override the defaults options on each task
|
1574
|
+
# execution by specifying an overriding `Options` value to
|
1575
|
+
# [StartTaskExecution][1].
|
1576
|
+
#
|
1577
|
+
#
|
1578
|
+
#
|
1579
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
1521
1580
|
# @return [Types::Options]
|
1522
1581
|
#
|
1523
1582
|
# @!attribute [rw] excludes
|
@@ -1567,8 +1626,8 @@ module Aws::DataSync
|
|
1567
1626
|
# @return [Integer]
|
1568
1627
|
#
|
1569
1628
|
# @!attribute [rw] bytes_written
|
1570
|
-
# The number of logical bytes written to the destination
|
1571
|
-
# resource.
|
1629
|
+
# The number of logical bytes written to the destination Amazon Web
|
1630
|
+
# Services storage resource.
|
1572
1631
|
# @return [Integer]
|
1573
1632
|
#
|
1574
1633
|
# @!attribute [rw] bytes_transferred
|
@@ -1629,7 +1688,7 @@ module Aws::DataSync
|
|
1629
1688
|
# The status of the task that was described.
|
1630
1689
|
#
|
1631
1690
|
# For detailed information about task execution statuses, see
|
1632
|
-
# Understanding Task Statuses in the *
|
1691
|
+
# Understanding Task Statuses in the *DataSync User Guide*.
|
1633
1692
|
# @return [String]
|
1634
1693
|
#
|
1635
1694
|
# @!attribute [rw] name
|
@@ -1647,8 +1706,8 @@ module Aws::DataSync
|
|
1647
1706
|
# @return [String]
|
1648
1707
|
#
|
1649
1708
|
# @!attribute [rw] destination_location_arn
|
1650
|
-
# The Amazon Resource Name (ARN) of the
|
1651
|
-
# location.
|
1709
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services storage
|
1710
|
+
# resource's location.
|
1652
1711
|
# @return [String]
|
1653
1712
|
#
|
1654
1713
|
# @!attribute [rw] cloud_watch_log_group_arn
|
@@ -1677,7 +1736,12 @@ module Aws::DataSync
|
|
1677
1736
|
# data integrity verification, and so on.
|
1678
1737
|
#
|
1679
1738
|
# For each individual task execution, you can override these options
|
1680
|
-
# by specifying the overriding `OverrideOptions` value to
|
1739
|
+
# by specifying the overriding `OverrideOptions` value to
|
1740
|
+
# [StartTaskExecution][1] operation.
|
1741
|
+
#
|
1742
|
+
#
|
1743
|
+
#
|
1744
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
1681
1745
|
# @return [Types::Options]
|
1682
1746
|
#
|
1683
1747
|
# @!attribute [rw] excludes
|
@@ -1693,8 +1757,8 @@ module Aws::DataSync
|
|
1693
1757
|
# @return [Types::TaskSchedule]
|
1694
1758
|
#
|
1695
1759
|
# @!attribute [rw] error_code
|
1696
|
-
# Errors that
|
1697
|
-
#
|
1760
|
+
# Errors that DataSync encountered during execution of the task. You
|
1761
|
+
# can use this error code to help troubleshoot issues.
|
1698
1762
|
# @return [String]
|
1699
1763
|
#
|
1700
1764
|
# @!attribute [rw] error_detail
|
@@ -1707,6 +1771,13 @@ module Aws::DataSync
|
|
1707
1771
|
# The time that the task was created.
|
1708
1772
|
# @return [Time]
|
1709
1773
|
#
|
1774
|
+
# @!attribute [rw] includes
|
1775
|
+
# A list of filter rules that determines which files to include when
|
1776
|
+
# running a task. The pattern should contain a single filter string
|
1777
|
+
# that consists of the patterns to include. The patterns are delimited
|
1778
|
+
# by "\|" (that is, a pipe). For example: `"/folder1|/folder2`"
|
1779
|
+
# @return [Array<Types::FilterRule>]
|
1780
|
+
#
|
1710
1781
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskResponse AWS API Documentation
|
1711
1782
|
#
|
1712
1783
|
class DescribeTaskResponse < Struct.new(
|
@@ -1724,7 +1795,8 @@ module Aws::DataSync
|
|
1724
1795
|
:schedule,
|
1725
1796
|
:error_code,
|
1726
1797
|
:error_detail,
|
1727
|
-
:creation_time
|
1798
|
+
:creation_time,
|
1799
|
+
:includes)
|
1728
1800
|
SENSITIVE = []
|
1729
1801
|
include Aws::Structure
|
1730
1802
|
end
|
@@ -1762,7 +1834,7 @@ module Aws::DataSync
|
|
1762
1834
|
include Aws::Structure
|
1763
1835
|
end
|
1764
1836
|
|
1765
|
-
# Specifies which files, folders and objects to include or exclude when
|
1837
|
+
# Specifies which files, folders, and objects to include or exclude when
|
1766
1838
|
# transferring files from source to destination.
|
1767
1839
|
#
|
1768
1840
|
# @note When making an API call, you may pass FilterRule
|
@@ -1774,7 +1846,7 @@ module Aws::DataSync
|
|
1774
1846
|
# }
|
1775
1847
|
#
|
1776
1848
|
# @!attribute [rw] filter_type
|
1777
|
-
# The type of filter rule to apply.
|
1849
|
+
# The type of filter rule to apply. DataSync only supports the
|
1778
1850
|
# SIMPLE\_PATTERN rule type.
|
1779
1851
|
# @return [String]
|
1780
1852
|
#
|
@@ -1793,8 +1865,7 @@ module Aws::DataSync
|
|
1793
1865
|
include Aws::Structure
|
1794
1866
|
end
|
1795
1867
|
|
1796
|
-
# This exception is thrown when an error occurs in the
|
1797
|
-
# service.
|
1868
|
+
# This exception is thrown when an error occurs in the DataSync service.
|
1798
1869
|
#
|
1799
1870
|
# @!attribute [rw] message
|
1800
1871
|
# @return [String]
|
@@ -2139,7 +2210,11 @@ module Aws::DataSync
|
|
2139
2210
|
# @!attribute [rw] operator
|
2140
2211
|
# The operator that is used to compare filter values (for example,
|
2141
2212
|
# `Equals` or `Contains`). For more about API filtering operators, see
|
2142
|
-
#
|
2213
|
+
# [API filters for ListTasks and ListLocations][1].
|
2214
|
+
#
|
2215
|
+
#
|
2216
|
+
#
|
2217
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html
|
2143
2218
|
# @return [String]
|
2144
2219
|
#
|
2145
2220
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/LocationFilter AWS API Documentation
|
@@ -2154,7 +2229,11 @@ module Aws::DataSync
|
|
2154
2229
|
|
2155
2230
|
# Represents a single entry in a list of locations. `LocationListEntry`
|
2156
2231
|
# returns an array that contains a list of locations when the
|
2157
|
-
# ListLocations operation is called.
|
2232
|
+
# [ListLocations][1] operation is called.
|
2233
|
+
#
|
2234
|
+
#
|
2235
|
+
#
|
2236
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html
|
2158
2237
|
#
|
2159
2238
|
# @!attribute [rw] location_arn
|
2160
2239
|
# The Amazon Resource Name (ARN) of the location. For Network File
|
@@ -2165,7 +2244,7 @@ module Aws::DataSync
|
|
2165
2244
|
#
|
2166
2245
|
# @!attribute [rw] location_uri
|
2167
2246
|
# Represents a list of URLs of a location. `LocationUri` returns an
|
2168
|
-
# array that contains a list of locations when the ListLocations
|
2247
|
+
# array that contains a list of locations when the [ListLocations][1]
|
2169
2248
|
# operation is called.
|
2170
2249
|
#
|
2171
2250
|
# Format: `TYPE://GLOBAL_ID/SUBDIR`.
|
@@ -2183,6 +2262,12 @@ module Aws::DataSync
|
|
2183
2262
|
# is the *nix convention. For NFS and Amazon EFS, it's the export
|
2184
2263
|
# path to mount the location. For Amazon S3, it's the prefix path
|
2185
2264
|
# that you mount to and treat as the root of the location.
|
2265
|
+
#
|
2266
|
+
#
|
2267
|
+
#
|
2268
|
+
#
|
2269
|
+
#
|
2270
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html
|
2186
2271
|
# @return [String]
|
2187
2272
|
#
|
2188
2273
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/LocationListEntry AWS API Documentation
|
@@ -2258,15 +2343,19 @@ module Aws::DataSync
|
|
2258
2343
|
end
|
2259
2344
|
|
2260
2345
|
# Represents the options that are available to control the behavior of a
|
2261
|
-
# StartTaskExecution operation. Behavior includes preserving
|
2262
|
-
# such as user ID (UID), group ID (GID), and file permissions,
|
2263
|
-
# overwriting files in the destination, data integrity
|
2264
|
-
# so on.
|
2346
|
+
# [StartTaskExecution][1] operation. Behavior includes preserving
|
2347
|
+
# metadata such as user ID (UID), group ID (GID), and file permissions,
|
2348
|
+
# and also overwriting files in the destination, data integrity
|
2349
|
+
# verification, and so on.
|
2265
2350
|
#
|
2266
2351
|
# 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
|
2268
|
-
# You can override the defaults options on each task execution by
|
2269
|
-
# specifying an overriding `Options` value to StartTaskExecution.
|
2352
|
+
# specify an option in [StartTaskExecution][1], the default value is
|
2353
|
+
# used. You can override the defaults options on each task execution by
|
2354
|
+
# specifying an overriding `Options` value to [StartTaskExecution][1].
|
2355
|
+
#
|
2356
|
+
#
|
2357
|
+
#
|
2358
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
2270
2359
|
#
|
2271
2360
|
# @note When making an API call, you may pass Options
|
2272
2361
|
# data as a hash:
|
@@ -2285,13 +2374,14 @@ module Aws::DataSync
|
|
2285
2374
|
# task_queueing: "ENABLED", # accepts ENABLED, DISABLED
|
2286
2375
|
# log_level: "OFF", # accepts OFF, BASIC, TRANSFER
|
2287
2376
|
# transfer_mode: "CHANGED", # accepts CHANGED, ALL
|
2377
|
+
# security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
|
2288
2378
|
# }
|
2289
2379
|
#
|
2290
2380
|
# @!attribute [rw] verify_mode
|
2291
2381
|
# A value that determines whether a data integrity verification should
|
2292
2382
|
# be performed at the end of a task execution after all data and
|
2293
|
-
# metadata have been transferred. For more information, see
|
2294
|
-
#
|
2383
|
+
# metadata have been transferred. For more information, see [Configure
|
2384
|
+
# task settings][1].
|
2295
2385
|
#
|
2296
2386
|
# Default value: POINT\_IN\_TIME\_CONSISTENT.
|
2297
2387
|
#
|
@@ -2307,6 +2397,10 @@ module Aws::DataSync
|
|
2307
2397
|
# NONE: No additional verification is done at the end of the transfer,
|
2308
2398
|
# but all data transmissions are integrity-checked with checksum
|
2309
2399
|
# verification during the transfer.
|
2400
|
+
#
|
2401
|
+
#
|
2402
|
+
#
|
2403
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html
|
2310
2404
|
# @return [String]
|
2311
2405
|
#
|
2312
2406
|
# @!attribute [rw] overwrite_mode
|
@@ -2318,8 +2412,13 @@ module Aws::DataSync
|
|
2318
2412
|
# protect against overwriting those changes.
|
2319
2413
|
#
|
2320
2414
|
# Some storage classes have specific behaviors that can affect your S3
|
2321
|
-
# storage cost. For detailed information, see
|
2322
|
-
#
|
2415
|
+
# storage cost. For detailed information, see [Considerations when
|
2416
|
+
# working with Amazon S3 storage classes in DataSync ][1] in the
|
2417
|
+
# *DataSync User Guide*.
|
2418
|
+
#
|
2419
|
+
#
|
2420
|
+
#
|
2421
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
|
2323
2422
|
# @return [String]
|
2324
2423
|
#
|
2325
2424
|
# @!attribute [rw] atime
|
@@ -2328,7 +2427,7 @@ module Aws::DataSync
|
|
2328
2427
|
# to BEST\_EFFORT, DataSync attempts to preserve the original `Atime`
|
2329
2428
|
# attribute on all source files (that is, the version before the
|
2330
2429
|
# PREPARING phase). However, `Atime`'s behavior is not fully standard
|
2331
|
-
# across platforms, so
|
2430
|
+
# across platforms, so DataSync can only do this on a best-effort
|
2332
2431
|
# basis.
|
2333
2432
|
#
|
2334
2433
|
# Default value: BEST\_EFFORT.
|
@@ -2347,7 +2446,9 @@ module Aws::DataSync
|
|
2347
2446
|
#
|
2348
2447
|
# @!attribute [rw] mtime
|
2349
2448
|
# A value that indicates the last time that a file was modified (that
|
2350
|
-
# is, a file was written to) before the PREPARING phase.
|
2449
|
+
# is, a file was written to) before the PREPARING phase. This option
|
2450
|
+
# is required for cases when you need to run the same task more than
|
2451
|
+
# one time.
|
2351
2452
|
#
|
2352
2453
|
# Default value: PRESERVE.
|
2353
2454
|
#
|
@@ -2363,7 +2464,10 @@ module Aws::DataSync
|
|
2363
2464
|
# @return [String]
|
2364
2465
|
#
|
2365
2466
|
# @!attribute [rw] uid
|
2366
|
-
# The user ID (UID) of the file's owner.
|
2467
|
+
# The POSIX user ID (UID) of the file's owner. This option should
|
2468
|
+
# only be set for NFS, EFS, and S3 locations. To learn more about what
|
2469
|
+
# metadata is copied by DataSync, see [Metadata Copied by
|
2470
|
+
# DataSync][1].
|
2367
2471
|
#
|
2368
2472
|
# Default value: INT\_VALUE. This preserves the integer value of the
|
2369
2473
|
# ID.
|
@@ -2372,10 +2476,17 @@ module Aws::DataSync
|
|
2372
2476
|
# (recommended).
|
2373
2477
|
#
|
2374
2478
|
# NONE: Ignore UID and GID.
|
2479
|
+
#
|
2480
|
+
#
|
2481
|
+
#
|
2482
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied
|
2375
2483
|
# @return [String]
|
2376
2484
|
#
|
2377
2485
|
# @!attribute [rw] gid
|
2378
|
-
# The group ID (GID) of the file's owners.
|
2486
|
+
# The POSIX group ID (GID) of the file's owners. This option should
|
2487
|
+
# only be set for NFS, EFS, and S3 locations. For more information
|
2488
|
+
# about what metadata is copied by DataSync, see [Metadata Copied by
|
2489
|
+
# DataSync][1].
|
2379
2490
|
#
|
2380
2491
|
# Default value: INT\_VALUE. This preserves the integer value of the
|
2381
2492
|
# ID.
|
@@ -2384,6 +2495,10 @@ module Aws::DataSync
|
|
2384
2495
|
# (recommended).
|
2385
2496
|
#
|
2386
2497
|
# NONE: Ignore UID and GID.
|
2498
|
+
#
|
2499
|
+
#
|
2500
|
+
#
|
2501
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied
|
2387
2502
|
# @return [String]
|
2388
2503
|
#
|
2389
2504
|
# @!attribute [rw] preserve_deleted_files
|
@@ -2391,25 +2506,30 @@ module Aws::DataSync
|
|
2391
2506
|
# exist in the source file system should be preserved. This option can
|
2392
2507
|
# affect your storage cost. If your task deletes objects, you might
|
2393
2508
|
# incur minimum storage duration charges for certain storage classes.
|
2394
|
-
# For detailed information, see
|
2395
|
-
# DataSync User
|
2509
|
+
# For detailed information, see [Considerations when working with
|
2510
|
+
# Amazon S3 storage classes in DataSync ][1] in the *DataSync User
|
2511
|
+
# Guide*.
|
2396
2512
|
#
|
2397
2513
|
# Default value: PRESERVE.
|
2398
2514
|
#
|
2399
2515
|
# PRESERVE: Ignore such destination files (recommended).
|
2400
2516
|
#
|
2401
2517
|
# REMOVE: Delete destination files that aren’t present in the source.
|
2518
|
+
#
|
2519
|
+
#
|
2520
|
+
#
|
2521
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
|
2402
2522
|
# @return [String]
|
2403
2523
|
#
|
2404
2524
|
# @!attribute [rw] preserve_devices
|
2405
|
-
# A value that determines whether
|
2525
|
+
# A value that determines whether DataSync should preserve the
|
2406
2526
|
# metadata of block and character devices in the source file system,
|
2407
|
-
# and
|
2408
|
-
# destination.
|
2527
|
+
# and re-create the files with that device name and metadata on the
|
2528
|
+
# destination. DataSync does not copy the contents of such devices,
|
2529
|
+
# only the name and metadata.
|
2409
2530
|
#
|
2410
|
-
# <note markdown="1">
|
2411
|
-
#
|
2412
|
-
# marker.
|
2531
|
+
# <note markdown="1"> DataSync can't sync the actual contents of such devices, because
|
2532
|
+
# they are nonterminal and don't return an end-of-file (EOF) marker.
|
2413
2533
|
#
|
2414
2534
|
# </note>
|
2415
2535
|
#
|
@@ -2424,7 +2544,9 @@ module Aws::DataSync
|
|
2424
2544
|
# @!attribute [rw] posix_permissions
|
2425
2545
|
# A value that determines which users or groups can access a file for
|
2426
2546
|
# a specific purpose such as reading, writing, or execution of the
|
2427
|
-
# file.
|
2547
|
+
# file. This option should only be set for NFS, EFS, and S3 locations.
|
2548
|
+
# For more information about what metadata is copied by DataSync, see
|
2549
|
+
# [Metadata Copied by DataSync][1].
|
2428
2550
|
#
|
2429
2551
|
# Default value: PRESERVE.
|
2430
2552
|
#
|
@@ -2432,14 +2554,18 @@ module Aws::DataSync
|
|
2432
2554
|
#
|
2433
2555
|
# NONE: Ignore permissions.
|
2434
2556
|
#
|
2435
|
-
# <note markdown="1">
|
2557
|
+
# <note markdown="1"> DataSync can preserve extant permissions of a source location.
|
2436
2558
|
#
|
2437
2559
|
# </note>
|
2560
|
+
#
|
2561
|
+
#
|
2562
|
+
#
|
2563
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied
|
2438
2564
|
# @return [String]
|
2439
2565
|
#
|
2440
2566
|
# @!attribute [rw] bytes_per_second
|
2441
|
-
# A value that limits the bandwidth used by
|
2442
|
-
#
|
2567
|
+
# A value that limits the bandwidth used by DataSync. For example, if
|
2568
|
+
# you want DataSync to use a maximum of 1 MB, set this value to
|
2443
2569
|
# `1048576` (`=1024*1024`).
|
2444
2570
|
# @return [Integer]
|
2445
2571
|
#
|
@@ -2449,8 +2575,12 @@ module Aws::DataSync
|
|
2449
2575
|
# The default is `ENABLED`.
|
2450
2576
|
#
|
2451
2577
|
# 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
|
-
#
|
2578
|
+
# tasks to run in series. For more information, see [Queueing task
|
2579
|
+
# executions][1].
|
2580
|
+
#
|
2581
|
+
#
|
2582
|
+
#
|
2583
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#queue-task-execution
|
2454
2584
|
# @return [String]
|
2455
2585
|
#
|
2456
2586
|
# @!attribute [rw] log_level
|
@@ -2481,6 +2611,57 @@ module Aws::DataSync
|
|
2481
2611
|
# without comparing to existing content on the destination.
|
2482
2612
|
# @return [String]
|
2483
2613
|
#
|
2614
|
+
# @!attribute [rw] security_descriptor_copy_flags
|
2615
|
+
# A value that determines which components of the SMB security
|
2616
|
+
# descriptor are copied from source to destination objects.
|
2617
|
+
#
|
2618
|
+
# This value is only used for transfers between SMB and Amazon FSx for
|
2619
|
+
# Windows File Server locations, or between two Amazon FSx for Windows
|
2620
|
+
# File Server locations. For more information about how DataSync
|
2621
|
+
# handles metadata, see [How DataSync Handles Metadata and Special
|
2622
|
+
# Files][1].
|
2623
|
+
#
|
2624
|
+
# Default value: OWNER\_DACL.
|
2625
|
+
#
|
2626
|
+
# **OWNER\_DACL**\: For each copied object, DataSync copies the
|
2627
|
+
# following metadata:
|
2628
|
+
#
|
2629
|
+
# * Object owner.
|
2630
|
+
#
|
2631
|
+
# * NTFS discretionary access control lists (DACLs), which determine
|
2632
|
+
# whether to grant access to an object.
|
2633
|
+
#
|
2634
|
+
# When choosing this option, DataSync does NOT copy the NTFS system
|
2635
|
+
# access control lists (SACLs), which are used by administrators to
|
2636
|
+
# log attempts to access a secured object.
|
2637
|
+
#
|
2638
|
+
# **OWNER\_DACL\_SACL**\: For each copied object, DataSync copies the
|
2639
|
+
# following metadata:
|
2640
|
+
#
|
2641
|
+
# * Object owner.
|
2642
|
+
#
|
2643
|
+
# * NTFS discretionary access control lists (DACLs), which determine
|
2644
|
+
# whether to grant access to an object.
|
2645
|
+
#
|
2646
|
+
# * NTFS system access control lists (SACLs), which are used by
|
2647
|
+
# administrators to log attempts to access a secured object.
|
2648
|
+
#
|
2649
|
+
# Copying SACLs requires granting additional permissions to the
|
2650
|
+
# Windows user that DataSync uses to access your SMB location. For
|
2651
|
+
# information about choosing a user that ensures sufficient
|
2652
|
+
# permissions to files, folders, and metadata, see
|
2653
|
+
# [user](create-smb-location.html#SMBuser).
|
2654
|
+
#
|
2655
|
+
# **NONE**\: None of the SMB security descriptor components are
|
2656
|
+
# copied. Destination objects are owned by the user that was provided
|
2657
|
+
# for accessing the destination location. DACLs and SACLs are set
|
2658
|
+
# based on the destination server’s configuration.
|
2659
|
+
#
|
2660
|
+
#
|
2661
|
+
#
|
2662
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html
|
2663
|
+
# @return [String]
|
2664
|
+
#
|
2484
2665
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/Options AWS API Documentation
|
2485
2666
|
#
|
2486
2667
|
class Options < Struct.new(
|
@@ -2496,7 +2677,8 @@ module Aws::DataSync
|
|
2496
2677
|
:bytes_per_second,
|
2497
2678
|
:task_queueing,
|
2498
2679
|
:log_level,
|
2499
|
-
:transfer_mode
|
2680
|
+
:transfer_mode,
|
2681
|
+
:security_descriptor_copy_flags)
|
2500
2682
|
SENSITIVE = []
|
2501
2683
|
include Aws::Structure
|
2502
2684
|
end
|
@@ -2543,11 +2725,11 @@ module Aws::DataSync
|
|
2543
2725
|
include Aws::Structure
|
2544
2726
|
end
|
2545
2727
|
|
2546
|
-
# The Amazon Resource Name (ARN) of the
|
2547
|
-
#
|
2728
|
+
# The Amazon Resource Name (ARN) of the Identity and Access Management
|
2729
|
+
# (IAM) role that is used to access an Amazon S3 bucket.
|
2548
2730
|
#
|
2549
2731
|
# For detailed information about using such a role, see Creating a
|
2550
|
-
# Location for Amazon S3 in the *
|
2732
|
+
# Location for Amazon S3 in the *DataSync User Guide*.
|
2551
2733
|
#
|
2552
2734
|
# @note When making an API call, you may pass S3Config
|
2553
2735
|
# data as a hash:
|
@@ -2558,7 +2740,11 @@ module Aws::DataSync
|
|
2558
2740
|
#
|
2559
2741
|
# @!attribute [rw] bucket_access_role_arn
|
2560
2742
|
# The Amazon S3 bucket to access. This bucket is used as a parameter
|
2561
|
-
# in the CreateLocationS3 operation.
|
2743
|
+
# in the [CreateLocationS3][1] operation.
|
2744
|
+
#
|
2745
|
+
#
|
2746
|
+
#
|
2747
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationS3.html
|
2562
2748
|
# @return [String]
|
2563
2749
|
#
|
2564
2750
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/S3Config AWS API Documentation
|
@@ -2615,6 +2801,7 @@ module Aws::DataSync
|
|
2615
2801
|
# task_queueing: "ENABLED", # accepts ENABLED, DISABLED
|
2616
2802
|
# log_level: "OFF", # accepts OFF, BASIC, TRANSFER
|
2617
2803
|
# transfer_mode: "CHANGED", # accepts CHANGED, ALL
|
2804
|
+
# security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
|
2618
2805
|
# },
|
2619
2806
|
# includes: [
|
2620
2807
|
# {
|
@@ -2622,6 +2809,12 @@ module Aws::DataSync
|
|
2622
2809
|
# value: "FilterValue",
|
2623
2810
|
# },
|
2624
2811
|
# ],
|
2812
|
+
# excludes: [
|
2813
|
+
# {
|
2814
|
+
# filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
|
2815
|
+
# value: "FilterValue",
|
2816
|
+
# },
|
2817
|
+
# ],
|
2625
2818
|
# }
|
2626
2819
|
#
|
2627
2820
|
# @!attribute [rw] task_arn
|
@@ -2630,15 +2823,20 @@ module Aws::DataSync
|
|
2630
2823
|
#
|
2631
2824
|
# @!attribute [rw] override_options
|
2632
2825
|
# Represents the options that are available to control the behavior of
|
2633
|
-
# a StartTaskExecution operation. Behavior includes preserving
|
2826
|
+
# a [StartTaskExecution][1] operation. Behavior includes preserving
|
2634
2827
|
# metadata such as user ID (UID), group ID (GID), and file
|
2635
2828
|
# permissions, and also overwriting files in the destination, data
|
2636
2829
|
# integrity verification, and so on.
|
2637
2830
|
#
|
2638
2831
|
# A task has a set of default options associated with it. If you
|
2639
|
-
# don't specify an option in StartTaskExecution, the default
|
2640
|
-
# used. You can override the defaults options on each task
|
2641
|
-
# by specifying an overriding `Options` value to
|
2832
|
+
# don't specify an option in [StartTaskExecution][1], the default
|
2833
|
+
# value is used. You can override the defaults options on each task
|
2834
|
+
# execution by specifying an overriding `Options` value to
|
2835
|
+
# [StartTaskExecution][1].
|
2836
|
+
#
|
2837
|
+
#
|
2838
|
+
#
|
2839
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
2642
2840
|
# @return [Types::Options]
|
2643
2841
|
#
|
2644
2842
|
# @!attribute [rw] includes
|
@@ -2648,12 +2846,20 @@ module Aws::DataSync
|
|
2648
2846
|
# by "\|" (that is, a pipe). For example: `"/folder1|/folder2"`
|
2649
2847
|
# @return [Array<Types::FilterRule>]
|
2650
2848
|
#
|
2849
|
+
# @!attribute [rw] excludes
|
2850
|
+
# A list of filter rules that determines which files to exclude from a
|
2851
|
+
# task. The list should contain a single filter string that consists
|
2852
|
+
# of the patterns to exclude. The patterns are delimited by "\|"
|
2853
|
+
# (that is, a pipe), for example, `"/folder1|/folder2"`.
|
2854
|
+
# @return [Array<Types::FilterRule>]
|
2855
|
+
#
|
2651
2856
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/StartTaskExecutionRequest AWS API Documentation
|
2652
2857
|
#
|
2653
2858
|
class StartTaskExecutionRequest < Struct.new(
|
2654
2859
|
:task_arn,
|
2655
2860
|
:override_options,
|
2656
|
-
:includes
|
2861
|
+
:includes,
|
2862
|
+
:excludes)
|
2657
2863
|
SENSITIVE = []
|
2658
2864
|
include Aws::Structure
|
2659
2865
|
end
|
@@ -2675,7 +2881,11 @@ module Aws::DataSync
|
|
2675
2881
|
|
2676
2882
|
# Represents a single entry in a list of AWS resource tags.
|
2677
2883
|
# `TagListEntry` returns an array that contains a list of tasks when the
|
2678
|
-
# ListTagsForResource operation is called.
|
2884
|
+
# [ListTagsForResource][1] operation is called.
|
2885
|
+
#
|
2886
|
+
#
|
2887
|
+
#
|
2888
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTagsForResource.html
|
2679
2889
|
#
|
2680
2890
|
# @note When making an API call, you may pass TagListEntry
|
2681
2891
|
# data as a hash:
|
@@ -2686,11 +2896,11 @@ module Aws::DataSync
|
|
2686
2896
|
# }
|
2687
2897
|
#
|
2688
2898
|
# @!attribute [rw] key
|
2689
|
-
# The key for an
|
2899
|
+
# The key for an Amazon Web Services resource tag.
|
2690
2900
|
# @return [String]
|
2691
2901
|
#
|
2692
2902
|
# @!attribute [rw] value
|
2693
|
-
# The value for an
|
2903
|
+
# The value for an Amazon Web Services resource tag.
|
2694
2904
|
# @return [String]
|
2695
2905
|
#
|
2696
2906
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TagListEntry AWS API Documentation
|
@@ -2740,8 +2950,12 @@ module Aws::DataSync
|
|
2740
2950
|
|
2741
2951
|
# Represents a single entry in a list of task executions.
|
2742
2952
|
# `TaskExecutionListEntry` returns an array that contains a list of
|
2743
|
-
# specific invocations of a task when ListTaskExecutions
|
2744
|
-
# called.
|
2953
|
+
# specific invocations of a task when the [ListTaskExecutions][1]
|
2954
|
+
# operation is called.
|
2955
|
+
#
|
2956
|
+
#
|
2957
|
+
#
|
2958
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html
|
2745
2959
|
#
|
2746
2960
|
# @!attribute [rw] task_execution_arn
|
2747
2961
|
# The Amazon Resource Name (ARN) of the task that was executed.
|
@@ -2765,8 +2979,8 @@ module Aws::DataSync
|
|
2765
2979
|
# status of the task execution, and the errors encountered.
|
2766
2980
|
#
|
2767
2981
|
# @!attribute [rw] prepare_duration
|
2768
|
-
# The total time in milliseconds that
|
2769
|
-
#
|
2982
|
+
# The total time in milliseconds that DataSync spent in the PREPARING
|
2983
|
+
# phase.
|
2770
2984
|
# @return [Integer]
|
2771
2985
|
#
|
2772
2986
|
# @!attribute [rw] prepare_status
|
@@ -2774,12 +2988,12 @@ module Aws::DataSync
|
|
2774
2988
|
# @return [String]
|
2775
2989
|
#
|
2776
2990
|
# @!attribute [rw] total_duration
|
2777
|
-
# The total time in milliseconds that
|
2778
|
-
#
|
2991
|
+
# The total time in milliseconds that DataSync took to transfer the
|
2992
|
+
# file from the source to the destination location.
|
2779
2993
|
# @return [Integer]
|
2780
2994
|
#
|
2781
2995
|
# @!attribute [rw] transfer_duration
|
2782
|
-
# The total time in milliseconds that
|
2996
|
+
# The total time in milliseconds that DataSync spent in the
|
2783
2997
|
# TRANSFERRING phase.
|
2784
2998
|
# @return [Integer]
|
2785
2999
|
#
|
@@ -2788,8 +3002,8 @@ module Aws::DataSync
|
|
2788
3002
|
# @return [String]
|
2789
3003
|
#
|
2790
3004
|
# @!attribute [rw] verify_duration
|
2791
|
-
# The total time in milliseconds that
|
2792
|
-
#
|
3005
|
+
# The total time in milliseconds that DataSync spent in the VERIFYING
|
3006
|
+
# phase.
|
2793
3007
|
# @return [Integer]
|
2794
3008
|
#
|
2795
3009
|
# @!attribute [rw] verify_status
|
@@ -2797,8 +3011,8 @@ module Aws::DataSync
|
|
2797
3011
|
# @return [String]
|
2798
3012
|
#
|
2799
3013
|
# @!attribute [rw] error_code
|
2800
|
-
# Errors that
|
2801
|
-
#
|
3014
|
+
# Errors that DataSync encountered during execution of the task. You
|
3015
|
+
# can use this error code to help troubleshoot issues.
|
2802
3016
|
# @return [String]
|
2803
3017
|
#
|
2804
3018
|
# @!attribute [rw] error_detail
|
@@ -2851,7 +3065,11 @@ module Aws::DataSync
|
|
2851
3065
|
# @!attribute [rw] operator
|
2852
3066
|
# The operator that is used to compare filter values (for example,
|
2853
3067
|
# `Equals` or `Contains`). For more about API filtering operators, see
|
2854
|
-
#
|
3068
|
+
# [API filters for ListTasks and ListLocations][1].
|
3069
|
+
#
|
3070
|
+
#
|
3071
|
+
#
|
3072
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html
|
2855
3073
|
# @return [String]
|
2856
3074
|
#
|
2857
3075
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskFilter AWS API Documentation
|
@@ -2865,9 +3083,13 @@ module Aws::DataSync
|
|
2865
3083
|
end
|
2866
3084
|
|
2867
3085
|
# Represents a single entry in a list of tasks. `TaskListEntry` returns
|
2868
|
-
# an array that contains a list of tasks when the ListTasks
|
2869
|
-
# called. A task includes the source and destination file
|
2870
|
-
# sync and the options to use for the tasks.
|
3086
|
+
# an array that contains a list of tasks when the [ListTasks][1]
|
3087
|
+
# operation is called. A task includes the source and destination file
|
3088
|
+
# systems to sync and the options to use for the tasks.
|
3089
|
+
#
|
3090
|
+
#
|
3091
|
+
#
|
3092
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTasks.html
|
2871
3093
|
#
|
2872
3094
|
# @!attribute [rw] task_arn
|
2873
3095
|
# The Amazon Resource Name (ARN) of the task.
|
@@ -2907,8 +3129,8 @@ module Aws::DataSync
|
|
2907
3129
|
# }
|
2908
3130
|
#
|
2909
3131
|
# @!attribute [rw] schedule_expression
|
2910
|
-
# A cron expression that specifies when
|
2911
|
-
#
|
3132
|
+
# A cron expression that specifies when DataSync initiates a scheduled
|
3133
|
+
# transfer from a source to a destination location.
|
2912
3134
|
# @return [String]
|
2913
3135
|
#
|
2914
3136
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskSchedule AWS API Documentation
|
@@ -3021,8 +3243,8 @@ module Aws::DataSync
|
|
3021
3243
|
# the files. For the agent to access directories, you must
|
3022
3244
|
# additionally enable all execute access.
|
3023
3245
|
#
|
3024
|
-
# If you are copying data to or from your
|
3025
|
-
#
|
3246
|
+
# If you are copying data to or from your Snowcone device, see [NFS
|
3247
|
+
# Server on Snowcone][1] for more information.
|
3026
3248
|
#
|
3027
3249
|
# For information about NFS export configuration, see 18.7. The
|
3028
3250
|
# /etc/exports Configuration File in the Red Hat Enterprise Linux
|
@@ -3240,6 +3462,7 @@ module Aws::DataSync
|
|
3240
3462
|
# task_queueing: "ENABLED", # accepts ENABLED, DISABLED
|
3241
3463
|
# log_level: "OFF", # accepts OFF, BASIC, TRANSFER
|
3242
3464
|
# transfer_mode: "CHANGED", # accepts CHANGED, ALL
|
3465
|
+
# security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
|
3243
3466
|
# },
|
3244
3467
|
# }
|
3245
3468
|
#
|
@@ -3250,15 +3473,20 @@ module Aws::DataSync
|
|
3250
3473
|
#
|
3251
3474
|
# @!attribute [rw] options
|
3252
3475
|
# Represents the options that are available to control the behavior of
|
3253
|
-
# a StartTaskExecution operation. Behavior includes preserving
|
3476
|
+
# a [StartTaskExecution][1] operation. Behavior includes preserving
|
3254
3477
|
# metadata such as user ID (UID), group ID (GID), and file
|
3255
3478
|
# permissions, and also overwriting files in the destination, data
|
3256
3479
|
# integrity verification, and so on.
|
3257
3480
|
#
|
3258
3481
|
# A task has a set of default options associated with it. If you
|
3259
|
-
# don't specify an option in StartTaskExecution, the default
|
3260
|
-
# used. You can override the defaults options on each task
|
3261
|
-
# by specifying an overriding `Options` value to
|
3482
|
+
# don't specify an option in [StartTaskExecution][1], the default
|
3483
|
+
# value is used. You can override the defaults options on each task
|
3484
|
+
# execution by specifying an overriding `Options` value to
|
3485
|
+
# [StartTaskExecution][1].
|
3486
|
+
#
|
3487
|
+
#
|
3488
|
+
#
|
3489
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
3262
3490
|
# @return [Types::Options]
|
3263
3491
|
#
|
3264
3492
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskExecutionRequest AWS API Documentation
|
@@ -3295,6 +3523,7 @@ module Aws::DataSync
|
|
3295
3523
|
# task_queueing: "ENABLED", # accepts ENABLED, DISABLED
|
3296
3524
|
# log_level: "OFF", # accepts OFF, BASIC, TRANSFER
|
3297
3525
|
# transfer_mode: "CHANGED", # accepts CHANGED, ALL
|
3526
|
+
# security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
|
3298
3527
|
# },
|
3299
3528
|
# excludes: [
|
3300
3529
|
# {
|
@@ -3307,6 +3536,12 @@ module Aws::DataSync
|
|
3307
3536
|
# },
|
3308
3537
|
# name: "TagValue",
|
3309
3538
|
# cloud_watch_log_group_arn: "LogGroupArn",
|
3539
|
+
# includes: [
|
3540
|
+
# {
|
3541
|
+
# filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
|
3542
|
+
# value: "FilterValue",
|
3543
|
+
# },
|
3544
|
+
# ],
|
3310
3545
|
# }
|
3311
3546
|
#
|
3312
3547
|
# @!attribute [rw] task_arn
|
@@ -3316,15 +3551,20 @@ module Aws::DataSync
|
|
3316
3551
|
#
|
3317
3552
|
# @!attribute [rw] options
|
3318
3553
|
# Represents the options that are available to control the behavior of
|
3319
|
-
# a StartTaskExecution operation. Behavior includes preserving
|
3554
|
+
# a [StartTaskExecution][1] operation. Behavior includes preserving
|
3320
3555
|
# metadata such as user ID (UID), group ID (GID), and file
|
3321
3556
|
# permissions, and also overwriting files in the destination, data
|
3322
3557
|
# integrity verification, and so on.
|
3323
3558
|
#
|
3324
3559
|
# A task has a set of default options associated with it. If you
|
3325
|
-
# don't specify an option in StartTaskExecution, the default
|
3326
|
-
# used. You can override the defaults options on each task
|
3327
|
-
# by specifying an overriding `Options` value to
|
3560
|
+
# don't specify an option in [StartTaskExecution][1], the default
|
3561
|
+
# value is used. You can override the defaults options on each task
|
3562
|
+
# execution by specifying an overriding `Options` value to
|
3563
|
+
# [StartTaskExecution][1].
|
3564
|
+
#
|
3565
|
+
#
|
3566
|
+
#
|
3567
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
|
3328
3568
|
# @return [Types::Options]
|
3329
3569
|
#
|
3330
3570
|
# @!attribute [rw] excludes
|
@@ -3339,8 +3579,12 @@ module Aws::DataSync
|
|
3339
3579
|
# source to a destination location. You can configure your task to
|
3340
3580
|
# execute hourly, daily, weekly or on specific days of the week. You
|
3341
3581
|
# 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
|
3582
|
+
# time you specify is UTC time. For more information, see [Scheduling
|
3583
|
+
# your task][1].
|
3584
|
+
#
|
3585
|
+
#
|
3586
|
+
#
|
3587
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
|
3344
3588
|
# @return [Types::TaskSchedule]
|
3345
3589
|
#
|
3346
3590
|
# @!attribute [rw] name
|
@@ -3352,6 +3596,13 @@ module Aws::DataSync
|
|
3352
3596
|
# CloudWatch LogGroup.
|
3353
3597
|
# @return [String]
|
3354
3598
|
#
|
3599
|
+
# @!attribute [rw] includes
|
3600
|
+
# A list of filter rules that determines which files to include when
|
3601
|
+
# running a task. The pattern should contain a single filter string
|
3602
|
+
# that consists of the patterns to include. The patterns are delimited
|
3603
|
+
# by "\|" (that is, a pipe). For example: `"/folder1|/folder2`"
|
3604
|
+
# @return [Array<Types::FilterRule>]
|
3605
|
+
#
|
3355
3606
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskRequest AWS API Documentation
|
3356
3607
|
#
|
3357
3608
|
class UpdateTaskRequest < Struct.new(
|
@@ -3360,7 +3611,8 @@ module Aws::DataSync
|
|
3360
3611
|
:excludes,
|
3361
3612
|
:schedule,
|
3362
3613
|
:name,
|
3363
|
-
:cloud_watch_log_group_arn
|
3614
|
+
:cloud_watch_log_group_arn,
|
3615
|
+
:includes)
|
3364
3616
|
SENSITIVE = []
|
3365
3617
|
include Aws::Structure
|
3366
3618
|
end
|