aws-sdk-datasync 1.27.0 → 1.28.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-datasync.rb +1 -1
- data/lib/aws-sdk-datasync/client.rb +74 -12
- data/lib/aws-sdk-datasync/client_api.rb +18 -0
- data/lib/aws-sdk-datasync/types.rb +74 -21
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d4aa366df197fce94f0c5f363e85ef61631b06fa386f25fd009e952116907ade
|
4
|
+
data.tar.gz: 89abf22f756f4d969aeaade954b00d05db4bd57598a434c39a20d4ace4166181
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 991548c048af831cbef90ea3dc158a3e04c2a5124a0688377fe26007608afa7c7c3f691861dfe30ff15c6afea289e55b2062ea29f0cb3cd767f5d547ae226895
|
7
|
+
data.tar.gz: 58d823bbcbabaaacc59e06668e317d06baec14e2a5fbff4b4d77ad3c564140a91fa6ec7bccff697a82a230dff8e2f90399cc998f2509d8b8bccaf33fa8a1da60
|
data/lib/aws-sdk-datasync.rb
CHANGED
@@ -634,7 +634,7 @@ module Aws::DataSync
|
|
634
634
|
# subdirectory of that path. The path should be such that it can be
|
635
635
|
# mounted by other NFS clients in your network.
|
636
636
|
#
|
637
|
-
# To see all the paths exported by your NFS server
|
637
|
+
# To see all the paths exported by your NFS server, run "`showmount -e
|
638
638
|
# nfs-server-name`" from an NFS client that has access to your server.
|
639
639
|
# You can specify any directory that appears in the results, and any
|
640
640
|
# subdirectory of that directory. Ensure that the NFS export is
|
@@ -828,8 +828,8 @@ module Aws::DataSync
|
|
828
828
|
# S3 destination.
|
829
829
|
#
|
830
830
|
# @option params [required, String] :s3_bucket_arn
|
831
|
-
# The
|
832
|
-
#
|
831
|
+
# The ARN of the Amazon S3 bucket. If the bucket is on an AWS Outpost,
|
832
|
+
# this must be an access point ARN.
|
833
833
|
#
|
834
834
|
# @option params [String] :s3_storage_class
|
835
835
|
# The Amazon S3 storage class that you want to store your files in when
|
@@ -838,13 +838,12 @@ module Aws::DataSync
|
|
838
838
|
# Outposts, the storage class defaults to AWS S3 Outposts.
|
839
839
|
#
|
840
840
|
# For more information about S3 storage classes, see [Amazon S3 Storage
|
841
|
-
# Classes][1]
|
842
|
-
#
|
843
|
-
# cost. For detailed information, see using-storage-classes.
|
841
|
+
# Classes][1]. Some storage classes have behaviors that can affect your
|
842
|
+
# S3 storage cost. For detailed information, see using-storage-classes.
|
844
843
|
#
|
845
844
|
#
|
846
845
|
#
|
847
|
-
# [1]:
|
846
|
+
# [1]: http://aws.amazon.com/s3/storage-classes/
|
848
847
|
#
|
849
848
|
# @option params [required, Types::S3Config] :s3_config
|
850
849
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
@@ -855,9 +854,9 @@ module Aws::DataSync
|
|
855
854
|
#
|
856
855
|
# @option params [Array<String>] :agent_arns
|
857
856
|
# If you are using DataSync on an AWS Outpost, specify the Amazon
|
858
|
-
# Resource Names (ARNs) of the DataSync agents deployed on your
|
859
|
-
#
|
860
|
-
#
|
857
|
+
# Resource Names (ARNs) of the DataSync agents deployed on your Outpost.
|
858
|
+
# For more information about launching a DataSync agent on an AWS
|
859
|
+
# Outpost, see outposts-agent.
|
861
860
|
#
|
862
861
|
# @option params [Array<Types::TagListEntry>] :tags
|
863
862
|
# The key-value pair that represents the tag that you want to add to the
|
@@ -1042,7 +1041,7 @@ module Aws::DataSync
|
|
1042
1041
|
# A list of filter rules that determines which files to exclude from a
|
1043
1042
|
# task. The list should contain a single filter string that consists of
|
1044
1043
|
# the patterns to exclude. The patterns are delimited by "\|" (that
|
1045
|
-
# is, a pipe), for example, `"/folder1|/folder2"
|
1044
|
+
# is, a pipe), for example, `"/folder1|/folder2"`.
|
1046
1045
|
#
|
1047
1046
|
# @option params [Types::TaskSchedule] :schedule
|
1048
1047
|
# Specifies a schedule used to periodically transfer files from a source
|
@@ -2104,6 +2103,69 @@ module Aws::DataSync
|
|
2104
2103
|
req.send_request(options)
|
2105
2104
|
end
|
2106
2105
|
|
2106
|
+
# Updates execution of a task.
|
2107
|
+
#
|
2108
|
+
# You can modify bandwidth throttling for a task execution that is
|
2109
|
+
# running or queued. For more information, see [Adjusting Bandwidth
|
2110
|
+
# Throttling for a Task Execution][1].
|
2111
|
+
#
|
2112
|
+
# <note markdown="1"> The only `Option` that can be modified by `UpdateTaskExecution` is `
|
2113
|
+
# BytesPerSecond `.
|
2114
|
+
#
|
2115
|
+
# </note>
|
2116
|
+
#
|
2117
|
+
#
|
2118
|
+
#
|
2119
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/working-with-task-executions.html#adjust-bandwidth-throttling
|
2120
|
+
#
|
2121
|
+
# @option params [required, String] :task_execution_arn
|
2122
|
+
# The Amazon Resource Name (ARN) of the specific task execution that is
|
2123
|
+
# being updated.
|
2124
|
+
#
|
2125
|
+
# @option params [required, Types::Options] :options
|
2126
|
+
# Represents the options that are available to control the behavior of a
|
2127
|
+
# StartTaskExecution operation. Behavior includes preserving metadata
|
2128
|
+
# such as user ID (UID), group ID (GID), and file permissions, and also
|
2129
|
+
# overwriting files in the destination, data integrity verification, and
|
2130
|
+
# so on.
|
2131
|
+
#
|
2132
|
+
# A task has a set of default options associated with it. If you don't
|
2133
|
+
# specify an option in StartTaskExecution, the default value is used.
|
2134
|
+
# You can override the defaults options on each task execution by
|
2135
|
+
# specifying an overriding `Options` value to StartTaskExecution.
|
2136
|
+
#
|
2137
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2138
|
+
#
|
2139
|
+
# @example Request syntax with placeholder values
|
2140
|
+
#
|
2141
|
+
# resp = client.update_task_execution({
|
2142
|
+
# task_execution_arn: "TaskExecutionArn", # required
|
2143
|
+
# options: { # required
|
2144
|
+
# verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED, NONE
|
2145
|
+
# overwrite_mode: "ALWAYS", # accepts ALWAYS, NEVER
|
2146
|
+
# atime: "NONE", # accepts NONE, BEST_EFFORT
|
2147
|
+
# mtime: "NONE", # accepts NONE, PRESERVE
|
2148
|
+
# uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
|
2149
|
+
# gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
|
2150
|
+
# preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
|
2151
|
+
# preserve_devices: "NONE", # accepts NONE, PRESERVE
|
2152
|
+
# posix_permissions: "NONE", # accepts NONE, PRESERVE
|
2153
|
+
# bytes_per_second: 1,
|
2154
|
+
# task_queueing: "ENABLED", # accepts ENABLED, DISABLED
|
2155
|
+
# log_level: "OFF", # accepts OFF, BASIC, TRANSFER
|
2156
|
+
# transfer_mode: "CHANGED", # accepts CHANGED, ALL
|
2157
|
+
# },
|
2158
|
+
# })
|
2159
|
+
#
|
2160
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskExecution AWS API Documentation
|
2161
|
+
#
|
2162
|
+
# @overload update_task_execution(params = {})
|
2163
|
+
# @param [Hash] params ({})
|
2164
|
+
def update_task_execution(params = {}, options = {})
|
2165
|
+
req = build_request(:update_task_execution, params)
|
2166
|
+
req.send_request(options)
|
2167
|
+
end
|
2168
|
+
|
2107
2169
|
# @!endgroup
|
2108
2170
|
|
2109
2171
|
# @param params ({})
|
@@ -2117,7 +2179,7 @@ module Aws::DataSync
|
|
2117
2179
|
params: params,
|
2118
2180
|
config: config)
|
2119
2181
|
context[:gem_name] = 'aws-sdk-datasync'
|
2120
|
-
context[:gem_version] = '1.
|
2182
|
+
context[:gem_version] = '1.28.0'
|
2121
2183
|
Seahorse::Client::Request.new(handlers, context)
|
2122
2184
|
end
|
2123
2185
|
|
@@ -172,6 +172,8 @@ module Aws::DataSync
|
|
172
172
|
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
173
173
|
UpdateAgentRequest = Shapes::StructureShape.new(name: 'UpdateAgentRequest')
|
174
174
|
UpdateAgentResponse = Shapes::StructureShape.new(name: 'UpdateAgentResponse')
|
175
|
+
UpdateTaskExecutionRequest = Shapes::StructureShape.new(name: 'UpdateTaskExecutionRequest')
|
176
|
+
UpdateTaskExecutionResponse = Shapes::StructureShape.new(name: 'UpdateTaskExecutionResponse')
|
175
177
|
UpdateTaskRequest = Shapes::StructureShape.new(name: 'UpdateTaskRequest')
|
176
178
|
UpdateTaskResponse = Shapes::StructureShape.new(name: 'UpdateTaskResponse')
|
177
179
|
VerifyMode = Shapes::StringShape.new(name: 'VerifyMode')
|
@@ -605,6 +607,12 @@ module Aws::DataSync
|
|
605
607
|
|
606
608
|
UpdateAgentResponse.struct_class = Types::UpdateAgentResponse
|
607
609
|
|
610
|
+
UpdateTaskExecutionRequest.add_member(:task_execution_arn, Shapes::ShapeRef.new(shape: TaskExecutionArn, required: true, location_name: "TaskExecutionArn"))
|
611
|
+
UpdateTaskExecutionRequest.add_member(:options, Shapes::ShapeRef.new(shape: Options, required: true, location_name: "Options"))
|
612
|
+
UpdateTaskExecutionRequest.struct_class = Types::UpdateTaskExecutionRequest
|
613
|
+
|
614
|
+
UpdateTaskExecutionResponse.struct_class = Types::UpdateTaskExecutionResponse
|
615
|
+
|
608
616
|
UpdateTaskRequest.add_member(:task_arn, Shapes::ShapeRef.new(shape: TaskArn, required: true, location_name: "TaskArn"))
|
609
617
|
UpdateTaskRequest.add_member(:options, Shapes::ShapeRef.new(shape: Options, location_name: "Options"))
|
610
618
|
UpdateTaskRequest.add_member(:excludes, Shapes::ShapeRef.new(shape: FilterList, location_name: "Excludes"))
|
@@ -974,6 +982,16 @@ module Aws::DataSync
|
|
974
982
|
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
975
983
|
o.errors << Shapes::ShapeRef.new(shape: InternalException)
|
976
984
|
end)
|
985
|
+
|
986
|
+
api.add_operation(:update_task_execution, Seahorse::Model::Operation.new.tap do |o|
|
987
|
+
o.name = "UpdateTaskExecution"
|
988
|
+
o.http_method = "POST"
|
989
|
+
o.http_request_uri = "/"
|
990
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateTaskExecutionRequest)
|
991
|
+
o.output = Shapes::ShapeRef.new(shape: UpdateTaskExecutionResponse)
|
992
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
993
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalException)
|
994
|
+
end)
|
977
995
|
end
|
978
996
|
|
979
997
|
end
|
@@ -379,7 +379,7 @@ module Aws::DataSync
|
|
379
379
|
# a subdirectory of that path. The path should be such that it can be
|
380
380
|
# mounted by other NFS clients in your network.
|
381
381
|
#
|
382
|
-
# To see all the paths exported by your NFS server
|
382
|
+
# To see all the paths exported by your NFS server, run "`showmount
|
383
383
|
# -e nfs-server-name`" from an NFS client that has access to your
|
384
384
|
# server. You can specify any directory that appears in the results,
|
385
385
|
# and any subdirectory of that directory. Ensure that the NFS export
|
@@ -610,8 +610,8 @@ module Aws::DataSync
|
|
610
610
|
# @return [String]
|
611
611
|
#
|
612
612
|
# @!attribute [rw] s3_bucket_arn
|
613
|
-
# The
|
614
|
-
#
|
613
|
+
# The ARN of the Amazon S3 bucket. If the bucket is on an AWS Outpost,
|
614
|
+
# this must be an access point ARN.
|
615
615
|
# @return [String]
|
616
616
|
#
|
617
617
|
# @!attribute [rw] s3_storage_class
|
@@ -621,13 +621,13 @@ module Aws::DataSync
|
|
621
621
|
# Outposts, the storage class defaults to AWS S3 Outposts.
|
622
622
|
#
|
623
623
|
# For more information about S3 storage classes, see [Amazon S3
|
624
|
-
# Storage Classes][1]
|
625
|
-
#
|
626
|
-
#
|
624
|
+
# Storage Classes][1]. Some storage classes have behaviors that can
|
625
|
+
# affect your S3 storage cost. For detailed information, see
|
626
|
+
# using-storage-classes.
|
627
627
|
#
|
628
628
|
#
|
629
629
|
#
|
630
|
-
# [1]:
|
630
|
+
# [1]: http://aws.amazon.com/s3/storage-classes/
|
631
631
|
# @return [String]
|
632
632
|
#
|
633
633
|
# @!attribute [rw] s3_config
|
@@ -640,9 +640,9 @@ module Aws::DataSync
|
|
640
640
|
#
|
641
641
|
# @!attribute [rw] agent_arns
|
642
642
|
# If you are using DataSync on an AWS Outpost, specify the Amazon
|
643
|
-
# Resource Names (ARNs) of the DataSync agents deployed on your
|
643
|
+
# Resource Names (ARNs) of the DataSync agents deployed on your
|
644
644
|
# Outpost. For more information about launching a DataSync agent on an
|
645
|
-
#
|
645
|
+
# AWS Outpost, see outposts-agent.
|
646
646
|
# @return [Array<String>]
|
647
647
|
#
|
648
648
|
# @!attribute [rw] tags
|
@@ -873,7 +873,7 @@ module Aws::DataSync
|
|
873
873
|
# A list of filter rules that determines which files to exclude from a
|
874
874
|
# task. The list should contain a single filter string that consists
|
875
875
|
# of the patterns to exclude. The patterns are delimited by "\|"
|
876
|
-
# (that is, a pipe), for example, `"/folder1|/folder2"
|
876
|
+
# (that is, a pipe), for example, `"/folder1|/folder2"`.
|
877
877
|
# @return [Array<Types::FilterRule>]
|
878
878
|
#
|
879
879
|
# @!attribute [rw] schedule
|
@@ -1354,13 +1354,13 @@ module Aws::DataSync
|
|
1354
1354
|
# The Amazon S3 storage class that you chose to store your files in
|
1355
1355
|
# when this location is used as a task destination. For more
|
1356
1356
|
# information about S3 storage classes, see [Amazon S3 Storage
|
1357
|
-
# Classes][1]
|
1358
|
-
#
|
1359
|
-
#
|
1357
|
+
# Classes][1]. Some storage classes have behaviors that can affect
|
1358
|
+
# your S3 storage cost. For detailed information, see
|
1359
|
+
# using-storage-classes.
|
1360
1360
|
#
|
1361
1361
|
#
|
1362
1362
|
#
|
1363
|
-
# [1]:
|
1363
|
+
# [1]: http://aws.amazon.com/s3/storage-classes/
|
1364
1364
|
# @return [String]
|
1365
1365
|
#
|
1366
1366
|
# @!attribute [rw] s3_config
|
@@ -1372,10 +1372,10 @@ module Aws::DataSync
|
|
1372
1372
|
# @return [Types::S3Config]
|
1373
1373
|
#
|
1374
1374
|
# @!attribute [rw] agent_arns
|
1375
|
-
# If you are using DataSync on an
|
1376
|
-
# Name (ARNs) of the EC2 agents deployed on your
|
1377
|
-
# information about launching a DataSync agent on an
|
1378
|
-
#
|
1375
|
+
# If you are using DataSync on an AWS Outpost, the Amazon Resource
|
1376
|
+
# Name (ARNs) of the EC2 agents deployed on your Outpost. For more
|
1377
|
+
# information about launching a DataSync agent on an AWS Outpost, see
|
1378
|
+
# outposts-agent.
|
1379
1379
|
# @return [Array<String>]
|
1380
1380
|
#
|
1381
1381
|
# @!attribute [rw] creation_time
|
@@ -1627,7 +1627,7 @@ module Aws::DataSync
|
|
1627
1627
|
# The status of the task that was described.
|
1628
1628
|
#
|
1629
1629
|
# For detailed information about task execution statuses, see
|
1630
|
-
# Understanding Task Statuses in the *AWS DataSync User Guide
|
1630
|
+
# Understanding Task Statuses in the *AWS DataSync User Guide*.
|
1631
1631
|
# @return [String]
|
1632
1632
|
#
|
1633
1633
|
# @!attribute [rw] name
|
@@ -2782,7 +2782,7 @@ module Aws::DataSync
|
|
2782
2782
|
# @return [Integer]
|
2783
2783
|
#
|
2784
2784
|
# @!attribute [rw] transfer_status
|
2785
|
-
# The status of the TRANSFERRING
|
2785
|
+
# The status of the TRANSFERRING phase.
|
2786
2786
|
# @return [String]
|
2787
2787
|
#
|
2788
2788
|
# @!attribute [rw] verify_duration
|
@@ -2791,7 +2791,7 @@ module Aws::DataSync
|
|
2791
2791
|
# @return [Integer]
|
2792
2792
|
#
|
2793
2793
|
# @!attribute [rw] verify_status
|
2794
|
-
# The status of the VERIFYING
|
2794
|
+
# The status of the VERIFYING phase.
|
2795
2795
|
# @return [String]
|
2796
2796
|
#
|
2797
2797
|
# @!attribute [rw] error_code
|
@@ -2980,6 +2980,59 @@ module Aws::DataSync
|
|
2980
2980
|
#
|
2981
2981
|
class UpdateAgentResponse < Aws::EmptyStructure; end
|
2982
2982
|
|
2983
|
+
# @note When making an API call, you may pass UpdateTaskExecutionRequest
|
2984
|
+
# data as a hash:
|
2985
|
+
#
|
2986
|
+
# {
|
2987
|
+
# task_execution_arn: "TaskExecutionArn", # required
|
2988
|
+
# options: { # required
|
2989
|
+
# verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED, NONE
|
2990
|
+
# overwrite_mode: "ALWAYS", # accepts ALWAYS, NEVER
|
2991
|
+
# atime: "NONE", # accepts NONE, BEST_EFFORT
|
2992
|
+
# mtime: "NONE", # accepts NONE, PRESERVE
|
2993
|
+
# uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
|
2994
|
+
# gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
|
2995
|
+
# preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
|
2996
|
+
# preserve_devices: "NONE", # accepts NONE, PRESERVE
|
2997
|
+
# posix_permissions: "NONE", # accepts NONE, PRESERVE
|
2998
|
+
# bytes_per_second: 1,
|
2999
|
+
# task_queueing: "ENABLED", # accepts ENABLED, DISABLED
|
3000
|
+
# log_level: "OFF", # accepts OFF, BASIC, TRANSFER
|
3001
|
+
# transfer_mode: "CHANGED", # accepts CHANGED, ALL
|
3002
|
+
# },
|
3003
|
+
# }
|
3004
|
+
#
|
3005
|
+
# @!attribute [rw] task_execution_arn
|
3006
|
+
# The Amazon Resource Name (ARN) of the specific task execution that
|
3007
|
+
# is being updated.
|
3008
|
+
# @return [String]
|
3009
|
+
#
|
3010
|
+
# @!attribute [rw] options
|
3011
|
+
# Represents the options that are available to control the behavior of
|
3012
|
+
# a StartTaskExecution operation. Behavior includes preserving
|
3013
|
+
# metadata such as user ID (UID), group ID (GID), and file
|
3014
|
+
# permissions, and also overwriting files in the destination, data
|
3015
|
+
# integrity verification, and so on.
|
3016
|
+
#
|
3017
|
+
# A task has a set of default options associated with it. If you
|
3018
|
+
# don't specify an option in StartTaskExecution, the default value is
|
3019
|
+
# used. You can override the defaults options on each task execution
|
3020
|
+
# by specifying an overriding `Options` value to StartTaskExecution.
|
3021
|
+
# @return [Types::Options]
|
3022
|
+
#
|
3023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskExecutionRequest AWS API Documentation
|
3024
|
+
#
|
3025
|
+
class UpdateTaskExecutionRequest < Struct.new(
|
3026
|
+
:task_execution_arn,
|
3027
|
+
:options)
|
3028
|
+
SENSITIVE = []
|
3029
|
+
include Aws::Structure
|
3030
|
+
end
|
3031
|
+
|
3032
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskExecutionResponse AWS API Documentation
|
3033
|
+
#
|
3034
|
+
class UpdateTaskExecutionResponse < Aws::EmptyStructure; end
|
3035
|
+
|
2983
3036
|
# UpdateTaskResponse
|
2984
3037
|
#
|
2985
3038
|
# @note When making an API call, you may pass UpdateTaskRequest
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-datasync
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.28.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-09
|
11
|
+
date: 2020-11-09 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|