aws-sdk-datasync 1.0.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 +7 -0
- data/lib/aws-sdk-datasync.rb +47 -0
- data/lib/aws-sdk-datasync/client.rb +1428 -0
- data/lib/aws-sdk-datasync/client_api.rb +674 -0
- data/lib/aws-sdk-datasync/customizations.rb +0 -0
- data/lib/aws-sdk-datasync/errors.rb +14 -0
- data/lib/aws-sdk-datasync/resource.rb +23 -0
- data/lib/aws-sdk-datasync/types.rb +1902 -0
- metadata +88 -0
File without changes
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::DataSync
|
9
|
+
module Errors
|
10
|
+
|
11
|
+
extend Aws::Errors::DynamicErrors
|
12
|
+
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::DataSync
|
9
|
+
class Resource
|
10
|
+
|
11
|
+
# @param options ({})
|
12
|
+
# @option options [Client] :client
|
13
|
+
def initialize(options = {})
|
14
|
+
@client = options[:client] || Client.new(options)
|
15
|
+
end
|
16
|
+
|
17
|
+
# @return [Client]
|
18
|
+
def client
|
19
|
+
@client
|
20
|
+
end
|
21
|
+
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,1902 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::DataSync
|
9
|
+
module Types
|
10
|
+
|
11
|
+
# Represents a single entry in a list of agents. `AgentListEntry`
|
12
|
+
# returns an array that contains a list of agents when the ListAgents
|
13
|
+
# operation is called.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] agent_arn
|
16
|
+
# The Amazon Resource Name (ARN) of the agent.
|
17
|
+
# @return [String]
|
18
|
+
#
|
19
|
+
# @!attribute [rw] name
|
20
|
+
# The name of the agent.
|
21
|
+
# @return [String]
|
22
|
+
#
|
23
|
+
# @!attribute [rw] status
|
24
|
+
# The status of the agent.
|
25
|
+
# @return [String]
|
26
|
+
#
|
27
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/AgentListEntry AWS API Documentation
|
28
|
+
#
|
29
|
+
class AgentListEntry < Struct.new(
|
30
|
+
:agent_arn,
|
31
|
+
:name,
|
32
|
+
:status)
|
33
|
+
include Aws::Structure
|
34
|
+
end
|
35
|
+
|
36
|
+
# CancelTaskExecutionRequest
|
37
|
+
#
|
38
|
+
# @note When making an API call, you may pass CancelTaskExecutionRequest
|
39
|
+
# data as a hash:
|
40
|
+
#
|
41
|
+
# {
|
42
|
+
# task_execution_arn: "TaskExecutionArn", # required
|
43
|
+
# }
|
44
|
+
#
|
45
|
+
# @!attribute [rw] task_execution_arn
|
46
|
+
# The Amazon Resource Name (ARN) of the task execution to cancel.
|
47
|
+
# @return [String]
|
48
|
+
#
|
49
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CancelTaskExecutionRequest AWS API Documentation
|
50
|
+
#
|
51
|
+
class CancelTaskExecutionRequest < Struct.new(
|
52
|
+
:task_execution_arn)
|
53
|
+
include Aws::Structure
|
54
|
+
end
|
55
|
+
|
56
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CancelTaskExecutionResponse AWS API Documentation
|
57
|
+
#
|
58
|
+
class CancelTaskExecutionResponse < Aws::EmptyStructure; end
|
59
|
+
|
60
|
+
# CreateAgentRequest
|
61
|
+
#
|
62
|
+
# @note When making an API call, you may pass CreateAgentRequest
|
63
|
+
# data as a hash:
|
64
|
+
#
|
65
|
+
# {
|
66
|
+
# activation_key: "ActivationKey", # required
|
67
|
+
# agent_name: "TagValue",
|
68
|
+
# tags: [
|
69
|
+
# {
|
70
|
+
# key: "TagKey",
|
71
|
+
# value: "TagValue",
|
72
|
+
# },
|
73
|
+
# ],
|
74
|
+
# }
|
75
|
+
#
|
76
|
+
# @!attribute [rw] activation_key
|
77
|
+
# Your agent activation key. You can get the activation key either by
|
78
|
+
# sending an HTTP GET request with redirects that enable you to get
|
79
|
+
# the agent IP address (port 80). Alternatively, you can get it from
|
80
|
+
# the AWS DataSync console.
|
81
|
+
#
|
82
|
+
# The redirect URL returned in the response provides you the
|
83
|
+
# activation key for your agent in the query string parameter
|
84
|
+
# `activationKey`. It might also include other activation-related
|
85
|
+
# parameters; however, these are merely defaults. The arguments you
|
86
|
+
# pass to this API call determine the actual configuration of your
|
87
|
+
# agent. For more information, see [Activating a Sync Agent][1] in the
|
88
|
+
# *AWS DataSync User Guide.*
|
89
|
+
#
|
90
|
+
#
|
91
|
+
#
|
92
|
+
# [1]: https://docs.aws.amazon.com/sync-service/latest/userguide/working-with-sync-agents.html#activating-sync-agent
|
93
|
+
# @return [String]
|
94
|
+
#
|
95
|
+
# @!attribute [rw] agent_name
|
96
|
+
# The name you configured for your agent. This value is a text
|
97
|
+
# reference that is used to identify the agent in the console.
|
98
|
+
# @return [String]
|
99
|
+
#
|
100
|
+
# @!attribute [rw] tags
|
101
|
+
# The key-value pair that represents the tag you want to associate
|
102
|
+
# with the agent. The value can be an empty string. This value helps
|
103
|
+
# you manage, filter, and search for your agents.
|
104
|
+
#
|
105
|
+
# <note markdown="1"> Valid characters for key and value are letters, spaces, and numbers
|
106
|
+
# representable in UTF-8 format, and the following special characters:
|
107
|
+
# + - = . \_ : / @.
|
108
|
+
#
|
109
|
+
# </note>
|
110
|
+
# @return [Array<Types::TagListEntry>]
|
111
|
+
#
|
112
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateAgentRequest AWS API Documentation
|
113
|
+
#
|
114
|
+
class CreateAgentRequest < Struct.new(
|
115
|
+
:activation_key,
|
116
|
+
:agent_name,
|
117
|
+
:tags)
|
118
|
+
include Aws::Structure
|
119
|
+
end
|
120
|
+
|
121
|
+
# CreateAgentResponse
|
122
|
+
#
|
123
|
+
# @!attribute [rw] agent_arn
|
124
|
+
# The Amazon Resource Name (ARN) of the agent. Use the `ListAgents`
|
125
|
+
# operation to return a list of agents for your account and AWS
|
126
|
+
# Region.
|
127
|
+
# @return [String]
|
128
|
+
#
|
129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateAgentResponse AWS API Documentation
|
130
|
+
#
|
131
|
+
class CreateAgentResponse < Struct.new(
|
132
|
+
:agent_arn)
|
133
|
+
include Aws::Structure
|
134
|
+
end
|
135
|
+
|
136
|
+
# CreateLocationEfsRequest
|
137
|
+
#
|
138
|
+
# @note When making an API call, you may pass CreateLocationEfsRequest
|
139
|
+
# data as a hash:
|
140
|
+
#
|
141
|
+
# {
|
142
|
+
# subdirectory: "Subdirectory", # required
|
143
|
+
# efs_filesystem_arn: "EfsFilesystemArn", # required
|
144
|
+
# ec2_config: { # required
|
145
|
+
# subnet_arn: "Ec2SubnetArn", # required
|
146
|
+
# security_group_arns: ["Ec2SecurityGroupArn"], # required
|
147
|
+
# },
|
148
|
+
# tags: [
|
149
|
+
# {
|
150
|
+
# key: "TagKey",
|
151
|
+
# value: "TagValue",
|
152
|
+
# },
|
153
|
+
# ],
|
154
|
+
# }
|
155
|
+
#
|
156
|
+
# @!attribute [rw] subdirectory
|
157
|
+
# A subdirectory in the location’s path. This subdirectory in the EFS
|
158
|
+
# file system is used to read data from the EFS source location or
|
159
|
+
# write data to the EFS destination. By default, AWS DataSync uses the
|
160
|
+
# root directory.
|
161
|
+
# @return [String]
|
162
|
+
#
|
163
|
+
# @!attribute [rw] efs_filesystem_arn
|
164
|
+
# The Amazon Resource Name (ARN) for the Amazon EFS file system.
|
165
|
+
# @return [String]
|
166
|
+
#
|
167
|
+
# @!attribute [rw] ec2_config
|
168
|
+
# The subnet and security group that the Amazon EFS file system uses.
|
169
|
+
# @return [Types::Ec2Config]
|
170
|
+
#
|
171
|
+
# @!attribute [rw] tags
|
172
|
+
# The key-value pair that represents a tag that you want to add to the
|
173
|
+
# resource. The value can be an empty string. This value helps you
|
174
|
+
# manage, filter, and search for your resources. We recommend that you
|
175
|
+
# create a name tag for your location.
|
176
|
+
# @return [Array<Types::TagListEntry>]
|
177
|
+
#
|
178
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationEfsRequest AWS API Documentation
|
179
|
+
#
|
180
|
+
class CreateLocationEfsRequest < Struct.new(
|
181
|
+
:subdirectory,
|
182
|
+
:efs_filesystem_arn,
|
183
|
+
:ec2_config,
|
184
|
+
:tags)
|
185
|
+
include Aws::Structure
|
186
|
+
end
|
187
|
+
|
188
|
+
# CreateLocationEfs
|
189
|
+
#
|
190
|
+
# @!attribute [rw] location_arn
|
191
|
+
# The Amazon Resource Name (ARN) of the Amazon EFS file system
|
192
|
+
# location that is created.
|
193
|
+
# @return [String]
|
194
|
+
#
|
195
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationEfsResponse AWS API Documentation
|
196
|
+
#
|
197
|
+
class CreateLocationEfsResponse < Struct.new(
|
198
|
+
:location_arn)
|
199
|
+
include Aws::Structure
|
200
|
+
end
|
201
|
+
|
202
|
+
# CreateLocationNfsRequest
|
203
|
+
#
|
204
|
+
# @note When making an API call, you may pass CreateLocationNfsRequest
|
205
|
+
# data as a hash:
|
206
|
+
#
|
207
|
+
# {
|
208
|
+
# subdirectory: "Subdirectory", # required
|
209
|
+
# server_hostname: "ServerHostname", # required
|
210
|
+
# on_prem_config: { # required
|
211
|
+
# agent_arns: ["AgentArn"], # required
|
212
|
+
# },
|
213
|
+
# tags: [
|
214
|
+
# {
|
215
|
+
# key: "TagKey",
|
216
|
+
# value: "TagValue",
|
217
|
+
# },
|
218
|
+
# ],
|
219
|
+
# }
|
220
|
+
#
|
221
|
+
# @!attribute [rw] subdirectory
|
222
|
+
# The subdirectory in the NFS file system that is used to read data
|
223
|
+
# from the NFS source location or write data to the NFS destination.
|
224
|
+
# The NFS path should be a path that's exported by the NFS server, or
|
225
|
+
# a subdirectory of that path. The path should be such that it can be
|
226
|
+
# mounted by other NFS clients in your network.
|
227
|
+
#
|
228
|
+
# To see all the paths exported by your NFS server. run "`showmount
|
229
|
+
# -e nfs-server-name`" from an NFS client that has access to your
|
230
|
+
# server. You can specify any directory that appears in the results,
|
231
|
+
# and any subdirectory of that directory. Ensure that the NFS export
|
232
|
+
# is accessible without Kerberos authentication.
|
233
|
+
#
|
234
|
+
# To transfer all the data in the folder you specified, DataSync needs
|
235
|
+
# to have permissions to read all the data. To ensure this, either
|
236
|
+
# configure the NFS export with `no_root_squash,` or ensure that the
|
237
|
+
# permissions for all of the files that you want sync allow read
|
238
|
+
# access for all users. Doing either enables the agent to read the
|
239
|
+
# files. For the agent to access directories, you must additionally
|
240
|
+
# enable all execute access. For information about NFS export
|
241
|
+
# configuration, see [18.7. The /etc/exports Configuration File][1] in
|
242
|
+
# the Centos documentation.
|
243
|
+
#
|
244
|
+
#
|
245
|
+
#
|
246
|
+
# [1]: https://www.centos.org/docs/5/html/Deployment_Guide-en-US/s1-nfs-server-config-exports.html
|
247
|
+
# @return [String]
|
248
|
+
#
|
249
|
+
# @!attribute [rw] server_hostname
|
250
|
+
# The name of the NFS server. This value is the IP address or Domain
|
251
|
+
# Name Service (DNS) name of the NFS server. An agent that is
|
252
|
+
# installed on-premises uses this host name to mount the NFS server in
|
253
|
+
# a network.
|
254
|
+
#
|
255
|
+
# <note markdown="1"> This name must either be DNS-compliant or must be an IP version 4
|
256
|
+
# (IPv4) address.
|
257
|
+
#
|
258
|
+
# </note>
|
259
|
+
# @return [String]
|
260
|
+
#
|
261
|
+
# @!attribute [rw] on_prem_config
|
262
|
+
# Contains a list of Amazon Resource Names (ARNs) of agents that are
|
263
|
+
# used to connect to an NFS server.
|
264
|
+
# @return [Types::OnPremConfig]
|
265
|
+
#
|
266
|
+
# @!attribute [rw] tags
|
267
|
+
# The key-value pair that represents the tag that you want to add to
|
268
|
+
# the location. The value can be an empty string. We recommend using
|
269
|
+
# tags to name your resources.
|
270
|
+
# @return [Array<Types::TagListEntry>]
|
271
|
+
#
|
272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationNfsRequest AWS API Documentation
|
273
|
+
#
|
274
|
+
class CreateLocationNfsRequest < Struct.new(
|
275
|
+
:subdirectory,
|
276
|
+
:server_hostname,
|
277
|
+
:on_prem_config,
|
278
|
+
:tags)
|
279
|
+
include Aws::Structure
|
280
|
+
end
|
281
|
+
|
282
|
+
# CreateLocationNfsResponse
|
283
|
+
#
|
284
|
+
# @!attribute [rw] location_arn
|
285
|
+
# The Amazon Resource Name (ARN) of the source NFS file system
|
286
|
+
# location that is created.
|
287
|
+
# @return [String]
|
288
|
+
#
|
289
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationNfsResponse AWS API Documentation
|
290
|
+
#
|
291
|
+
class CreateLocationNfsResponse < Struct.new(
|
292
|
+
:location_arn)
|
293
|
+
include Aws::Structure
|
294
|
+
end
|
295
|
+
|
296
|
+
# CreateLocationS3Request
|
297
|
+
#
|
298
|
+
# @note When making an API call, you may pass CreateLocationS3Request
|
299
|
+
# data as a hash:
|
300
|
+
#
|
301
|
+
# {
|
302
|
+
# subdirectory: "Subdirectory", # required
|
303
|
+
# s3_bucket_arn: "S3BucketArn", # required
|
304
|
+
# s3_config: { # required
|
305
|
+
# bucket_access_role_arn: "IamRoleArn", # required
|
306
|
+
# },
|
307
|
+
# tags: [
|
308
|
+
# {
|
309
|
+
# key: "TagKey",
|
310
|
+
# value: "TagValue",
|
311
|
+
# },
|
312
|
+
# ],
|
313
|
+
# }
|
314
|
+
#
|
315
|
+
# @!attribute [rw] subdirectory
|
316
|
+
# A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon
|
317
|
+
# S3 is used to read data from the S3 source location or write data to
|
318
|
+
# the S3 destination.
|
319
|
+
# @return [String]
|
320
|
+
#
|
321
|
+
# @!attribute [rw] s3_bucket_arn
|
322
|
+
# The Amazon Resource Name (ARN) of the Amazon S3 bucket.
|
323
|
+
# @return [String]
|
324
|
+
#
|
325
|
+
# @!attribute [rw] s3_config
|
326
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
327
|
+
# Management (IAM) role that is used to access an Amazon S3 bucket.
|
328
|
+
# For detailed information about using such a role, see [Components
|
329
|
+
# and Terminology][1] in the *AWS DataSync User Guide*.
|
330
|
+
#
|
331
|
+
#
|
332
|
+
#
|
333
|
+
# [1]: https://alpha-aws-docs.aws.amazon.com/sync-service/latest/userguide/create-locations-cli.html#create-location-s3-cli
|
334
|
+
# @return [Types::S3Config]
|
335
|
+
#
|
336
|
+
# @!attribute [rw] tags
|
337
|
+
# The key-value pair that represents the tag that you want to add to
|
338
|
+
# the location. The value can be an empty string. We recommend using
|
339
|
+
# tags to name your resources.
|
340
|
+
# @return [Array<Types::TagListEntry>]
|
341
|
+
#
|
342
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationS3Request AWS API Documentation
|
343
|
+
#
|
344
|
+
class CreateLocationS3Request < Struct.new(
|
345
|
+
:subdirectory,
|
346
|
+
:s3_bucket_arn,
|
347
|
+
:s3_config,
|
348
|
+
:tags)
|
349
|
+
include Aws::Structure
|
350
|
+
end
|
351
|
+
|
352
|
+
# CreateLocationS3Response
|
353
|
+
#
|
354
|
+
# @!attribute [rw] location_arn
|
355
|
+
# The Amazon Resource Name (ARN) of the source Amazon S3 bucket
|
356
|
+
# location that is created.
|
357
|
+
# @return [String]
|
358
|
+
#
|
359
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationS3Response AWS API Documentation
|
360
|
+
#
|
361
|
+
class CreateLocationS3Response < Struct.new(
|
362
|
+
:location_arn)
|
363
|
+
include Aws::Structure
|
364
|
+
end
|
365
|
+
|
366
|
+
# CreateTaskRequest
|
367
|
+
#
|
368
|
+
# @note When making an API call, you may pass CreateTaskRequest
|
369
|
+
# data as a hash:
|
370
|
+
#
|
371
|
+
# {
|
372
|
+
# source_location_arn: "LocationArn", # required
|
373
|
+
# destination_location_arn: "LocationArn", # required
|
374
|
+
# cloud_watch_log_group_arn: "LogGroupArn",
|
375
|
+
# name: "TagValue",
|
376
|
+
# options: {
|
377
|
+
# verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, NONE
|
378
|
+
# atime: "NONE", # accepts NONE, BEST_EFFORT
|
379
|
+
# mtime: "NONE", # accepts NONE, PRESERVE
|
380
|
+
# uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
|
381
|
+
# gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
|
382
|
+
# preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
|
383
|
+
# preserve_devices: "NONE", # accepts NONE, PRESERVE
|
384
|
+
# posix_permissions: "NONE", # accepts NONE, BEST_EFFORT, PRESERVE
|
385
|
+
# bytes_per_second: 1,
|
386
|
+
# },
|
387
|
+
# tags: [
|
388
|
+
# {
|
389
|
+
# key: "TagKey",
|
390
|
+
# value: "TagValue",
|
391
|
+
# },
|
392
|
+
# ],
|
393
|
+
# }
|
394
|
+
#
|
395
|
+
# @!attribute [rw] source_location_arn
|
396
|
+
# The Amazon Resource Name (ARN) of the source location for the task.
|
397
|
+
# @return [String]
|
398
|
+
#
|
399
|
+
# @!attribute [rw] destination_location_arn
|
400
|
+
# The Amazon Resource Name (ARN) of an AWS storage resource's
|
401
|
+
# location.
|
402
|
+
# @return [String]
|
403
|
+
#
|
404
|
+
# @!attribute [rw] cloud_watch_log_group_arn
|
405
|
+
# The Amazon Resource Name (ARN) of the Amazon CloudWatch log group
|
406
|
+
# that is used to monitor and log events in the task. For more
|
407
|
+
# information on these groups, see [Working with Log Groups and Log
|
408
|
+
# Streams][1] in the <i>Amazon CloudWatch User Guide. </i>
|
409
|
+
#
|
410
|
+
# For more information about how to useCloudWatchLogs with DataSync,
|
411
|
+
# see [Monitoring Your Task][2].
|
412
|
+
#
|
413
|
+
#
|
414
|
+
#
|
415
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html
|
416
|
+
# [2]: https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html
|
417
|
+
# @return [String]
|
418
|
+
#
|
419
|
+
# @!attribute [rw] name
|
420
|
+
# The name of a task. This value is a text reference that is used to
|
421
|
+
# identify the task in the console.
|
422
|
+
# @return [String]
|
423
|
+
#
|
424
|
+
# @!attribute [rw] options
|
425
|
+
# The set of configuration options that control the behavior of a
|
426
|
+
# single execution of the task that occurs when you call
|
427
|
+
# `StartTaskExecution`. You can configure these options to preserve
|
428
|
+
# metadata such as user ID (UID) and group ID (GID), file permissions,
|
429
|
+
# data integrity verification, and so on.
|
430
|
+
#
|
431
|
+
# For each individual task execution, you can override these options
|
432
|
+
# by specifying the `OverrideOptions` before starting a the task
|
433
|
+
# execution. For more information, see the operation.
|
434
|
+
# @return [Types::Options]
|
435
|
+
#
|
436
|
+
# @!attribute [rw] tags
|
437
|
+
# The key-value pair that represents the tag that you want to add to
|
438
|
+
# the resource. The value can be an empty string.
|
439
|
+
# @return [Array<Types::TagListEntry>]
|
440
|
+
#
|
441
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateTaskRequest AWS API Documentation
|
442
|
+
#
|
443
|
+
class CreateTaskRequest < Struct.new(
|
444
|
+
:source_location_arn,
|
445
|
+
:destination_location_arn,
|
446
|
+
:cloud_watch_log_group_arn,
|
447
|
+
:name,
|
448
|
+
:options,
|
449
|
+
:tags)
|
450
|
+
include Aws::Structure
|
451
|
+
end
|
452
|
+
|
453
|
+
# CreateTaskResponse
|
454
|
+
#
|
455
|
+
# @!attribute [rw] task_arn
|
456
|
+
# The Amazon Resource Name (ARN) of the task.
|
457
|
+
# @return [String]
|
458
|
+
#
|
459
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateTaskResponse AWS API Documentation
|
460
|
+
#
|
461
|
+
class CreateTaskResponse < Struct.new(
|
462
|
+
:task_arn)
|
463
|
+
include Aws::Structure
|
464
|
+
end
|
465
|
+
|
466
|
+
# DeleteAgentRequest
|
467
|
+
#
|
468
|
+
# @note When making an API call, you may pass DeleteAgentRequest
|
469
|
+
# data as a hash:
|
470
|
+
#
|
471
|
+
# {
|
472
|
+
# agent_arn: "AgentArn", # required
|
473
|
+
# }
|
474
|
+
#
|
475
|
+
# @!attribute [rw] agent_arn
|
476
|
+
# The Amazon Resource Name (ARN) of the agent to delete. Use the
|
477
|
+
# `ListAgents` operation to return a list of agents for your account
|
478
|
+
# and AWS Region.
|
479
|
+
# @return [String]
|
480
|
+
#
|
481
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DeleteAgentRequest AWS API Documentation
|
482
|
+
#
|
483
|
+
class DeleteAgentRequest < Struct.new(
|
484
|
+
:agent_arn)
|
485
|
+
include Aws::Structure
|
486
|
+
end
|
487
|
+
|
488
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DeleteAgentResponse AWS API Documentation
|
489
|
+
#
|
490
|
+
class DeleteAgentResponse < Aws::EmptyStructure; end
|
491
|
+
|
492
|
+
# DeleteLocation
|
493
|
+
#
|
494
|
+
# @note When making an API call, you may pass DeleteLocationRequest
|
495
|
+
# data as a hash:
|
496
|
+
#
|
497
|
+
# {
|
498
|
+
# location_arn: "LocationArn", # required
|
499
|
+
# }
|
500
|
+
#
|
501
|
+
# @!attribute [rw] location_arn
|
502
|
+
# The Amazon Resource Name (ARN) of the location to delete.
|
503
|
+
# @return [String]
|
504
|
+
#
|
505
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DeleteLocationRequest AWS API Documentation
|
506
|
+
#
|
507
|
+
class DeleteLocationRequest < Struct.new(
|
508
|
+
:location_arn)
|
509
|
+
include Aws::Structure
|
510
|
+
end
|
511
|
+
|
512
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DeleteLocationResponse AWS API Documentation
|
513
|
+
#
|
514
|
+
class DeleteLocationResponse < Aws::EmptyStructure; end
|
515
|
+
|
516
|
+
# DeleteTask
|
517
|
+
#
|
518
|
+
# @note When making an API call, you may pass DeleteTaskRequest
|
519
|
+
# data as a hash:
|
520
|
+
#
|
521
|
+
# {
|
522
|
+
# task_arn: "TaskArn", # required
|
523
|
+
# }
|
524
|
+
#
|
525
|
+
# @!attribute [rw] task_arn
|
526
|
+
# The Amazon Resource Name (ARN) of the task to delete.
|
527
|
+
# @return [String]
|
528
|
+
#
|
529
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DeleteTaskRequest AWS API Documentation
|
530
|
+
#
|
531
|
+
class DeleteTaskRequest < Struct.new(
|
532
|
+
:task_arn)
|
533
|
+
include Aws::Structure
|
534
|
+
end
|
535
|
+
|
536
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DeleteTaskResponse AWS API Documentation
|
537
|
+
#
|
538
|
+
class DeleteTaskResponse < Aws::EmptyStructure; end
|
539
|
+
|
540
|
+
# DescribeAgent
|
541
|
+
#
|
542
|
+
# @note When making an API call, you may pass DescribeAgentRequest
|
543
|
+
# data as a hash:
|
544
|
+
#
|
545
|
+
# {
|
546
|
+
# agent_arn: "AgentArn", # required
|
547
|
+
# }
|
548
|
+
#
|
549
|
+
# @!attribute [rw] agent_arn
|
550
|
+
# The Amazon Resource Name (ARN) of the agent to describe.
|
551
|
+
# @return [String]
|
552
|
+
#
|
553
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeAgentRequest AWS API Documentation
|
554
|
+
#
|
555
|
+
class DescribeAgentRequest < Struct.new(
|
556
|
+
:agent_arn)
|
557
|
+
include Aws::Structure
|
558
|
+
end
|
559
|
+
|
560
|
+
# DescribeAgentResponse
|
561
|
+
#
|
562
|
+
# @!attribute [rw] agent_arn
|
563
|
+
# The Amazon Resource Name (ARN) of the agent.
|
564
|
+
# @return [String]
|
565
|
+
#
|
566
|
+
# @!attribute [rw] name
|
567
|
+
# The name of the agent.
|
568
|
+
# @return [String]
|
569
|
+
#
|
570
|
+
# @!attribute [rw] status
|
571
|
+
# The status of the agent. If the status is ONLINE, then the agent is
|
572
|
+
# configured properly and is available to use. The Running status is
|
573
|
+
# the normal running status for an agent. If the status is OFFLINE,
|
574
|
+
# the agent's VM is turned off or the agent is in an unhealthy state.
|
575
|
+
# When the issue that caused the unhealthy state is resolved, the
|
576
|
+
# agent returns to ONLINE status.
|
577
|
+
# @return [String]
|
578
|
+
#
|
579
|
+
# @!attribute [rw] last_connection_time
|
580
|
+
# The time that the agent was last connected.
|
581
|
+
# @return [Time]
|
582
|
+
#
|
583
|
+
# @!attribute [rw] creation_time
|
584
|
+
# The time that the agent was activated (that is, created in your
|
585
|
+
# account).
|
586
|
+
# @return [Time]
|
587
|
+
#
|
588
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeAgentResponse AWS API Documentation
|
589
|
+
#
|
590
|
+
class DescribeAgentResponse < Struct.new(
|
591
|
+
:agent_arn,
|
592
|
+
:name,
|
593
|
+
:status,
|
594
|
+
:last_connection_time,
|
595
|
+
:creation_time)
|
596
|
+
include Aws::Structure
|
597
|
+
end
|
598
|
+
|
599
|
+
# DescribeLocationEfsRequest
|
600
|
+
#
|
601
|
+
# @note When making an API call, you may pass DescribeLocationEfsRequest
|
602
|
+
# data as a hash:
|
603
|
+
#
|
604
|
+
# {
|
605
|
+
# location_arn: "LocationArn", # required
|
606
|
+
# }
|
607
|
+
#
|
608
|
+
# @!attribute [rw] location_arn
|
609
|
+
# The Amazon Resource Name (ARN) of the EFS location to describe.
|
610
|
+
# @return [String]
|
611
|
+
#
|
612
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationEfsRequest AWS API Documentation
|
613
|
+
#
|
614
|
+
class DescribeLocationEfsRequest < Struct.new(
|
615
|
+
:location_arn)
|
616
|
+
include Aws::Structure
|
617
|
+
end
|
618
|
+
|
619
|
+
# DescribeLocationEfsResponse
|
620
|
+
#
|
621
|
+
# @!attribute [rw] location_arn
|
622
|
+
# The Amazon resource Name (ARN) of the EFS location that was
|
623
|
+
# described.
|
624
|
+
# @return [String]
|
625
|
+
#
|
626
|
+
# @!attribute [rw] location_uri
|
627
|
+
# The URL of the EFS location that was described.
|
628
|
+
# @return [String]
|
629
|
+
#
|
630
|
+
# @!attribute [rw] ec2_config
|
631
|
+
# The subnet and the security group that the target Amazon EFS file
|
632
|
+
# system uses. The subnet must have at least one mount target for that
|
633
|
+
# file system. The security group that you provide needs to be able to
|
634
|
+
# communicate with the security group on the mount target in the
|
635
|
+
# subnet specified.
|
636
|
+
#
|
637
|
+
# The exact relationship between security group M (of the mount
|
638
|
+
# target) and security group S (which you provide for DataSync to use
|
639
|
+
# at this stage) is as follows:
|
640
|
+
#
|
641
|
+
# * Security group M (which you associate with the mount target) must
|
642
|
+
# allow inbound access for the Transmission Control Protocol (TCP)
|
643
|
+
# on the NFS port (2049) from security group S. You can enable
|
644
|
+
# inbound connections either by IP address (CIDR range) or security
|
645
|
+
# group.
|
646
|
+
#
|
647
|
+
# * Security group S (provided to DataSync to access EFS) should have
|
648
|
+
# a rule that enables outbound connections to the NFS port on one of
|
649
|
+
# the file system’s mount targets. You can enable outbound
|
650
|
+
# connections either by IP address (CIDR range) or security group.
|
651
|
+
# For information about security groups and mount targets, see
|
652
|
+
# [Security Groups for Amazon EC2 Instances and Mount Targets][1] in
|
653
|
+
# the *Amazon EFS User Guide.*
|
654
|
+
#
|
655
|
+
#
|
656
|
+
#
|
657
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/security-considerations.html#network-access
|
658
|
+
# @return [Types::Ec2Config]
|
659
|
+
#
|
660
|
+
# @!attribute [rw] creation_time
|
661
|
+
# The time that the EFS location was created.
|
662
|
+
# @return [Time]
|
663
|
+
#
|
664
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationEfsResponse AWS API Documentation
|
665
|
+
#
|
666
|
+
class DescribeLocationEfsResponse < Struct.new(
|
667
|
+
:location_arn,
|
668
|
+
:location_uri,
|
669
|
+
:ec2_config,
|
670
|
+
:creation_time)
|
671
|
+
include Aws::Structure
|
672
|
+
end
|
673
|
+
|
674
|
+
# DescribeLocationNfsRequest
|
675
|
+
#
|
676
|
+
# @note When making an API call, you may pass DescribeLocationNfsRequest
|
677
|
+
# data as a hash:
|
678
|
+
#
|
679
|
+
# {
|
680
|
+
# location_arn: "LocationArn", # required
|
681
|
+
# }
|
682
|
+
#
|
683
|
+
# @!attribute [rw] location_arn
|
684
|
+
# The Amazon resource Name (ARN) of the NFS location to describe.
|
685
|
+
# @return [String]
|
686
|
+
#
|
687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationNfsRequest AWS API Documentation
|
688
|
+
#
|
689
|
+
class DescribeLocationNfsRequest < Struct.new(
|
690
|
+
:location_arn)
|
691
|
+
include Aws::Structure
|
692
|
+
end
|
693
|
+
|
694
|
+
# DescribeLocationNfsResponse
|
695
|
+
#
|
696
|
+
# @!attribute [rw] location_arn
|
697
|
+
# The Amazon resource Name (ARN) of the NFS location that was
|
698
|
+
# described.
|
699
|
+
# @return [String]
|
700
|
+
#
|
701
|
+
# @!attribute [rw] location_uri
|
702
|
+
# The URL of the source NFS location that was described.
|
703
|
+
# @return [String]
|
704
|
+
#
|
705
|
+
# @!attribute [rw] on_prem_config
|
706
|
+
# A list of Amazon Resource Names (ARNs) of agents to use for a
|
707
|
+
# Network File System (NFS) location.
|
708
|
+
# @return [Types::OnPremConfig]
|
709
|
+
#
|
710
|
+
# @!attribute [rw] creation_time
|
711
|
+
# The time that the NFS location was created.
|
712
|
+
# @return [Time]
|
713
|
+
#
|
714
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationNfsResponse AWS API Documentation
|
715
|
+
#
|
716
|
+
class DescribeLocationNfsResponse < Struct.new(
|
717
|
+
:location_arn,
|
718
|
+
:location_uri,
|
719
|
+
:on_prem_config,
|
720
|
+
:creation_time)
|
721
|
+
include Aws::Structure
|
722
|
+
end
|
723
|
+
|
724
|
+
# DescribeLocationS3Request
|
725
|
+
#
|
726
|
+
# @note When making an API call, you may pass DescribeLocationS3Request
|
727
|
+
# data as a hash:
|
728
|
+
#
|
729
|
+
# {
|
730
|
+
# location_arn: "LocationArn", # required
|
731
|
+
# }
|
732
|
+
#
|
733
|
+
# @!attribute [rw] location_arn
|
734
|
+
# The Amazon Resource Name (ARN) of the Amazon S3 bucket location to
|
735
|
+
# describe.
|
736
|
+
# @return [String]
|
737
|
+
#
|
738
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationS3Request AWS API Documentation
|
739
|
+
#
|
740
|
+
class DescribeLocationS3Request < Struct.new(
|
741
|
+
:location_arn)
|
742
|
+
include Aws::Structure
|
743
|
+
end
|
744
|
+
|
745
|
+
# DescribeLocationS3Response
|
746
|
+
#
|
747
|
+
# @!attribute [rw] location_arn
|
748
|
+
# The Amazon Resource Name (ARN) of the Amazon S3 bucket location.
|
749
|
+
# @return [String]
|
750
|
+
#
|
751
|
+
# @!attribute [rw] location_uri
|
752
|
+
# The URL of the Amazon S3 location that was described.
|
753
|
+
# @return [String]
|
754
|
+
#
|
755
|
+
# @!attribute [rw] s3_config
|
756
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
757
|
+
# Management (IAM) role that is used to access an Amazon S3 bucket.
|
758
|
+
# For detailed information about using such a role, see [Components
|
759
|
+
# and Terminology][1] in the *AWS DataSync User Guide*.
|
760
|
+
#
|
761
|
+
#
|
762
|
+
#
|
763
|
+
# [1]: https://alpha-aws-docs.aws.amazon.com/sync-service/latest/userguide/create-locations-cli.html#create-location-s3-cli
|
764
|
+
# @return [Types::S3Config]
|
765
|
+
#
|
766
|
+
# @!attribute [rw] creation_time
|
767
|
+
# The time that the Amazon S3 bucket location was created.
|
768
|
+
# @return [Time]
|
769
|
+
#
|
770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationS3Response AWS API Documentation
|
771
|
+
#
|
772
|
+
class DescribeLocationS3Response < Struct.new(
|
773
|
+
:location_arn,
|
774
|
+
:location_uri,
|
775
|
+
:s3_config,
|
776
|
+
:creation_time)
|
777
|
+
include Aws::Structure
|
778
|
+
end
|
779
|
+
|
780
|
+
# DescribeTaskExecutionRequest
|
781
|
+
#
|
782
|
+
# @note When making an API call, you may pass DescribeTaskExecutionRequest
|
783
|
+
# data as a hash:
|
784
|
+
#
|
785
|
+
# {
|
786
|
+
# task_execution_arn: "TaskExecutionArn", # required
|
787
|
+
# }
|
788
|
+
#
|
789
|
+
# @!attribute [rw] task_execution_arn
|
790
|
+
# The Amazon Resource Name (ARN) of the task that is being executed.
|
791
|
+
# @return [String]
|
792
|
+
#
|
793
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskExecutionRequest AWS API Documentation
|
794
|
+
#
|
795
|
+
class DescribeTaskExecutionRequest < Struct.new(
|
796
|
+
:task_execution_arn)
|
797
|
+
include Aws::Structure
|
798
|
+
end
|
799
|
+
|
800
|
+
# DescribeTaskExecutionResponse
|
801
|
+
#
|
802
|
+
# @!attribute [rw] task_execution_arn
|
803
|
+
# The Amazon Resource Name (ARN) of the task execution that was
|
804
|
+
# described. `TaskExecutionArn` is hierarchical and includes `TaskArn`
|
805
|
+
# for the task that was executed.
|
806
|
+
#
|
807
|
+
# For example, a `TaskExecution` value with the ARN
|
808
|
+
# `arn:aws:sync:us-east-1:209870788375:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b`
|
809
|
+
# executed the task with the ARN
|
810
|
+
# `arn:aws:sync:us-east-1:209870788375:task/task-0208075f79cedf4a2`.
|
811
|
+
# @return [String]
|
812
|
+
#
|
813
|
+
# @!attribute [rw] status
|
814
|
+
# The status of the task. For detailed information about sync
|
815
|
+
# statuses, see [Understanding Sync Task Statuses][1].
|
816
|
+
#
|
817
|
+
#
|
818
|
+
#
|
819
|
+
# [1]: https://docs.aws.amazon.com/sync-service/latest/userguide/understand-sync-task-statuses.html
|
820
|
+
# @return [String]
|
821
|
+
#
|
822
|
+
# @!attribute [rw] options
|
823
|
+
# Represents the options that are available to control the behavior of
|
824
|
+
# a StartTaskExecution operation. Behavior includes preserving
|
825
|
+
# metadata such as user ID (UID), group ID (GID), and file
|
826
|
+
# permissions, and also overwriting files in the destination, data
|
827
|
+
# integrity verification, and so on.
|
828
|
+
#
|
829
|
+
# A task has a set of default options associated with it. If you
|
830
|
+
# don't specify an option in StartTaskExecution, the default value is
|
831
|
+
# used. You can override the defaults options on each task execution
|
832
|
+
# by specifying an overriding `Options` value to StartTaskExecution.
|
833
|
+
# @return [Types::Options]
|
834
|
+
#
|
835
|
+
# @!attribute [rw] start_time
|
836
|
+
# The time that the task execution was started.
|
837
|
+
# @return [Time]
|
838
|
+
#
|
839
|
+
# @!attribute [rw] estimated_files_to_transfer
|
840
|
+
# The expected number of files that is to be transferred over the
|
841
|
+
# network. This value is calculated during the PREPARING phase, before
|
842
|
+
# the TRANSFERRING phase. This value is the expected number of files
|
843
|
+
# to be transferred. It's calculated based on comparing the content
|
844
|
+
# of the source and destination locations and finding the delta that
|
845
|
+
# needs to be transferred.
|
846
|
+
# @return [Integer]
|
847
|
+
#
|
848
|
+
# @!attribute [rw] estimated_bytes_to_transfer
|
849
|
+
# The estimated physical number of bytes that is to be transferred
|
850
|
+
# over the network.
|
851
|
+
# @return [Integer]
|
852
|
+
#
|
853
|
+
# @!attribute [rw] files_transferred
|
854
|
+
# The actual number of files that was transferred over the network.
|
855
|
+
# This value is calculated and updated on an ongoing basis during the
|
856
|
+
# TRANSFERRING phase. It's updated periodically when each file is
|
857
|
+
# read from the source and sent over the network.
|
858
|
+
#
|
859
|
+
# If failures occur during a transfer, this value can be less than
|
860
|
+
# `EstimatedFilesToTransfer`. This value can also be greater than
|
861
|
+
# `EstimatedFilesTransferred` in some cases. This element is
|
862
|
+
# implementation-specific for some location types, so don't use it as
|
863
|
+
# an indicator for a correct file number or to monitor your task
|
864
|
+
# execution.
|
865
|
+
# @return [Integer]
|
866
|
+
#
|
867
|
+
# @!attribute [rw] bytes_written
|
868
|
+
# The number of logical bytes written to the destination AWS storage
|
869
|
+
# resource.
|
870
|
+
# @return [Integer]
|
871
|
+
#
|
872
|
+
# @!attribute [rw] bytes_transferred
|
873
|
+
# The physical number of bytes transferred over the network.
|
874
|
+
# @return [Integer]
|
875
|
+
#
|
876
|
+
# @!attribute [rw] result
|
877
|
+
# The result of the task execution.
|
878
|
+
# @return [Types::TaskExecutionResultDetail]
|
879
|
+
#
|
880
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskExecutionResponse AWS API Documentation
|
881
|
+
#
|
882
|
+
class DescribeTaskExecutionResponse < Struct.new(
|
883
|
+
:task_execution_arn,
|
884
|
+
:status,
|
885
|
+
:options,
|
886
|
+
:start_time,
|
887
|
+
:estimated_files_to_transfer,
|
888
|
+
:estimated_bytes_to_transfer,
|
889
|
+
:files_transferred,
|
890
|
+
:bytes_written,
|
891
|
+
:bytes_transferred,
|
892
|
+
:result)
|
893
|
+
include Aws::Structure
|
894
|
+
end
|
895
|
+
|
896
|
+
# DescribeTaskRequest
|
897
|
+
#
|
898
|
+
# @note When making an API call, you may pass DescribeTaskRequest
|
899
|
+
# data as a hash:
|
900
|
+
#
|
901
|
+
# {
|
902
|
+
# task_arn: "TaskArn", # required
|
903
|
+
# }
|
904
|
+
#
|
905
|
+
# @!attribute [rw] task_arn
|
906
|
+
# The Amazon Resource Name (ARN) of the task to describe.
|
907
|
+
# @return [String]
|
908
|
+
#
|
909
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskRequest AWS API Documentation
|
910
|
+
#
|
911
|
+
class DescribeTaskRequest < Struct.new(
|
912
|
+
:task_arn)
|
913
|
+
include Aws::Structure
|
914
|
+
end
|
915
|
+
|
916
|
+
# DescribeTaskResponse
|
917
|
+
#
|
918
|
+
# @!attribute [rw] task_arn
|
919
|
+
# The Amazon Resource Name (ARN) of the task that was described.
|
920
|
+
# @return [String]
|
921
|
+
#
|
922
|
+
# @!attribute [rw] status
|
923
|
+
# The status of the task that was described. For detailed information
|
924
|
+
# about sync statuses, see [Understanding Sync Task Statuses][1].
|
925
|
+
#
|
926
|
+
#
|
927
|
+
#
|
928
|
+
# [1]: https://docs.aws.amazon.com/sync-service/latest/userguide/understand-sync-task-statuses.html
|
929
|
+
# @return [String]
|
930
|
+
#
|
931
|
+
# @!attribute [rw] name
|
932
|
+
# The name of the task that was described.
|
933
|
+
# @return [String]
|
934
|
+
#
|
935
|
+
# @!attribute [rw] current_task_execution_arn
|
936
|
+
# The Amazon Resource Name (ARN) of the task execution that is syncing
|
937
|
+
# files.
|
938
|
+
# @return [String]
|
939
|
+
#
|
940
|
+
# @!attribute [rw] source_location_arn
|
941
|
+
# The Amazon Resource Name (ARN) of the source file system's
|
942
|
+
# location.
|
943
|
+
# @return [String]
|
944
|
+
#
|
945
|
+
# @!attribute [rw] destination_location_arn
|
946
|
+
# The Amazon Resource Name (ARN) of the AWS storage resource's
|
947
|
+
# location.
|
948
|
+
# @return [String]
|
949
|
+
#
|
950
|
+
# @!attribute [rw] cloud_watch_log_group_arn
|
951
|
+
# The Amazon Resource Name (ARN) of the Amazon CloudWatch log group
|
952
|
+
# that was used to monitor and log events in the task. For more
|
953
|
+
# information on these groups, see [Working with Log Groups and Log
|
954
|
+
# Streams][1] in the *Amazon CloudWatch User Guide.*
|
955
|
+
#
|
956
|
+
#
|
957
|
+
#
|
958
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html
|
959
|
+
# @return [String]
|
960
|
+
#
|
961
|
+
# @!attribute [rw] options
|
962
|
+
# The set of configuration options that control the behavior of a
|
963
|
+
# single execution of the task that occurs when you call
|
964
|
+
# `StartTaskExecution`. You can configure these options to preserve
|
965
|
+
# metadata such as user ID (UID) and group (GID), file permissions,
|
966
|
+
# data integrity verification, and so on.
|
967
|
+
#
|
968
|
+
# For each individual task execution, you can override these options
|
969
|
+
# by specifying the overriding `OverrideOptions` value to operation.
|
970
|
+
# @return [Types::Options]
|
971
|
+
#
|
972
|
+
# @!attribute [rw] error_code
|
973
|
+
# Errors that AWS DataSync encountered during execution of the task.
|
974
|
+
# You can use this error code to help troubleshoot issues.
|
975
|
+
# @return [String]
|
976
|
+
#
|
977
|
+
# @!attribute [rw] error_detail
|
978
|
+
# Detailed description of an error that was encountered during the
|
979
|
+
# task execution. You can use this information to help troubleshoot
|
980
|
+
# issues.
|
981
|
+
# @return [String]
|
982
|
+
#
|
983
|
+
# @!attribute [rw] creation_time
|
984
|
+
# The time that the task was created.
|
985
|
+
# @return [Time]
|
986
|
+
#
|
987
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskResponse AWS API Documentation
|
988
|
+
#
|
989
|
+
class DescribeTaskResponse < Struct.new(
|
990
|
+
:task_arn,
|
991
|
+
:status,
|
992
|
+
:name,
|
993
|
+
:current_task_execution_arn,
|
994
|
+
:source_location_arn,
|
995
|
+
:destination_location_arn,
|
996
|
+
:cloud_watch_log_group_arn,
|
997
|
+
:options,
|
998
|
+
:error_code,
|
999
|
+
:error_detail,
|
1000
|
+
:creation_time)
|
1001
|
+
include Aws::Structure
|
1002
|
+
end
|
1003
|
+
|
1004
|
+
# The subnet and the security group that the target Amazon EFS file
|
1005
|
+
# system uses. The subnet must have at least one mount target for that
|
1006
|
+
# file system. The security group that you provide needs to be able to
|
1007
|
+
# communicate with the security group on the mount target in the subnet
|
1008
|
+
# specified.
|
1009
|
+
#
|
1010
|
+
# The exact relationship between security group M (of the mount target)
|
1011
|
+
# and security group S (which you provide for DataSync to use at this
|
1012
|
+
# stage) is as follows:
|
1013
|
+
#
|
1014
|
+
# * Security group M (which you associate with the mount target) must
|
1015
|
+
# allow inbound access for the Transmission Control Protocol (TCP) on
|
1016
|
+
# the NFS port (2049) from security group S. You can enable inbound
|
1017
|
+
# connections either by IP address (CIDR range) or security group.
|
1018
|
+
#
|
1019
|
+
# * Security group S (provided to DataSync to access EFS) should have a
|
1020
|
+
# rule that enables outbound connections to the NFS port on one of the
|
1021
|
+
# file system’s mount targets. You can enable outbound connections
|
1022
|
+
# either by IP address (CIDR range) or security group. For information
|
1023
|
+
# about security groups and mount targets, see [Security Groups for
|
1024
|
+
# Amazon EC2 Instances and Mount Targets][1] in the *Amazon EFS User
|
1025
|
+
# Guide.*
|
1026
|
+
#
|
1027
|
+
#
|
1028
|
+
#
|
1029
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/security-considerations.html#network-access
|
1030
|
+
#
|
1031
|
+
# @note When making an API call, you may pass Ec2Config
|
1032
|
+
# data as a hash:
|
1033
|
+
#
|
1034
|
+
# {
|
1035
|
+
# subnet_arn: "Ec2SubnetArn", # required
|
1036
|
+
# security_group_arns: ["Ec2SecurityGroupArn"], # required
|
1037
|
+
# }
|
1038
|
+
#
|
1039
|
+
# @!attribute [rw] subnet_arn
|
1040
|
+
# The ARN of the subnet that the Amazon EC2 resource belongs in.
|
1041
|
+
# @return [String]
|
1042
|
+
#
|
1043
|
+
# @!attribute [rw] security_group_arns
|
1044
|
+
# The Amazon Resource Names (ARNs) of the security groups that are
|
1045
|
+
# configured for the Amazon EC2 resource.
|
1046
|
+
# @return [Array<String>]
|
1047
|
+
#
|
1048
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/Ec2Config AWS API Documentation
|
1049
|
+
#
|
1050
|
+
class Ec2Config < Struct.new(
|
1051
|
+
:subnet_arn,
|
1052
|
+
:security_group_arns)
|
1053
|
+
include Aws::Structure
|
1054
|
+
end
|
1055
|
+
|
1056
|
+
# ListAgentsRequest
|
1057
|
+
#
|
1058
|
+
# @note When making an API call, you may pass ListAgentsRequest
|
1059
|
+
# data as a hash:
|
1060
|
+
#
|
1061
|
+
# {
|
1062
|
+
# max_results: 1,
|
1063
|
+
# next_token: "NextToken",
|
1064
|
+
# }
|
1065
|
+
#
|
1066
|
+
# @!attribute [rw] max_results
|
1067
|
+
# The maximum number of agents to list.
|
1068
|
+
# @return [Integer]
|
1069
|
+
#
|
1070
|
+
# @!attribute [rw] next_token
|
1071
|
+
# An opaque string that indicates the position at which to begin the
|
1072
|
+
# next list of agents.
|
1073
|
+
# @return [String]
|
1074
|
+
#
|
1075
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListAgentsRequest AWS API Documentation
|
1076
|
+
#
|
1077
|
+
class ListAgentsRequest < Struct.new(
|
1078
|
+
:max_results,
|
1079
|
+
:next_token)
|
1080
|
+
include Aws::Structure
|
1081
|
+
end
|
1082
|
+
|
1083
|
+
# ListAgentsResponse
|
1084
|
+
#
|
1085
|
+
# @!attribute [rw] agents
|
1086
|
+
# A list of agents in your account.
|
1087
|
+
# @return [Array<Types::AgentListEntry>]
|
1088
|
+
#
|
1089
|
+
# @!attribute [rw] next_token
|
1090
|
+
# An opaque string that indicates the position at which to begin
|
1091
|
+
# returning the next list of agents.
|
1092
|
+
# @return [String]
|
1093
|
+
#
|
1094
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListAgentsResponse AWS API Documentation
|
1095
|
+
#
|
1096
|
+
class ListAgentsResponse < Struct.new(
|
1097
|
+
:agents,
|
1098
|
+
:next_token)
|
1099
|
+
include Aws::Structure
|
1100
|
+
end
|
1101
|
+
|
1102
|
+
# ListLocationsRequest
|
1103
|
+
#
|
1104
|
+
# @note When making an API call, you may pass ListLocationsRequest
|
1105
|
+
# data as a hash:
|
1106
|
+
#
|
1107
|
+
# {
|
1108
|
+
# max_results: 1,
|
1109
|
+
# next_token: "NextToken",
|
1110
|
+
# }
|
1111
|
+
#
|
1112
|
+
# @!attribute [rw] max_results
|
1113
|
+
# The maximum number of locations to return.
|
1114
|
+
# @return [Integer]
|
1115
|
+
#
|
1116
|
+
# @!attribute [rw] next_token
|
1117
|
+
# An opaque string that indicates the position at which to begin the
|
1118
|
+
# next list of locations.
|
1119
|
+
# @return [String]
|
1120
|
+
#
|
1121
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListLocationsRequest AWS API Documentation
|
1122
|
+
#
|
1123
|
+
class ListLocationsRequest < Struct.new(
|
1124
|
+
:max_results,
|
1125
|
+
:next_token)
|
1126
|
+
include Aws::Structure
|
1127
|
+
end
|
1128
|
+
|
1129
|
+
# ListLocationsResponse
|
1130
|
+
#
|
1131
|
+
# @!attribute [rw] locations
|
1132
|
+
# An array that contains a list of locations.
|
1133
|
+
# @return [Array<Types::LocationListEntry>]
|
1134
|
+
#
|
1135
|
+
# @!attribute [rw] next_token
|
1136
|
+
# An opaque string that indicates the position at which to begin
|
1137
|
+
# returning the next list of locations.
|
1138
|
+
# @return [String]
|
1139
|
+
#
|
1140
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListLocationsResponse AWS API Documentation
|
1141
|
+
#
|
1142
|
+
class ListLocationsResponse < Struct.new(
|
1143
|
+
:locations,
|
1144
|
+
:next_token)
|
1145
|
+
include Aws::Structure
|
1146
|
+
end
|
1147
|
+
|
1148
|
+
# ListTagsForResourceRequest
|
1149
|
+
#
|
1150
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
1151
|
+
# data as a hash:
|
1152
|
+
#
|
1153
|
+
# {
|
1154
|
+
# resource_arn: "TaggableResourceArn", # required
|
1155
|
+
# max_results: 1,
|
1156
|
+
# next_token: "NextToken",
|
1157
|
+
# }
|
1158
|
+
#
|
1159
|
+
# @!attribute [rw] resource_arn
|
1160
|
+
# The Amazon Resource Name (ARN) of the resource whose tags to list.
|
1161
|
+
# @return [String]
|
1162
|
+
#
|
1163
|
+
# @!attribute [rw] max_results
|
1164
|
+
# The maximum number of locations to return.
|
1165
|
+
# @return [Integer]
|
1166
|
+
#
|
1167
|
+
# @!attribute [rw] next_token
|
1168
|
+
# An opaque string that indicates the position at which to begin the
|
1169
|
+
# next list of locations.
|
1170
|
+
# @return [String]
|
1171
|
+
#
|
1172
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTagsForResourceRequest AWS API Documentation
|
1173
|
+
#
|
1174
|
+
class ListTagsForResourceRequest < Struct.new(
|
1175
|
+
:resource_arn,
|
1176
|
+
:max_results,
|
1177
|
+
:next_token)
|
1178
|
+
include Aws::Structure
|
1179
|
+
end
|
1180
|
+
|
1181
|
+
# ListTagsForResourceResponse
|
1182
|
+
#
|
1183
|
+
# @!attribute [rw] tags
|
1184
|
+
# Array of resource tags.
|
1185
|
+
# @return [Array<Types::TagListEntry>]
|
1186
|
+
#
|
1187
|
+
# @!attribute [rw] next_token
|
1188
|
+
# An opaque string that indicates the position at which to begin
|
1189
|
+
# returning the next list of resource tags.
|
1190
|
+
# @return [String]
|
1191
|
+
#
|
1192
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTagsForResourceResponse AWS API Documentation
|
1193
|
+
#
|
1194
|
+
class ListTagsForResourceResponse < Struct.new(
|
1195
|
+
:tags,
|
1196
|
+
:next_token)
|
1197
|
+
include Aws::Structure
|
1198
|
+
end
|
1199
|
+
|
1200
|
+
# ListTaskExecutions
|
1201
|
+
#
|
1202
|
+
# @note When making an API call, you may pass ListTaskExecutionsRequest
|
1203
|
+
# data as a hash:
|
1204
|
+
#
|
1205
|
+
# {
|
1206
|
+
# task_arn: "TaskArn",
|
1207
|
+
# max_results: 1,
|
1208
|
+
# next_token: "NextToken",
|
1209
|
+
# }
|
1210
|
+
#
|
1211
|
+
# @!attribute [rw] task_arn
|
1212
|
+
# The Amazon Resource Name (ARN) of the task whose tasks you want to
|
1213
|
+
# list.
|
1214
|
+
# @return [String]
|
1215
|
+
#
|
1216
|
+
# @!attribute [rw] max_results
|
1217
|
+
# The maximum number of executed tasks to list.
|
1218
|
+
# @return [Integer]
|
1219
|
+
#
|
1220
|
+
# @!attribute [rw] next_token
|
1221
|
+
# An opaque string that indicates the position at which to begin the
|
1222
|
+
# next list of the executed tasks.
|
1223
|
+
# @return [String]
|
1224
|
+
#
|
1225
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTaskExecutionsRequest AWS API Documentation
|
1226
|
+
#
|
1227
|
+
class ListTaskExecutionsRequest < Struct.new(
|
1228
|
+
:task_arn,
|
1229
|
+
:max_results,
|
1230
|
+
:next_token)
|
1231
|
+
include Aws::Structure
|
1232
|
+
end
|
1233
|
+
|
1234
|
+
# ListTaskExecutionsResponse
|
1235
|
+
#
|
1236
|
+
# @!attribute [rw] task_executions
|
1237
|
+
# A list of executed tasks.
|
1238
|
+
# @return [Array<Types::TaskExecutionListEntry>]
|
1239
|
+
#
|
1240
|
+
# @!attribute [rw] next_token
|
1241
|
+
# An opaque string that indicates the position at which to begin
|
1242
|
+
# returning the next list of executed tasks.
|
1243
|
+
# @return [String]
|
1244
|
+
#
|
1245
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTaskExecutionsResponse AWS API Documentation
|
1246
|
+
#
|
1247
|
+
class ListTaskExecutionsResponse < Struct.new(
|
1248
|
+
:task_executions,
|
1249
|
+
:next_token)
|
1250
|
+
include Aws::Structure
|
1251
|
+
end
|
1252
|
+
|
1253
|
+
# ListTasksRequest
|
1254
|
+
#
|
1255
|
+
# @note When making an API call, you may pass ListTasksRequest
|
1256
|
+
# data as a hash:
|
1257
|
+
#
|
1258
|
+
# {
|
1259
|
+
# max_results: 1,
|
1260
|
+
# next_token: "NextToken",
|
1261
|
+
# }
|
1262
|
+
#
|
1263
|
+
# @!attribute [rw] max_results
|
1264
|
+
# The maximum number of tasks to return.
|
1265
|
+
# @return [Integer]
|
1266
|
+
#
|
1267
|
+
# @!attribute [rw] next_token
|
1268
|
+
# An opaque string that indicates the position at which to begin the
|
1269
|
+
# next list of tasks.
|
1270
|
+
# @return [String]
|
1271
|
+
#
|
1272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTasksRequest AWS API Documentation
|
1273
|
+
#
|
1274
|
+
class ListTasksRequest < Struct.new(
|
1275
|
+
:max_results,
|
1276
|
+
:next_token)
|
1277
|
+
include Aws::Structure
|
1278
|
+
end
|
1279
|
+
|
1280
|
+
# ListTasksResponse
|
1281
|
+
#
|
1282
|
+
# @!attribute [rw] tasks
|
1283
|
+
# A list of all the tasks that are returned.
|
1284
|
+
# @return [Array<Types::TaskListEntry>]
|
1285
|
+
#
|
1286
|
+
# @!attribute [rw] next_token
|
1287
|
+
# An opaque string that indicates the position at which to begin
|
1288
|
+
# returning the next list of tasks.
|
1289
|
+
# @return [String]
|
1290
|
+
#
|
1291
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTasksResponse AWS API Documentation
|
1292
|
+
#
|
1293
|
+
class ListTasksResponse < Struct.new(
|
1294
|
+
:tasks,
|
1295
|
+
:next_token)
|
1296
|
+
include Aws::Structure
|
1297
|
+
end
|
1298
|
+
|
1299
|
+
# Represents a single entry in a list of locations. `LocationListEntry`
|
1300
|
+
# returns an array that contains a list of locations when the
|
1301
|
+
# ListLocations operation is called.
|
1302
|
+
#
|
1303
|
+
# @!attribute [rw] location_arn
|
1304
|
+
# The Amazon Resource Name (ARN) of the location. For Network File
|
1305
|
+
# System (NFS) or Amazon EFS, the location is the export path. For
|
1306
|
+
# Amazon S3, the location is the prefix path that you want to mount
|
1307
|
+
# and use as the root of the location.
|
1308
|
+
# @return [String]
|
1309
|
+
#
|
1310
|
+
# @!attribute [rw] location_uri
|
1311
|
+
# Represents a list of URLs of a location. `LocationUri` returns an
|
1312
|
+
# array that contains a list of locations when the ListLocations
|
1313
|
+
# operation is called.
|
1314
|
+
#
|
1315
|
+
# Format: `TYPE://GLOBAL_ID/SUBDIR`.
|
1316
|
+
#
|
1317
|
+
# TYPE designates the type of location. Valid values: NFS \| EFS \|
|
1318
|
+
# S3.
|
1319
|
+
#
|
1320
|
+
# GLOBAL\_ID is the globally unique identifier of the resource that
|
1321
|
+
# backs the location. An example for EFS is `us-east-2.fs-abcd1234`.
|
1322
|
+
# An example for Amazon S3 is the bucket name, such as `myBucket`. An
|
1323
|
+
# example for NFS is a valid IPv4 address or a host name compliant
|
1324
|
+
# with Domain Name Service (DNS).
|
1325
|
+
#
|
1326
|
+
# SUBDIR is a valid file system path, delimited by forward slashes as
|
1327
|
+
# is the *nix convention. For NFS and Amazon EFS, it's the export
|
1328
|
+
# path to mount the location. For Amazon S3, it's the prefix path
|
1329
|
+
# that you mount to and treat as the root of the location.
|
1330
|
+
# @return [String]
|
1331
|
+
#
|
1332
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/LocationListEntry AWS API Documentation
|
1333
|
+
#
|
1334
|
+
class LocationListEntry < Struct.new(
|
1335
|
+
:location_arn,
|
1336
|
+
:location_uri)
|
1337
|
+
include Aws::Structure
|
1338
|
+
end
|
1339
|
+
|
1340
|
+
# A list of Amazon Resource Names (ARNs) of agents to use for a Network
|
1341
|
+
# File System (NFS) location.
|
1342
|
+
#
|
1343
|
+
# @note When making an API call, you may pass OnPremConfig
|
1344
|
+
# data as a hash:
|
1345
|
+
#
|
1346
|
+
# {
|
1347
|
+
# agent_arns: ["AgentArn"], # required
|
1348
|
+
# }
|
1349
|
+
#
|
1350
|
+
# @!attribute [rw] agent_arns
|
1351
|
+
# ARNs)of the agents to use for an NFS location.
|
1352
|
+
# @return [Array<String>]
|
1353
|
+
#
|
1354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/OnPremConfig AWS API Documentation
|
1355
|
+
#
|
1356
|
+
class OnPremConfig < Struct.new(
|
1357
|
+
:agent_arns)
|
1358
|
+
include Aws::Structure
|
1359
|
+
end
|
1360
|
+
|
1361
|
+
# Represents the options that are available to control the behavior of a
|
1362
|
+
# StartTaskExecution operation. Behavior includes preserving metadata
|
1363
|
+
# such as user ID (UID), group ID (GID), and file permissions, and also
|
1364
|
+
# overwriting files in the destination, data integrity verification, and
|
1365
|
+
# so on.
|
1366
|
+
#
|
1367
|
+
# A task has a set of default options associated with it. If you don't
|
1368
|
+
# specify an option in StartTaskExecution, the default value is used.
|
1369
|
+
# You can override the defaults options on each task execution by
|
1370
|
+
# specifying an overriding `Options` value to StartTaskExecution.
|
1371
|
+
#
|
1372
|
+
# @note When making an API call, you may pass Options
|
1373
|
+
# data as a hash:
|
1374
|
+
#
|
1375
|
+
# {
|
1376
|
+
# verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, NONE
|
1377
|
+
# atime: "NONE", # accepts NONE, BEST_EFFORT
|
1378
|
+
# mtime: "NONE", # accepts NONE, PRESERVE
|
1379
|
+
# uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
|
1380
|
+
# gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
|
1381
|
+
# preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
|
1382
|
+
# preserve_devices: "NONE", # accepts NONE, PRESERVE
|
1383
|
+
# posix_permissions: "NONE", # accepts NONE, BEST_EFFORT, PRESERVE
|
1384
|
+
# bytes_per_second: 1,
|
1385
|
+
# }
|
1386
|
+
#
|
1387
|
+
# @!attribute [rw] verify_mode
|
1388
|
+
# A value that determines whether a data integrity verification should
|
1389
|
+
# be performed at the end of a task execution after all data and
|
1390
|
+
# metadata have been transferred.
|
1391
|
+
#
|
1392
|
+
# Default value: POINT\_IN\_TIME\_CONSISTENT.
|
1393
|
+
#
|
1394
|
+
# POINT\_IN\_TIME\_CONSISTENT: Perform verification (recommended).
|
1395
|
+
#
|
1396
|
+
# NONE: Skip verification.
|
1397
|
+
# @return [String]
|
1398
|
+
#
|
1399
|
+
# @!attribute [rw] atime
|
1400
|
+
# A file metadata value that shows the last time a file was accessed
|
1401
|
+
# (that is, when the file was read or written to). If you set `Atime`
|
1402
|
+
# to BEST\_EFFORT, DataSync attempts to preserve the original `Atime`
|
1403
|
+
# attribute on all source files (that is, the version before the
|
1404
|
+
# PREPARING phase). However, `Atime`'s behavior is not fully standard
|
1405
|
+
# across platforms, so AWS DataSync can only do this on a best-effort
|
1406
|
+
# basis.
|
1407
|
+
#
|
1408
|
+
# Default value: BEST\_EFFORT.
|
1409
|
+
#
|
1410
|
+
# BEST\_EFFORT: Attempt to preserve the per-file `Atime` value
|
1411
|
+
# (recommended).
|
1412
|
+
#
|
1413
|
+
# NONE: Ignore `Atime`.
|
1414
|
+
#
|
1415
|
+
# <note markdown="1"> If `Atime` is set to BEST\_EFFORT, `Mtime` must be set to PRESERVE.
|
1416
|
+
#
|
1417
|
+
# If `Atime` is set to NONE, `Mtime` must also be NONE.
|
1418
|
+
#
|
1419
|
+
# </note>
|
1420
|
+
# @return [String]
|
1421
|
+
#
|
1422
|
+
# @!attribute [rw] mtime
|
1423
|
+
# A value that indicates the last time that a file was modified (that
|
1424
|
+
# is, a file was written to) before the PREPARING phase.
|
1425
|
+
#
|
1426
|
+
# Default value: PRESERVE.
|
1427
|
+
#
|
1428
|
+
# PRESERVE: Preserve original `Mtime` (recommended)
|
1429
|
+
#
|
1430
|
+
# NONE: Ignore `Mtime`.
|
1431
|
+
#
|
1432
|
+
# <note markdown="1"> If `Mtime` is set to PRESERVE, `Atime` must be set to BEST\_EFFORT.
|
1433
|
+
#
|
1434
|
+
# If `Mtime` is set to NONE, `Atime` must also be set to NONE.
|
1435
|
+
#
|
1436
|
+
# </note>
|
1437
|
+
# @return [String]
|
1438
|
+
#
|
1439
|
+
# @!attribute [rw] uid
|
1440
|
+
# The user ID (UID) of the file's owner.
|
1441
|
+
#
|
1442
|
+
# Default value: INT\_VALUE. This preserves the integer value of the
|
1443
|
+
# ID.
|
1444
|
+
#
|
1445
|
+
# INT\_VALUE: Preserve the integer value of UID and group ID (GID)
|
1446
|
+
# (recommended).
|
1447
|
+
#
|
1448
|
+
# NONE: Ignore UID and GID.
|
1449
|
+
# @return [String]
|
1450
|
+
#
|
1451
|
+
# @!attribute [rw] gid
|
1452
|
+
# The group ID (GID) of the file's owners.
|
1453
|
+
#
|
1454
|
+
# Default value: INT\_VALUE. This preserves the integer value of the
|
1455
|
+
# ID.
|
1456
|
+
#
|
1457
|
+
# INT\_VALUE: Preserve the integer value of user ID (UID) and GID
|
1458
|
+
# (recommended).
|
1459
|
+
#
|
1460
|
+
# NONE: Ignore UID and GID.
|
1461
|
+
# @return [String]
|
1462
|
+
#
|
1463
|
+
# @!attribute [rw] preserve_deleted_files
|
1464
|
+
# A value that specifies whether files in the destination that don't
|
1465
|
+
# exist in the source file system should be preserved.
|
1466
|
+
#
|
1467
|
+
# Default value: PRESERVE.
|
1468
|
+
#
|
1469
|
+
# PRESERVE: Ignore such destination files (recommended).
|
1470
|
+
#
|
1471
|
+
# REMOVE: Delete destination files that aren’t present in the source.
|
1472
|
+
# @return [String]
|
1473
|
+
#
|
1474
|
+
# @!attribute [rw] preserve_devices
|
1475
|
+
# A value that determines whether AWS DataSync should preserve the
|
1476
|
+
# metadata of block and character devices in the source file system,
|
1477
|
+
# and recreate the files with that device name and metadata on the
|
1478
|
+
# destination.
|
1479
|
+
#
|
1480
|
+
# <note markdown="1"> AWS DataSync can't sync the actual contents of such devices,
|
1481
|
+
# because they are nonterminal and don't return an end-of-file (EOF)
|
1482
|
+
# marker.
|
1483
|
+
#
|
1484
|
+
# </note>
|
1485
|
+
#
|
1486
|
+
# Default value: NONE.
|
1487
|
+
#
|
1488
|
+
# NONE: Ignore special devices (recommended).
|
1489
|
+
#
|
1490
|
+
# PRESERVE: Preserve character and block device metadata. This option
|
1491
|
+
# isn't currently supported for Amazon EFS.
|
1492
|
+
# @return [String]
|
1493
|
+
#
|
1494
|
+
# @!attribute [rw] posix_permissions
|
1495
|
+
# A value that determines which users or groups can access a file for
|
1496
|
+
# a specific purpose such as reading, writing, or execution of the
|
1497
|
+
# file.
|
1498
|
+
#
|
1499
|
+
# Default value: PRESERVE.
|
1500
|
+
#
|
1501
|
+
# PRESERVE: Preserve POSIX-style permissions (recommended).
|
1502
|
+
#
|
1503
|
+
# NONE: Ignore permissions.
|
1504
|
+
#
|
1505
|
+
# <note markdown="1"> AWS DataSync can preserve extant permissions of a source location.
|
1506
|
+
#
|
1507
|
+
# </note>
|
1508
|
+
# @return [String]
|
1509
|
+
#
|
1510
|
+
# @!attribute [rw] bytes_per_second
|
1511
|
+
# A value that limits the bandwidth used by AWS DataSync. For example,
|
1512
|
+
# if you want AWS DataSync to use a maximum of 1 MB, set this value to
|
1513
|
+
# `1048576` (`=1024*1024`).
|
1514
|
+
# @return [Integer]
|
1515
|
+
#
|
1516
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/Options AWS API Documentation
|
1517
|
+
#
|
1518
|
+
class Options < Struct.new(
|
1519
|
+
:verify_mode,
|
1520
|
+
:atime,
|
1521
|
+
:mtime,
|
1522
|
+
:uid,
|
1523
|
+
:gid,
|
1524
|
+
:preserve_deleted_files,
|
1525
|
+
:preserve_devices,
|
1526
|
+
:posix_permissions,
|
1527
|
+
:bytes_per_second)
|
1528
|
+
include Aws::Structure
|
1529
|
+
end
|
1530
|
+
|
1531
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1532
|
+
# Management (IAM) role that is used to access an Amazon S3 bucket. For
|
1533
|
+
# detailed information about using such a role, see [Components and
|
1534
|
+
# Terminology][1] in the *AWS DataSync User Guide*.
|
1535
|
+
#
|
1536
|
+
#
|
1537
|
+
#
|
1538
|
+
# [1]: https://alpha-aws-docs.aws.amazon.com/sync-service/latest/userguide/create-locations-cli.html#create-location-s3-cli
|
1539
|
+
#
|
1540
|
+
# @note When making an API call, you may pass S3Config
|
1541
|
+
# data as a hash:
|
1542
|
+
#
|
1543
|
+
# {
|
1544
|
+
# bucket_access_role_arn: "IamRoleArn", # required
|
1545
|
+
# }
|
1546
|
+
#
|
1547
|
+
# @!attribute [rw] bucket_access_role_arn
|
1548
|
+
# The Amazon S3 bucket to access. This bucket is used as a parameter
|
1549
|
+
# in the CreateLocationS3 operation.
|
1550
|
+
# @return [String]
|
1551
|
+
#
|
1552
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/S3Config AWS API Documentation
|
1553
|
+
#
|
1554
|
+
class S3Config < Struct.new(
|
1555
|
+
:bucket_access_role_arn)
|
1556
|
+
include Aws::Structure
|
1557
|
+
end
|
1558
|
+
|
1559
|
+
# StartTaskExecutionRequest
|
1560
|
+
#
|
1561
|
+
# @note When making an API call, you may pass StartTaskExecutionRequest
|
1562
|
+
# data as a hash:
|
1563
|
+
#
|
1564
|
+
# {
|
1565
|
+
# task_arn: "TaskArn", # required
|
1566
|
+
# override_options: {
|
1567
|
+
# verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, NONE
|
1568
|
+
# atime: "NONE", # accepts NONE, BEST_EFFORT
|
1569
|
+
# mtime: "NONE", # accepts NONE, PRESERVE
|
1570
|
+
# uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
|
1571
|
+
# gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
|
1572
|
+
# preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
|
1573
|
+
# preserve_devices: "NONE", # accepts NONE, PRESERVE
|
1574
|
+
# posix_permissions: "NONE", # accepts NONE, BEST_EFFORT, PRESERVE
|
1575
|
+
# bytes_per_second: 1,
|
1576
|
+
# },
|
1577
|
+
# }
|
1578
|
+
#
|
1579
|
+
# @!attribute [rw] task_arn
|
1580
|
+
# The Amazon Resource Name (ARN) of the task to start.
|
1581
|
+
# @return [String]
|
1582
|
+
#
|
1583
|
+
# @!attribute [rw] override_options
|
1584
|
+
# Represents the options that are available to control the behavior of
|
1585
|
+
# a StartTaskExecution operation. Behavior includes preserving
|
1586
|
+
# metadata such as user ID (UID), group ID (GID), and file
|
1587
|
+
# permissions, and also overwriting files in the destination, data
|
1588
|
+
# integrity verification, and so on.
|
1589
|
+
#
|
1590
|
+
# A task has a set of default options associated with it. If you
|
1591
|
+
# don't specify an option in StartTaskExecution, the default value is
|
1592
|
+
# used. You can override the defaults options on each task execution
|
1593
|
+
# by specifying an overriding `Options` value to StartTaskExecution.
|
1594
|
+
# @return [Types::Options]
|
1595
|
+
#
|
1596
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/StartTaskExecutionRequest AWS API Documentation
|
1597
|
+
#
|
1598
|
+
class StartTaskExecutionRequest < Struct.new(
|
1599
|
+
:task_arn,
|
1600
|
+
:override_options)
|
1601
|
+
include Aws::Structure
|
1602
|
+
end
|
1603
|
+
|
1604
|
+
# StartTaskExecutionResponse
|
1605
|
+
#
|
1606
|
+
# @!attribute [rw] task_execution_arn
|
1607
|
+
# The Amazon Resource Name (ARN) of the specific task execution that
|
1608
|
+
# was started.
|
1609
|
+
# @return [String]
|
1610
|
+
#
|
1611
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/StartTaskExecutionResponse AWS API Documentation
|
1612
|
+
#
|
1613
|
+
class StartTaskExecutionResponse < Struct.new(
|
1614
|
+
:task_execution_arn)
|
1615
|
+
include Aws::Structure
|
1616
|
+
end
|
1617
|
+
|
1618
|
+
# Represents a single entry in a list of AWS resource tags.
|
1619
|
+
# `TagListEntry` returns an array that contains a list of tasks when the
|
1620
|
+
# ListTagsForResource operation is called.
|
1621
|
+
#
|
1622
|
+
# @note When making an API call, you may pass TagListEntry
|
1623
|
+
# data as a hash:
|
1624
|
+
#
|
1625
|
+
# {
|
1626
|
+
# key: "TagKey",
|
1627
|
+
# value: "TagValue",
|
1628
|
+
# }
|
1629
|
+
#
|
1630
|
+
# @!attribute [rw] key
|
1631
|
+
# The key for an AWS resource tag.
|
1632
|
+
# @return [String]
|
1633
|
+
#
|
1634
|
+
# @!attribute [rw] value
|
1635
|
+
# The value for an AWS resource tag.
|
1636
|
+
# @return [String]
|
1637
|
+
#
|
1638
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TagListEntry AWS API Documentation
|
1639
|
+
#
|
1640
|
+
class TagListEntry < Struct.new(
|
1641
|
+
:key,
|
1642
|
+
:value)
|
1643
|
+
include Aws::Structure
|
1644
|
+
end
|
1645
|
+
|
1646
|
+
# TagResourceRequest
|
1647
|
+
#
|
1648
|
+
# @note When making an API call, you may pass TagResourceRequest
|
1649
|
+
# data as a hash:
|
1650
|
+
#
|
1651
|
+
# {
|
1652
|
+
# resource_arn: "TaggableResourceArn", # required
|
1653
|
+
# tags: [ # required
|
1654
|
+
# {
|
1655
|
+
# key: "TagKey",
|
1656
|
+
# value: "TagValue",
|
1657
|
+
# },
|
1658
|
+
# ],
|
1659
|
+
# }
|
1660
|
+
#
|
1661
|
+
# @!attribute [rw] resource_arn
|
1662
|
+
# The Amazon Resource Name (ARN) of the resource to apply the tag to.
|
1663
|
+
# @return [String]
|
1664
|
+
#
|
1665
|
+
# @!attribute [rw] tags
|
1666
|
+
# The tags to apply.
|
1667
|
+
# @return [Array<Types::TagListEntry>]
|
1668
|
+
#
|
1669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TagResourceRequest AWS API Documentation
|
1670
|
+
#
|
1671
|
+
class TagResourceRequest < Struct.new(
|
1672
|
+
:resource_arn,
|
1673
|
+
:tags)
|
1674
|
+
include Aws::Structure
|
1675
|
+
end
|
1676
|
+
|
1677
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TagResourceResponse AWS API Documentation
|
1678
|
+
#
|
1679
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
1680
|
+
|
1681
|
+
# Represents a single entry in a list of task executions.
|
1682
|
+
# `TaskExecutionListEntry` returns an array that contains a list of
|
1683
|
+
# specific invocations of a task when ListTaskExecutions operation is
|
1684
|
+
# called.
|
1685
|
+
#
|
1686
|
+
# @!attribute [rw] task_execution_arn
|
1687
|
+
# The Amazon Resource Name (ARN) of the task that was executed.
|
1688
|
+
# @return [String]
|
1689
|
+
#
|
1690
|
+
# @!attribute [rw] status
|
1691
|
+
# The status of a task execution.
|
1692
|
+
# @return [String]
|
1693
|
+
#
|
1694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskExecutionListEntry AWS API Documentation
|
1695
|
+
#
|
1696
|
+
class TaskExecutionListEntry < Struct.new(
|
1697
|
+
:task_execution_arn,
|
1698
|
+
:status)
|
1699
|
+
include Aws::Structure
|
1700
|
+
end
|
1701
|
+
|
1702
|
+
# Describes the detailed result of a `TaskExecution` operation. This
|
1703
|
+
# result includes the time in milliseconds spent in each phase, the
|
1704
|
+
# status of the task execution, and the errors encountered.
|
1705
|
+
#
|
1706
|
+
# @!attribute [rw] prepare_duration
|
1707
|
+
# The total time in milliseconds that AWS DataSync spent in the
|
1708
|
+
# PREPARING phase.
|
1709
|
+
# @return [Integer]
|
1710
|
+
#
|
1711
|
+
# @!attribute [rw] prepare_status
|
1712
|
+
# The status of the PREPARING phase.
|
1713
|
+
# @return [String]
|
1714
|
+
#
|
1715
|
+
# @!attribute [rw] transfer_duration
|
1716
|
+
# The total time in milliseconds that AWS DataSync spent in the
|
1717
|
+
# TRANSFERRING phase.
|
1718
|
+
# @return [Integer]
|
1719
|
+
#
|
1720
|
+
# @!attribute [rw] transfer_status
|
1721
|
+
# The status of the TRANSFERRING Phase.
|
1722
|
+
# @return [String]
|
1723
|
+
#
|
1724
|
+
# @!attribute [rw] verify_duration
|
1725
|
+
# The total time in milliseconds that AWS DataSync spent in the
|
1726
|
+
# VERIFYING phase.
|
1727
|
+
# @return [Integer]
|
1728
|
+
#
|
1729
|
+
# @!attribute [rw] verify_status
|
1730
|
+
# The status of the VERIFYING Phase.
|
1731
|
+
# @return [String]
|
1732
|
+
#
|
1733
|
+
# @!attribute [rw] error_code
|
1734
|
+
# Errors that AWS DataSync encountered during execution of the task.
|
1735
|
+
# You can use this error code to help troubleshoot issues.
|
1736
|
+
# @return [String]
|
1737
|
+
#
|
1738
|
+
# @!attribute [rw] error_detail
|
1739
|
+
# Detailed description of an error that was encountered during the
|
1740
|
+
# task execution. You can use this information to help troubleshoot
|
1741
|
+
# issues.
|
1742
|
+
# @return [String]
|
1743
|
+
#
|
1744
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskExecutionResultDetail AWS API Documentation
|
1745
|
+
#
|
1746
|
+
class TaskExecutionResultDetail < Struct.new(
|
1747
|
+
:prepare_duration,
|
1748
|
+
:prepare_status,
|
1749
|
+
:transfer_duration,
|
1750
|
+
:transfer_status,
|
1751
|
+
:verify_duration,
|
1752
|
+
:verify_status,
|
1753
|
+
:error_code,
|
1754
|
+
:error_detail)
|
1755
|
+
include Aws::Structure
|
1756
|
+
end
|
1757
|
+
|
1758
|
+
# Represents a single entry in a list of tasks. `TaskListEntry` returns
|
1759
|
+
# an array that contains a list of tasks when the ListTasks operation is
|
1760
|
+
# called. A task includes the source and destination file systems to
|
1761
|
+
# sync and the options to use for the tasks.
|
1762
|
+
#
|
1763
|
+
# @!attribute [rw] task_arn
|
1764
|
+
# The Amazon Resource Name (ARN) of the task.
|
1765
|
+
# @return [String]
|
1766
|
+
#
|
1767
|
+
# @!attribute [rw] status
|
1768
|
+
# The status of the task.
|
1769
|
+
# @return [String]
|
1770
|
+
#
|
1771
|
+
# @!attribute [rw] name
|
1772
|
+
# The name of the task.
|
1773
|
+
# @return [String]
|
1774
|
+
#
|
1775
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskListEntry AWS API Documentation
|
1776
|
+
#
|
1777
|
+
class TaskListEntry < Struct.new(
|
1778
|
+
:task_arn,
|
1779
|
+
:status,
|
1780
|
+
:name)
|
1781
|
+
include Aws::Structure
|
1782
|
+
end
|
1783
|
+
|
1784
|
+
# UntagResourceRequest
|
1785
|
+
#
|
1786
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
1787
|
+
# data as a hash:
|
1788
|
+
#
|
1789
|
+
# {
|
1790
|
+
# resource_arn: "TaggableResourceArn", # required
|
1791
|
+
# keys: ["TagKey"], # required
|
1792
|
+
# }
|
1793
|
+
#
|
1794
|
+
# @!attribute [rw] resource_arn
|
1795
|
+
# The Amazon Resource Name (ARN) of the resource to remove the tag
|
1796
|
+
# from.
|
1797
|
+
# @return [String]
|
1798
|
+
#
|
1799
|
+
# @!attribute [rw] keys
|
1800
|
+
# The keys in the key-value pair in the tag to remove.
|
1801
|
+
# @return [Array<String>]
|
1802
|
+
#
|
1803
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UntagResourceRequest AWS API Documentation
|
1804
|
+
#
|
1805
|
+
class UntagResourceRequest < Struct.new(
|
1806
|
+
:resource_arn,
|
1807
|
+
:keys)
|
1808
|
+
include Aws::Structure
|
1809
|
+
end
|
1810
|
+
|
1811
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UntagResourceResponse AWS API Documentation
|
1812
|
+
#
|
1813
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
1814
|
+
|
1815
|
+
# UpdateAgentRequest
|
1816
|
+
#
|
1817
|
+
# @note When making an API call, you may pass UpdateAgentRequest
|
1818
|
+
# data as a hash:
|
1819
|
+
#
|
1820
|
+
# {
|
1821
|
+
# agent_arn: "AgentArn", # required
|
1822
|
+
# name: "TagValue",
|
1823
|
+
# }
|
1824
|
+
#
|
1825
|
+
# @!attribute [rw] agent_arn
|
1826
|
+
# The Amazon Resource Name (ARN) of the agent to update.
|
1827
|
+
# @return [String]
|
1828
|
+
#
|
1829
|
+
# @!attribute [rw] name
|
1830
|
+
# The name that you want to use to configure the agent.
|
1831
|
+
# @return [String]
|
1832
|
+
#
|
1833
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateAgentRequest AWS API Documentation
|
1834
|
+
#
|
1835
|
+
class UpdateAgentRequest < Struct.new(
|
1836
|
+
:agent_arn,
|
1837
|
+
:name)
|
1838
|
+
include Aws::Structure
|
1839
|
+
end
|
1840
|
+
|
1841
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateAgentResponse AWS API Documentation
|
1842
|
+
#
|
1843
|
+
class UpdateAgentResponse < Aws::EmptyStructure; end
|
1844
|
+
|
1845
|
+
# UpdateTaskResponse
|
1846
|
+
#
|
1847
|
+
# @note When making an API call, you may pass UpdateTaskRequest
|
1848
|
+
# data as a hash:
|
1849
|
+
#
|
1850
|
+
# {
|
1851
|
+
# task_arn: "TaskArn", # required
|
1852
|
+
# options: {
|
1853
|
+
# verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, NONE
|
1854
|
+
# atime: "NONE", # accepts NONE, BEST_EFFORT
|
1855
|
+
# mtime: "NONE", # accepts NONE, PRESERVE
|
1856
|
+
# uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
|
1857
|
+
# gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
|
1858
|
+
# preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
|
1859
|
+
# preserve_devices: "NONE", # accepts NONE, PRESERVE
|
1860
|
+
# posix_permissions: "NONE", # accepts NONE, BEST_EFFORT, PRESERVE
|
1861
|
+
# bytes_per_second: 1,
|
1862
|
+
# },
|
1863
|
+
# name: "TagValue",
|
1864
|
+
# }
|
1865
|
+
#
|
1866
|
+
# @!attribute [rw] task_arn
|
1867
|
+
# The Amazon Resource Name (ARN) of the resource name of the task to
|
1868
|
+
# update.
|
1869
|
+
# @return [String]
|
1870
|
+
#
|
1871
|
+
# @!attribute [rw] options
|
1872
|
+
# Represents the options that are available to control the behavior of
|
1873
|
+
# a StartTaskExecution operation. Behavior includes preserving
|
1874
|
+
# metadata such as user ID (UID), group ID (GID), and file
|
1875
|
+
# permissions, and also overwriting files in the destination, data
|
1876
|
+
# integrity verification, and so on.
|
1877
|
+
#
|
1878
|
+
# A task has a set of default options associated with it. If you
|
1879
|
+
# don't specify an option in StartTaskExecution, the default value is
|
1880
|
+
# used. You can override the defaults options on each task execution
|
1881
|
+
# by specifying an overriding `Options` value to StartTaskExecution.
|
1882
|
+
# @return [Types::Options]
|
1883
|
+
#
|
1884
|
+
# @!attribute [rw] name
|
1885
|
+
# The name of the task to update.
|
1886
|
+
# @return [String]
|
1887
|
+
#
|
1888
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskRequest AWS API Documentation
|
1889
|
+
#
|
1890
|
+
class UpdateTaskRequest < Struct.new(
|
1891
|
+
:task_arn,
|
1892
|
+
:options,
|
1893
|
+
:name)
|
1894
|
+
include Aws::Structure
|
1895
|
+
end
|
1896
|
+
|
1897
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskResponse AWS API Documentation
|
1898
|
+
#
|
1899
|
+
class UpdateTaskResponse < Aws::EmptyStructure; end
|
1900
|
+
|
1901
|
+
end
|
1902
|
+
end
|