aws-sdk-storagegateway 1.0.0.rc1
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-storagegateway.rb +47 -0
- data/lib/aws-sdk-storagegateway/client.rb +2441 -0
- data/lib/aws-sdk-storagegateway/client_api.rb +1465 -0
- data/lib/aws-sdk-storagegateway/customizations.rb +7 -0
- data/lib/aws-sdk-storagegateway/errors.rb +23 -0
- data/lib/aws-sdk-storagegateway/resource.rb +25 -0
- data/lib/aws-sdk-storagegateway/types.rb +2909 -0
- metadata +80 -0
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module StorageGateway
|
10
|
+
module Errors
|
11
|
+
|
12
|
+
extend Aws::Errors::DynamicErrors
|
13
|
+
|
14
|
+
# Raised when calling #load or #data on a resource class that can not be
|
15
|
+
# loaded. This can happen when:
|
16
|
+
#
|
17
|
+
# * A resource class has identifiers, but no data attributes.
|
18
|
+
# * Resource data is only available when making an API call that
|
19
|
+
# enumerates all resources of that type.
|
20
|
+
class ResourceNotLoadable < RuntimeError; end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module StorageGateway
|
10
|
+
class Resource
|
11
|
+
|
12
|
+
# @param options ({})
|
13
|
+
# @option options [Client] :client
|
14
|
+
def initialize(options = {})
|
15
|
+
@client = options[:client] || Client.new(options)
|
16
|
+
end
|
17
|
+
|
18
|
+
# @return [Client]
|
19
|
+
def client
|
20
|
+
@client
|
21
|
+
end
|
22
|
+
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,2909 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module StorageGateway
|
10
|
+
module Types
|
11
|
+
|
12
|
+
# A JSON object containing one or more of the following fields:
|
13
|
+
#
|
14
|
+
# * ActivateGatewayInput$ActivationKey
|
15
|
+
#
|
16
|
+
# * ActivateGatewayInput$GatewayName
|
17
|
+
#
|
18
|
+
# * ActivateGatewayInput$GatewayRegion
|
19
|
+
#
|
20
|
+
# * ActivateGatewayInput$GatewayTimezone
|
21
|
+
#
|
22
|
+
# * ActivateGatewayInput$GatewayType
|
23
|
+
#
|
24
|
+
# * ActivateGatewayInput$TapeDriveType
|
25
|
+
#
|
26
|
+
# * ActivateGatewayInput$MediumChangerType
|
27
|
+
# @note When making an API call, pass ActivateGatewayInput
|
28
|
+
# data as a hash:
|
29
|
+
#
|
30
|
+
# {
|
31
|
+
# activation_key: "ActivationKey", # required
|
32
|
+
# gateway_name: "GatewayName", # required
|
33
|
+
# gateway_timezone: "GatewayTimezone", # required
|
34
|
+
# gateway_region: "RegionId", # required
|
35
|
+
# gateway_type: "GatewayType",
|
36
|
+
# tape_drive_type: "TapeDriveType",
|
37
|
+
# medium_changer_type: "MediumChangerType",
|
38
|
+
# }
|
39
|
+
# @!attribute [rw] activation_key
|
40
|
+
# Your gateway activation key. You can obtain the activation key by
|
41
|
+
# sending an HTTP GET request with redirects enabled to the gateway IP
|
42
|
+
# address (port 80). The redirect URL returned in the response
|
43
|
+
# provides you the activation key for your gateway in the query string
|
44
|
+
# parameter `activationKey`. It may also include other
|
45
|
+
# activation-related parameters, however, these are merely defaults --
|
46
|
+
# the arguments you pass to the `ActivateGateway` API call determine
|
47
|
+
# the actual configuration of your gateway.
|
48
|
+
# @return [String]
|
49
|
+
#
|
50
|
+
# @!attribute [rw] gateway_name
|
51
|
+
# The name you configured for your gateway.
|
52
|
+
# @return [String]
|
53
|
+
#
|
54
|
+
# @!attribute [rw] gateway_timezone
|
55
|
+
# A value that indicates the time zone you want to set for the
|
56
|
+
# gateway. The time zone is used, for example, for scheduling
|
57
|
+
# snapshots and your gateway's maintenance schedule.
|
58
|
+
# @return [String]
|
59
|
+
#
|
60
|
+
# @!attribute [rw] gateway_region
|
61
|
+
# A value that indicates the region where you want to store the
|
62
|
+
# snapshot backups. The gateway region specified must be the same
|
63
|
+
# region as the region in your `Host` header in the request. For more
|
64
|
+
# information about available regions and endpoints for AWS Storage
|
65
|
+
# Gateway, see [Regions and Endpoints][1] in the *Amazon Web Services
|
66
|
+
# Glossary*.
|
67
|
+
#
|
68
|
+
# Valid Values: "us-east-1", "us-west-1", "us-west-2",
|
69
|
+
# "eu-west-1", "eu-central-1", "ap-northeast-1",
|
70
|
+
# "ap-northeast-2", "ap-southeast-1", "ap-southeast-2",
|
71
|
+
# "sa-east-1"
|
72
|
+
#
|
73
|
+
#
|
74
|
+
#
|
75
|
+
# [1]: http://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region
|
76
|
+
# @return [String]
|
77
|
+
#
|
78
|
+
# @!attribute [rw] gateway_type
|
79
|
+
# A value that defines the type of gateway to activate. The type
|
80
|
+
# specified is critical to all later functions of the gateway and
|
81
|
+
# cannot be changed after activation. The default value is `STORED`.
|
82
|
+
# @return [String]
|
83
|
+
#
|
84
|
+
# @!attribute [rw] tape_drive_type
|
85
|
+
# The value that indicates the type of tape drive to use for
|
86
|
+
# gateway-VTL. This field is optional.
|
87
|
+
#
|
88
|
+
# Valid Values: "IBM-ULT3580-TD5"
|
89
|
+
# @return [String]
|
90
|
+
#
|
91
|
+
# @!attribute [rw] medium_changer_type
|
92
|
+
# The value that indicates the type of medium changer to use for
|
93
|
+
# gateway-VTL. This field is optional.
|
94
|
+
#
|
95
|
+
# Valid Values: "STK-L700", "AWS-Gateway-VTL"
|
96
|
+
# @return [String]
|
97
|
+
class ActivateGatewayInput < Struct.new(
|
98
|
+
:activation_key,
|
99
|
+
:gateway_name,
|
100
|
+
:gateway_timezone,
|
101
|
+
:gateway_region,
|
102
|
+
:gateway_type,
|
103
|
+
:tape_drive_type,
|
104
|
+
:medium_changer_type)
|
105
|
+
include Aws::Structure
|
106
|
+
end
|
107
|
+
|
108
|
+
# AWS Storage Gateway returns the Amazon Resource Name (ARN) of the
|
109
|
+
# activated gateway. It is a string made of information such as your
|
110
|
+
# account, gateway name, and region. This ARN is used to reference the
|
111
|
+
# gateway in other API operations as well as resource-based
|
112
|
+
# authorization.
|
113
|
+
#
|
114
|
+
# <note markdown="1">For gateways activated prior to September 02, 2015 the gateway ARN
|
115
|
+
# contains the gateway name rather than the gateway id. Changing the
|
116
|
+
# name of the gateway has no effect on the gateway ARN.
|
117
|
+
#
|
118
|
+
# </note>
|
119
|
+
# @!attribute [rw] gateway_arn
|
120
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
121
|
+
# operation to return a list of gateways for your account and region.
|
122
|
+
# @return [String]
|
123
|
+
class ActivateGatewayOutput < Struct.new(
|
124
|
+
:gateway_arn)
|
125
|
+
include Aws::Structure
|
126
|
+
end
|
127
|
+
|
128
|
+
# @note When making an API call, pass AddCacheInput
|
129
|
+
# data as a hash:
|
130
|
+
#
|
131
|
+
# {
|
132
|
+
# gateway_arn: "GatewayARN", # required
|
133
|
+
# disk_ids: ["DiskId"], # required
|
134
|
+
# }
|
135
|
+
# @!attribute [rw] gateway_arn
|
136
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
137
|
+
# operation to return a list of gateways for your account and region.
|
138
|
+
# @return [String]
|
139
|
+
#
|
140
|
+
# @!attribute [rw] disk_ids
|
141
|
+
# @return [Array<String>]
|
142
|
+
class AddCacheInput < Struct.new(
|
143
|
+
:gateway_arn,
|
144
|
+
:disk_ids)
|
145
|
+
include Aws::Structure
|
146
|
+
end
|
147
|
+
|
148
|
+
# @!attribute [rw] gateway_arn
|
149
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
150
|
+
# operation to return a list of gateways for your account and region.
|
151
|
+
# @return [String]
|
152
|
+
class AddCacheOutput < Struct.new(
|
153
|
+
:gateway_arn)
|
154
|
+
include Aws::Structure
|
155
|
+
end
|
156
|
+
|
157
|
+
# AddTagsToResourceInput
|
158
|
+
# @note When making an API call, pass AddTagsToResourceInput
|
159
|
+
# data as a hash:
|
160
|
+
#
|
161
|
+
# {
|
162
|
+
# resource_arn: "ResourceARN", # required
|
163
|
+
# tags: [ # required
|
164
|
+
# {
|
165
|
+
# key: "TagKey", # required
|
166
|
+
# value: "TagValue", # required
|
167
|
+
# },
|
168
|
+
# ],
|
169
|
+
# }
|
170
|
+
# @!attribute [rw] resource_arn
|
171
|
+
# The Amazon Resource Name (ARN) of the resource you want to add tags
|
172
|
+
# to.
|
173
|
+
# @return [String]
|
174
|
+
#
|
175
|
+
# @!attribute [rw] tags
|
176
|
+
# The key-value pair that represents the tag you want to add to the
|
177
|
+
# resource. The value can be an empty string.
|
178
|
+
#
|
179
|
+
# <note markdown="1"> Valid characters for key and value are letters, spaces, and numbers
|
180
|
+
# representable in UTF-8 format, and the following special characters:
|
181
|
+
# + - = . \_ : / @.
|
182
|
+
#
|
183
|
+
# </note>
|
184
|
+
# @return [Array<Types::Tag>]
|
185
|
+
class AddTagsToResourceInput < Struct.new(
|
186
|
+
:resource_arn,
|
187
|
+
:tags)
|
188
|
+
include Aws::Structure
|
189
|
+
end
|
190
|
+
|
191
|
+
# AddTagsToResourceOutput
|
192
|
+
# @!attribute [rw] resource_arn
|
193
|
+
# The Amazon Resource Name (ARN) of the resource you want to add tags
|
194
|
+
# to.
|
195
|
+
# @return [String]
|
196
|
+
class AddTagsToResourceOutput < Struct.new(
|
197
|
+
:resource_arn)
|
198
|
+
include Aws::Structure
|
199
|
+
end
|
200
|
+
|
201
|
+
# @note When making an API call, pass AddUploadBufferInput
|
202
|
+
# data as a hash:
|
203
|
+
#
|
204
|
+
# {
|
205
|
+
# gateway_arn: "GatewayARN", # required
|
206
|
+
# disk_ids: ["DiskId"], # required
|
207
|
+
# }
|
208
|
+
# @!attribute [rw] gateway_arn
|
209
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
210
|
+
# operation to return a list of gateways for your account and region.
|
211
|
+
# @return [String]
|
212
|
+
#
|
213
|
+
# @!attribute [rw] disk_ids
|
214
|
+
# @return [Array<String>]
|
215
|
+
class AddUploadBufferInput < Struct.new(
|
216
|
+
:gateway_arn,
|
217
|
+
:disk_ids)
|
218
|
+
include Aws::Structure
|
219
|
+
end
|
220
|
+
|
221
|
+
# @!attribute [rw] gateway_arn
|
222
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
223
|
+
# operation to return a list of gateways for your account and region.
|
224
|
+
# @return [String]
|
225
|
+
class AddUploadBufferOutput < Struct.new(
|
226
|
+
:gateway_arn)
|
227
|
+
include Aws::Structure
|
228
|
+
end
|
229
|
+
|
230
|
+
# A JSON object containing one or more of the following fields:
|
231
|
+
#
|
232
|
+
# * AddWorkingStorageInput$DiskIds
|
233
|
+
#
|
234
|
+
# ^
|
235
|
+
# @note When making an API call, pass AddWorkingStorageInput
|
236
|
+
# data as a hash:
|
237
|
+
#
|
238
|
+
# {
|
239
|
+
# gateway_arn: "GatewayARN", # required
|
240
|
+
# disk_ids: ["DiskId"], # required
|
241
|
+
# }
|
242
|
+
# @!attribute [rw] gateway_arn
|
243
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
244
|
+
# operation to return a list of gateways for your account and region.
|
245
|
+
# @return [String]
|
246
|
+
#
|
247
|
+
# @!attribute [rw] disk_ids
|
248
|
+
# An array of strings that identify disks that are to be configured as
|
249
|
+
# working storage. Each string have a minimum length of 1 and maximum
|
250
|
+
# length of 300. You can get the disk IDs from the ListLocalDisks API.
|
251
|
+
# @return [Array<String>]
|
252
|
+
class AddWorkingStorageInput < Struct.new(
|
253
|
+
:gateway_arn,
|
254
|
+
:disk_ids)
|
255
|
+
include Aws::Structure
|
256
|
+
end
|
257
|
+
|
258
|
+
# A JSON object containing the of the gateway for which working storage
|
259
|
+
# was configured.
|
260
|
+
# @!attribute [rw] gateway_arn
|
261
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
262
|
+
# operation to return a list of gateways for your account and region.
|
263
|
+
# @return [String]
|
264
|
+
class AddWorkingStorageOutput < Struct.new(
|
265
|
+
:gateway_arn)
|
266
|
+
include Aws::Structure
|
267
|
+
end
|
268
|
+
|
269
|
+
# @!attribute [rw] volume_arn
|
270
|
+
# @return [String]
|
271
|
+
#
|
272
|
+
# @!attribute [rw] volume_id
|
273
|
+
# @return [String]
|
274
|
+
#
|
275
|
+
# @!attribute [rw] volume_type
|
276
|
+
# @return [String]
|
277
|
+
#
|
278
|
+
# @!attribute [rw] volume_status
|
279
|
+
# @return [String]
|
280
|
+
#
|
281
|
+
# @!attribute [rw] volume_size_in_bytes
|
282
|
+
# @return [Integer]
|
283
|
+
#
|
284
|
+
# @!attribute [rw] volume_progress
|
285
|
+
# @return [Float]
|
286
|
+
#
|
287
|
+
# @!attribute [rw] source_snapshot_id
|
288
|
+
# @return [String]
|
289
|
+
#
|
290
|
+
# @!attribute [rw] volume_iscsi_attributes
|
291
|
+
# Lists iSCSI information about a volume.
|
292
|
+
# @return [Types::VolumeiSCSIAttributes]
|
293
|
+
class CachediSCSIVolume < Struct.new(
|
294
|
+
:volume_arn,
|
295
|
+
:volume_id,
|
296
|
+
:volume_type,
|
297
|
+
:volume_status,
|
298
|
+
:volume_size_in_bytes,
|
299
|
+
:volume_progress,
|
300
|
+
:source_snapshot_id,
|
301
|
+
:volume_iscsi_attributes)
|
302
|
+
include Aws::Structure
|
303
|
+
end
|
304
|
+
|
305
|
+
# CancelArchivalInput
|
306
|
+
# @note When making an API call, pass CancelArchivalInput
|
307
|
+
# data as a hash:
|
308
|
+
#
|
309
|
+
# {
|
310
|
+
# gateway_arn: "GatewayARN", # required
|
311
|
+
# tape_arn: "TapeARN", # required
|
312
|
+
# }
|
313
|
+
# @!attribute [rw] gateway_arn
|
314
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
315
|
+
# operation to return a list of gateways for your account and region.
|
316
|
+
# @return [String]
|
317
|
+
#
|
318
|
+
# @!attribute [rw] tape_arn
|
319
|
+
# The Amazon Resource Name (ARN) of the virtual tape you want to
|
320
|
+
# cancel archiving for.
|
321
|
+
# @return [String]
|
322
|
+
class CancelArchivalInput < Struct.new(
|
323
|
+
:gateway_arn,
|
324
|
+
:tape_arn)
|
325
|
+
include Aws::Structure
|
326
|
+
end
|
327
|
+
|
328
|
+
# CancelArchivalOutput
|
329
|
+
# @!attribute [rw] tape_arn
|
330
|
+
# The Amazon Resource Name (ARN) of the virtual tape for which
|
331
|
+
# archiving was canceled.
|
332
|
+
# @return [String]
|
333
|
+
class CancelArchivalOutput < Struct.new(
|
334
|
+
:tape_arn)
|
335
|
+
include Aws::Structure
|
336
|
+
end
|
337
|
+
|
338
|
+
# CancelRetrievalInput
|
339
|
+
# @note When making an API call, pass CancelRetrievalInput
|
340
|
+
# data as a hash:
|
341
|
+
#
|
342
|
+
# {
|
343
|
+
# gateway_arn: "GatewayARN", # required
|
344
|
+
# tape_arn: "TapeARN", # required
|
345
|
+
# }
|
346
|
+
# @!attribute [rw] gateway_arn
|
347
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
348
|
+
# operation to return a list of gateways for your account and region.
|
349
|
+
# @return [String]
|
350
|
+
#
|
351
|
+
# @!attribute [rw] tape_arn
|
352
|
+
# The Amazon Resource Name (ARN) of the virtual tape you want to
|
353
|
+
# cancel retrieval for.
|
354
|
+
# @return [String]
|
355
|
+
class CancelRetrievalInput < Struct.new(
|
356
|
+
:gateway_arn,
|
357
|
+
:tape_arn)
|
358
|
+
include Aws::Structure
|
359
|
+
end
|
360
|
+
|
361
|
+
# CancelRetrievalOutput
|
362
|
+
# @!attribute [rw] tape_arn
|
363
|
+
# The Amazon Resource Name (ARN) of the virtual tape for which
|
364
|
+
# retrieval was canceled.
|
365
|
+
# @return [String]
|
366
|
+
class CancelRetrievalOutput < Struct.new(
|
367
|
+
:tape_arn)
|
368
|
+
include Aws::Structure
|
369
|
+
end
|
370
|
+
|
371
|
+
# Describes Challenge-Handshake Authentication Protocol (CHAP)
|
372
|
+
# information that supports authentication between your gateway and
|
373
|
+
# iSCSI initiators.
|
374
|
+
# @!attribute [rw] target_arn
|
375
|
+
# The Amazon Resource Name (ARN) of the volume.
|
376
|
+
#
|
377
|
+
# Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and
|
378
|
+
# hyphens (-).
|
379
|
+
# @return [String]
|
380
|
+
#
|
381
|
+
# @!attribute [rw] secret_to_authenticate_initiator
|
382
|
+
# The secret key that the initiator (for example, the Windows client)
|
383
|
+
# must provide to participate in mutual CHAP with the target.
|
384
|
+
# @return [String]
|
385
|
+
#
|
386
|
+
# @!attribute [rw] initiator_name
|
387
|
+
# The iSCSI initiator that connects to the target.
|
388
|
+
# @return [String]
|
389
|
+
#
|
390
|
+
# @!attribute [rw] secret_to_authenticate_target
|
391
|
+
# The secret key that the target must provide to participate in mutual
|
392
|
+
# CHAP with the initiator (e.g. Windows client).
|
393
|
+
# @return [String]
|
394
|
+
class ChapInfo < Struct.new(
|
395
|
+
:target_arn,
|
396
|
+
:secret_to_authenticate_initiator,
|
397
|
+
:initiator_name,
|
398
|
+
:secret_to_authenticate_target)
|
399
|
+
include Aws::Structure
|
400
|
+
end
|
401
|
+
|
402
|
+
# @note When making an API call, pass CreateCachediSCSIVolumeInput
|
403
|
+
# data as a hash:
|
404
|
+
#
|
405
|
+
# {
|
406
|
+
# gateway_arn: "GatewayARN", # required
|
407
|
+
# volume_size_in_bytes: 1, # required
|
408
|
+
# snapshot_id: "SnapshotId",
|
409
|
+
# target_name: "TargetName", # required
|
410
|
+
# network_interface_id: "NetworkInterfaceId", # required
|
411
|
+
# client_token: "ClientToken", # required
|
412
|
+
# }
|
413
|
+
# @!attribute [rw] gateway_arn
|
414
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
415
|
+
# operation to return a list of gateways for your account and region.
|
416
|
+
# @return [String]
|
417
|
+
#
|
418
|
+
# @!attribute [rw] volume_size_in_bytes
|
419
|
+
# @return [Integer]
|
420
|
+
#
|
421
|
+
# @!attribute [rw] snapshot_id
|
422
|
+
# @return [String]
|
423
|
+
#
|
424
|
+
# @!attribute [rw] target_name
|
425
|
+
# @return [String]
|
426
|
+
#
|
427
|
+
# @!attribute [rw] network_interface_id
|
428
|
+
# @return [String]
|
429
|
+
#
|
430
|
+
# @!attribute [rw] client_token
|
431
|
+
# @return [String]
|
432
|
+
class CreateCachediSCSIVolumeInput < Struct.new(
|
433
|
+
:gateway_arn,
|
434
|
+
:volume_size_in_bytes,
|
435
|
+
:snapshot_id,
|
436
|
+
:target_name,
|
437
|
+
:network_interface_id,
|
438
|
+
:client_token)
|
439
|
+
include Aws::Structure
|
440
|
+
end
|
441
|
+
|
442
|
+
# @!attribute [rw] volume_arn
|
443
|
+
# @return [String]
|
444
|
+
#
|
445
|
+
# @!attribute [rw] target_arn
|
446
|
+
# @return [String]
|
447
|
+
class CreateCachediSCSIVolumeOutput < Struct.new(
|
448
|
+
:volume_arn,
|
449
|
+
:target_arn)
|
450
|
+
include Aws::Structure
|
451
|
+
end
|
452
|
+
|
453
|
+
# @note When making an API call, pass CreateSnapshotFromVolumeRecoveryPointInput
|
454
|
+
# data as a hash:
|
455
|
+
#
|
456
|
+
# {
|
457
|
+
# volume_arn: "VolumeARN", # required
|
458
|
+
# snapshot_description: "SnapshotDescription", # required
|
459
|
+
# }
|
460
|
+
# @!attribute [rw] volume_arn
|
461
|
+
# @return [String]
|
462
|
+
#
|
463
|
+
# @!attribute [rw] snapshot_description
|
464
|
+
# @return [String]
|
465
|
+
class CreateSnapshotFromVolumeRecoveryPointInput < Struct.new(
|
466
|
+
:volume_arn,
|
467
|
+
:snapshot_description)
|
468
|
+
include Aws::Structure
|
469
|
+
end
|
470
|
+
|
471
|
+
# @!attribute [rw] snapshot_id
|
472
|
+
# @return [String]
|
473
|
+
#
|
474
|
+
# @!attribute [rw] volume_arn
|
475
|
+
# @return [String]
|
476
|
+
#
|
477
|
+
# @!attribute [rw] volume_recovery_point_time
|
478
|
+
# @return [String]
|
479
|
+
class CreateSnapshotFromVolumeRecoveryPointOutput < Struct.new(
|
480
|
+
:snapshot_id,
|
481
|
+
:volume_arn,
|
482
|
+
:volume_recovery_point_time)
|
483
|
+
include Aws::Structure
|
484
|
+
end
|
485
|
+
|
486
|
+
# A JSON object containing one or more of the following fields:
|
487
|
+
#
|
488
|
+
# * CreateSnapshotInput$SnapshotDescription
|
489
|
+
#
|
490
|
+
# * CreateSnapshotInput$VolumeARN
|
491
|
+
# @note When making an API call, pass CreateSnapshotInput
|
492
|
+
# data as a hash:
|
493
|
+
#
|
494
|
+
# {
|
495
|
+
# volume_arn: "VolumeARN", # required
|
496
|
+
# snapshot_description: "SnapshotDescription", # required
|
497
|
+
# }
|
498
|
+
# @!attribute [rw] volume_arn
|
499
|
+
# The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
|
500
|
+
# operation to return a list of gateway volumes.
|
501
|
+
# @return [String]
|
502
|
+
#
|
503
|
+
# @!attribute [rw] snapshot_description
|
504
|
+
# Textual description of the snapshot that appears in the Amazon EC2
|
505
|
+
# console, Elastic Block Store snapshots panel in the **Description**
|
506
|
+
# field, and in the AWS Storage Gateway snapshot **Details** pane,
|
507
|
+
# **Description** field
|
508
|
+
# @return [String]
|
509
|
+
class CreateSnapshotInput < Struct.new(
|
510
|
+
:volume_arn,
|
511
|
+
:snapshot_description)
|
512
|
+
include Aws::Structure
|
513
|
+
end
|
514
|
+
|
515
|
+
# A JSON object containing the following fields:
|
516
|
+
# @!attribute [rw] volume_arn
|
517
|
+
# The Amazon Resource Name (ARN) of the volume of which the snapshot
|
518
|
+
# was taken.
|
519
|
+
# @return [String]
|
520
|
+
#
|
521
|
+
# @!attribute [rw] snapshot_id
|
522
|
+
# The snapshot ID that is used to refer to the snapshot in future
|
523
|
+
# operations such as describing snapshots (Amazon Elastic Compute
|
524
|
+
# Cloud API `DescribeSnapshots`) or creating a volume from a snapshot
|
525
|
+
# (CreateStorediSCSIVolume).
|
526
|
+
# @return [String]
|
527
|
+
class CreateSnapshotOutput < Struct.new(
|
528
|
+
:volume_arn,
|
529
|
+
:snapshot_id)
|
530
|
+
include Aws::Structure
|
531
|
+
end
|
532
|
+
|
533
|
+
# A JSON object containing one or more of the following fields:
|
534
|
+
#
|
535
|
+
# * CreateStorediSCSIVolumeInput$DiskId
|
536
|
+
#
|
537
|
+
# * CreateStorediSCSIVolumeInput$NetworkInterfaceId
|
538
|
+
#
|
539
|
+
# * CreateStorediSCSIVolumeInput$PreserveExistingData
|
540
|
+
#
|
541
|
+
# * CreateStorediSCSIVolumeInput$SnapshotId
|
542
|
+
#
|
543
|
+
# * CreateStorediSCSIVolumeInput$TargetName
|
544
|
+
# @note When making an API call, pass CreateStorediSCSIVolumeInput
|
545
|
+
# data as a hash:
|
546
|
+
#
|
547
|
+
# {
|
548
|
+
# gateway_arn: "GatewayARN", # required
|
549
|
+
# disk_id: "DiskId", # required
|
550
|
+
# snapshot_id: "SnapshotId",
|
551
|
+
# preserve_existing_data: false, # required
|
552
|
+
# target_name: "TargetName", # required
|
553
|
+
# network_interface_id: "NetworkInterfaceId", # required
|
554
|
+
# }
|
555
|
+
# @!attribute [rw] gateway_arn
|
556
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
557
|
+
# operation to return a list of gateways for your account and region.
|
558
|
+
# @return [String]
|
559
|
+
#
|
560
|
+
# @!attribute [rw] disk_id
|
561
|
+
# The unique identifier for the gateway local disk that is configured
|
562
|
+
# as a stored volume. Use [ListLocalDisks][1] to list disk IDs for a
|
563
|
+
# gateway.
|
564
|
+
#
|
565
|
+
#
|
566
|
+
#
|
567
|
+
# [1]: http://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html
|
568
|
+
# @return [String]
|
569
|
+
#
|
570
|
+
# @!attribute [rw] snapshot_id
|
571
|
+
# The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore
|
572
|
+
# as the new stored volume. Specify this field if you want to create
|
573
|
+
# the iSCSI storage volume from a snapshot otherwise do not include
|
574
|
+
# this field. To list snapshots for your account use
|
575
|
+
# [DescribeSnapshots][1] in the *Amazon Elastic Compute Cloud API
|
576
|
+
# Reference*.
|
577
|
+
#
|
578
|
+
#
|
579
|
+
#
|
580
|
+
# [1]: http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html
|
581
|
+
# @return [String]
|
582
|
+
#
|
583
|
+
# @!attribute [rw] preserve_existing_data
|
584
|
+
# Specify this field as true if you want to preserve the data on the
|
585
|
+
# local disk. Otherwise, specifying this field as false creates an
|
586
|
+
# empty volume.
|
587
|
+
#
|
588
|
+
# Valid Values: true, false
|
589
|
+
# @return [Boolean]
|
590
|
+
#
|
591
|
+
# @!attribute [rw] target_name
|
592
|
+
# The name of the iSCSI target used by initiators to connect to the
|
593
|
+
# target and as a suffix for the target ARN. For example, specifying
|
594
|
+
# `TargetName` as *myvolume* results in the target ARN of
|
595
|
+
# arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.
|
596
|
+
# The target name must be unique across all volumes of a gateway.
|
597
|
+
# @return [String]
|
598
|
+
#
|
599
|
+
# @!attribute [rw] network_interface_id
|
600
|
+
# The network interface of the gateway on which to expose the iSCSI
|
601
|
+
# target. Only IPv4 addresses are accepted. Use
|
602
|
+
# DescribeGatewayInformation to get a list of the network interfaces
|
603
|
+
# available on a gateway.
|
604
|
+
#
|
605
|
+
# Valid Values: A valid IP address.
|
606
|
+
# @return [String]
|
607
|
+
class CreateStorediSCSIVolumeInput < Struct.new(
|
608
|
+
:gateway_arn,
|
609
|
+
:disk_id,
|
610
|
+
:snapshot_id,
|
611
|
+
:preserve_existing_data,
|
612
|
+
:target_name,
|
613
|
+
:network_interface_id)
|
614
|
+
include Aws::Structure
|
615
|
+
end
|
616
|
+
|
617
|
+
# A JSON object containing the following fields:
|
618
|
+
# @!attribute [rw] volume_arn
|
619
|
+
# The Amazon Resource Name (ARN) of the configured volume.
|
620
|
+
# @return [String]
|
621
|
+
#
|
622
|
+
# @!attribute [rw] volume_size_in_bytes
|
623
|
+
# The size of the volume in bytes.
|
624
|
+
# @return [Integer]
|
625
|
+
#
|
626
|
+
# @!attribute [rw] target_arn
|
627
|
+
# he Amazon Resource Name (ARN) of the volume target that includes the
|
628
|
+
# iSCSI name that initiators can use to connect to the target.
|
629
|
+
# @return [String]
|
630
|
+
class CreateStorediSCSIVolumeOutput < Struct.new(
|
631
|
+
:volume_arn,
|
632
|
+
:volume_size_in_bytes,
|
633
|
+
:target_arn)
|
634
|
+
include Aws::Structure
|
635
|
+
end
|
636
|
+
|
637
|
+
# CreateTapeWithBarcodeInput
|
638
|
+
# @note When making an API call, pass CreateTapeWithBarcodeInput
|
639
|
+
# data as a hash:
|
640
|
+
#
|
641
|
+
# {
|
642
|
+
# gateway_arn: "GatewayARN", # required
|
643
|
+
# tape_size_in_bytes: 1, # required
|
644
|
+
# tape_barcode: "TapeBarcode", # required
|
645
|
+
# }
|
646
|
+
# @!attribute [rw] gateway_arn
|
647
|
+
# The unique Amazon Resource Name (ARN) that represents the gateway to
|
648
|
+
# associate the virtual tape with. Use the ListGateways operation to
|
649
|
+
# return a list of gateways for your account and region.
|
650
|
+
# @return [String]
|
651
|
+
#
|
652
|
+
# @!attribute [rw] tape_size_in_bytes
|
653
|
+
# The size, in bytes, of the virtual tape that you want to create.
|
654
|
+
#
|
655
|
+
# <note markdown="1">The size must be aligned by gigabyte (1024*1024*1024 byte).
|
656
|
+
#
|
657
|
+
# </note>
|
658
|
+
# @return [Integer]
|
659
|
+
#
|
660
|
+
# @!attribute [rw] tape_barcode
|
661
|
+
# The barcode that you want to assign to the tape.
|
662
|
+
# @return [String]
|
663
|
+
class CreateTapeWithBarcodeInput < Struct.new(
|
664
|
+
:gateway_arn,
|
665
|
+
:tape_size_in_bytes,
|
666
|
+
:tape_barcode)
|
667
|
+
include Aws::Structure
|
668
|
+
end
|
669
|
+
|
670
|
+
# CreateTapeOutput
|
671
|
+
# @!attribute [rw] tape_arn
|
672
|
+
# A unique Amazon Resource Name (ARN) that represents the virtual tape
|
673
|
+
# that was created.
|
674
|
+
# @return [String]
|
675
|
+
class CreateTapeWithBarcodeOutput < Struct.new(
|
676
|
+
:tape_arn)
|
677
|
+
include Aws::Structure
|
678
|
+
end
|
679
|
+
|
680
|
+
# CreateTapesInput
|
681
|
+
# @note When making an API call, pass CreateTapesInput
|
682
|
+
# data as a hash:
|
683
|
+
#
|
684
|
+
# {
|
685
|
+
# gateway_arn: "GatewayARN", # required
|
686
|
+
# tape_size_in_bytes: 1, # required
|
687
|
+
# client_token: "ClientToken", # required
|
688
|
+
# num_tapes_to_create: 1, # required
|
689
|
+
# tape_barcode_prefix: "TapeBarcodePrefix", # required
|
690
|
+
# }
|
691
|
+
# @!attribute [rw] gateway_arn
|
692
|
+
# The unique Amazon Resource Name (ARN) that represents the gateway to
|
693
|
+
# associate the virtual tapes with. Use the ListGateways operation to
|
694
|
+
# return a list of gateways for your account and region.
|
695
|
+
# @return [String]
|
696
|
+
#
|
697
|
+
# @!attribute [rw] tape_size_in_bytes
|
698
|
+
# The size, in bytes, of the virtual tapes that you want to create.
|
699
|
+
#
|
700
|
+
# <note markdown="1">The size must be aligned by gigabyte (1024*1024*1024 byte).
|
701
|
+
#
|
702
|
+
# </note>
|
703
|
+
# @return [Integer]
|
704
|
+
#
|
705
|
+
# @!attribute [rw] client_token
|
706
|
+
# A unique identifier that you use to retry a request. If you retry a
|
707
|
+
# request, use the same `ClientToken` you specified in the initial
|
708
|
+
# request.
|
709
|
+
#
|
710
|
+
# <note markdown="1">Using the same `ClientToken` prevents creating the tape multiple
|
711
|
+
# times.
|
712
|
+
#
|
713
|
+
# </note>
|
714
|
+
# @return [String]
|
715
|
+
#
|
716
|
+
# @!attribute [rw] num_tapes_to_create
|
717
|
+
# The number of virtual tapes that you want to create.
|
718
|
+
# @return [Integer]
|
719
|
+
#
|
720
|
+
# @!attribute [rw] tape_barcode_prefix
|
721
|
+
# A prefix that you append to the barcode of the virtual tape you are
|
722
|
+
# creating. This prefix makes the barcode unique.
|
723
|
+
#
|
724
|
+
# <note markdown="1">The prefix must be 1 to 4 characters in length and must be one of
|
725
|
+
# the uppercase letters from A to Z.
|
726
|
+
#
|
727
|
+
# </note>
|
728
|
+
# @return [String]
|
729
|
+
class CreateTapesInput < Struct.new(
|
730
|
+
:gateway_arn,
|
731
|
+
:tape_size_in_bytes,
|
732
|
+
:client_token,
|
733
|
+
:num_tapes_to_create,
|
734
|
+
:tape_barcode_prefix)
|
735
|
+
include Aws::Structure
|
736
|
+
end
|
737
|
+
|
738
|
+
# CreateTapeOutput
|
739
|
+
# @!attribute [rw] tape_arns
|
740
|
+
# A list of unique Amazon Resource Names (ARNs) that represents the
|
741
|
+
# virtual tapes that were created.
|
742
|
+
# @return [Array<String>]
|
743
|
+
class CreateTapesOutput < Struct.new(
|
744
|
+
:tape_arns)
|
745
|
+
include Aws::Structure
|
746
|
+
end
|
747
|
+
|
748
|
+
# @note When making an API call, pass DeleteBandwidthRateLimitInput
|
749
|
+
# data as a hash:
|
750
|
+
#
|
751
|
+
# {
|
752
|
+
# gateway_arn: "GatewayARN", # required
|
753
|
+
# bandwidth_type: "BandwidthType", # required
|
754
|
+
# }
|
755
|
+
# @!attribute [rw] gateway_arn
|
756
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
757
|
+
# operation to return a list of gateways for your account and region.
|
758
|
+
# @return [String]
|
759
|
+
#
|
760
|
+
# @!attribute [rw] bandwidth_type
|
761
|
+
# @return [String]
|
762
|
+
class DeleteBandwidthRateLimitInput < Struct.new(
|
763
|
+
:gateway_arn,
|
764
|
+
:bandwidth_type)
|
765
|
+
include Aws::Structure
|
766
|
+
end
|
767
|
+
|
768
|
+
# A JSON object containing the of the gateway whose bandwidth rate
|
769
|
+
# information was deleted.
|
770
|
+
# @!attribute [rw] gateway_arn
|
771
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
772
|
+
# operation to return a list of gateways for your account and region.
|
773
|
+
# @return [String]
|
774
|
+
class DeleteBandwidthRateLimitOutput < Struct.new(
|
775
|
+
:gateway_arn)
|
776
|
+
include Aws::Structure
|
777
|
+
end
|
778
|
+
|
779
|
+
# A JSON object containing one or more of the following fields:
|
780
|
+
#
|
781
|
+
# * DeleteChapCredentialsInput$InitiatorName
|
782
|
+
#
|
783
|
+
# * DeleteChapCredentialsInput$TargetARN
|
784
|
+
# @note When making an API call, pass DeleteChapCredentialsInput
|
785
|
+
# data as a hash:
|
786
|
+
#
|
787
|
+
# {
|
788
|
+
# target_arn: "TargetARN", # required
|
789
|
+
# initiator_name: "IqnName", # required
|
790
|
+
# }
|
791
|
+
# @!attribute [rw] target_arn
|
792
|
+
# The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
|
793
|
+
# DescribeStorediSCSIVolumes operation to return to retrieve the
|
794
|
+
# TargetARN for specified VolumeARN.
|
795
|
+
# @return [String]
|
796
|
+
#
|
797
|
+
# @!attribute [rw] initiator_name
|
798
|
+
# The iSCSI initiator that connects to the target.
|
799
|
+
# @return [String]
|
800
|
+
class DeleteChapCredentialsInput < Struct.new(
|
801
|
+
:target_arn,
|
802
|
+
:initiator_name)
|
803
|
+
include Aws::Structure
|
804
|
+
end
|
805
|
+
|
806
|
+
# A JSON object containing the following fields:
|
807
|
+
# @!attribute [rw] target_arn
|
808
|
+
# The Amazon Resource Name (ARN) of the target.
|
809
|
+
# @return [String]
|
810
|
+
#
|
811
|
+
# @!attribute [rw] initiator_name
|
812
|
+
# The iSCSI initiator that connects to the target.
|
813
|
+
# @return [String]
|
814
|
+
class DeleteChapCredentialsOutput < Struct.new(
|
815
|
+
:target_arn,
|
816
|
+
:initiator_name)
|
817
|
+
include Aws::Structure
|
818
|
+
end
|
819
|
+
|
820
|
+
# A JSON object containing the id of the gateway to delete.
|
821
|
+
# @note When making an API call, pass DeleteGatewayInput
|
822
|
+
# data as a hash:
|
823
|
+
#
|
824
|
+
# {
|
825
|
+
# gateway_arn: "GatewayARN", # required
|
826
|
+
# }
|
827
|
+
# @!attribute [rw] gateway_arn
|
828
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
829
|
+
# operation to return a list of gateways for your account and region.
|
830
|
+
# @return [String]
|
831
|
+
class DeleteGatewayInput < Struct.new(
|
832
|
+
:gateway_arn)
|
833
|
+
include Aws::Structure
|
834
|
+
end
|
835
|
+
|
836
|
+
# A JSON object containing the id of the deleted gateway.
|
837
|
+
# @!attribute [rw] gateway_arn
|
838
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
839
|
+
# operation to return a list of gateways for your account and region.
|
840
|
+
# @return [String]
|
841
|
+
class DeleteGatewayOutput < Struct.new(
|
842
|
+
:gateway_arn)
|
843
|
+
include Aws::Structure
|
844
|
+
end
|
845
|
+
|
846
|
+
# @note When making an API call, pass DeleteSnapshotScheduleInput
|
847
|
+
# data as a hash:
|
848
|
+
#
|
849
|
+
# {
|
850
|
+
# volume_arn: "VolumeARN", # required
|
851
|
+
# }
|
852
|
+
# @!attribute [rw] volume_arn
|
853
|
+
# @return [String]
|
854
|
+
class DeleteSnapshotScheduleInput < Struct.new(
|
855
|
+
:volume_arn)
|
856
|
+
include Aws::Structure
|
857
|
+
end
|
858
|
+
|
859
|
+
# @!attribute [rw] volume_arn
|
860
|
+
# @return [String]
|
861
|
+
class DeleteSnapshotScheduleOutput < Struct.new(
|
862
|
+
:volume_arn)
|
863
|
+
include Aws::Structure
|
864
|
+
end
|
865
|
+
|
866
|
+
# DeleteTapeArchiveInput
|
867
|
+
# @note When making an API call, pass DeleteTapeArchiveInput
|
868
|
+
# data as a hash:
|
869
|
+
#
|
870
|
+
# {
|
871
|
+
# tape_arn: "TapeARN", # required
|
872
|
+
# }
|
873
|
+
# @!attribute [rw] tape_arn
|
874
|
+
# The Amazon Resource Name (ARN) of the virtual tape to delete from
|
875
|
+
# the virtual tape shelf (VTS).
|
876
|
+
# @return [String]
|
877
|
+
class DeleteTapeArchiveInput < Struct.new(
|
878
|
+
:tape_arn)
|
879
|
+
include Aws::Structure
|
880
|
+
end
|
881
|
+
|
882
|
+
# DeleteTapeArchiveOutput
|
883
|
+
# @!attribute [rw] tape_arn
|
884
|
+
# The Amazon Resource Name (ARN) of the virtual tape that was deleted
|
885
|
+
# from the virtual tape shelf (VTS).
|
886
|
+
# @return [String]
|
887
|
+
class DeleteTapeArchiveOutput < Struct.new(
|
888
|
+
:tape_arn)
|
889
|
+
include Aws::Structure
|
890
|
+
end
|
891
|
+
|
892
|
+
# DeleteTapeInput
|
893
|
+
# @note When making an API call, pass DeleteTapeInput
|
894
|
+
# data as a hash:
|
895
|
+
#
|
896
|
+
# {
|
897
|
+
# gateway_arn: "GatewayARN", # required
|
898
|
+
# tape_arn: "TapeARN", # required
|
899
|
+
# }
|
900
|
+
# @!attribute [rw] gateway_arn
|
901
|
+
# The unique Amazon Resource Name (ARN) of the gateway that the
|
902
|
+
# virtual tape to delete is associated with. Use the ListGateways
|
903
|
+
# operation to return a list of gateways for your account and region.
|
904
|
+
# @return [String]
|
905
|
+
#
|
906
|
+
# @!attribute [rw] tape_arn
|
907
|
+
# The Amazon Resource Name (ARN) of the virtual tape to delete.
|
908
|
+
# @return [String]
|
909
|
+
class DeleteTapeInput < Struct.new(
|
910
|
+
:gateway_arn,
|
911
|
+
:tape_arn)
|
912
|
+
include Aws::Structure
|
913
|
+
end
|
914
|
+
|
915
|
+
# DeleteTapeOutput
|
916
|
+
# @!attribute [rw] tape_arn
|
917
|
+
# The Amazon Resource Name (ARN) of the deleted virtual tape.
|
918
|
+
# @return [String]
|
919
|
+
class DeleteTapeOutput < Struct.new(
|
920
|
+
:tape_arn)
|
921
|
+
include Aws::Structure
|
922
|
+
end
|
923
|
+
|
924
|
+
# A JSON object containing the DeleteVolumeInput$VolumeARN to delete.
|
925
|
+
# @note When making an API call, pass DeleteVolumeInput
|
926
|
+
# data as a hash:
|
927
|
+
#
|
928
|
+
# {
|
929
|
+
# volume_arn: "VolumeARN", # required
|
930
|
+
# }
|
931
|
+
# @!attribute [rw] volume_arn
|
932
|
+
# The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
|
933
|
+
# operation to return a list of gateway volumes.
|
934
|
+
# @return [String]
|
935
|
+
class DeleteVolumeInput < Struct.new(
|
936
|
+
:volume_arn)
|
937
|
+
include Aws::Structure
|
938
|
+
end
|
939
|
+
|
940
|
+
# A JSON object containing the of the storage volume that was deleted
|
941
|
+
# @!attribute [rw] volume_arn
|
942
|
+
# The Amazon Resource Name (ARN) of the storage volume that was
|
943
|
+
# deleted. It is the same ARN you provided in the request.
|
944
|
+
# @return [String]
|
945
|
+
class DeleteVolumeOutput < Struct.new(
|
946
|
+
:volume_arn)
|
947
|
+
include Aws::Structure
|
948
|
+
end
|
949
|
+
|
950
|
+
# A JSON object containing the of the gateway.
|
951
|
+
# @note When making an API call, pass DescribeBandwidthRateLimitInput
|
952
|
+
# data as a hash:
|
953
|
+
#
|
954
|
+
# {
|
955
|
+
# gateway_arn: "GatewayARN", # required
|
956
|
+
# }
|
957
|
+
# @!attribute [rw] gateway_arn
|
958
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
959
|
+
# operation to return a list of gateways for your account and region.
|
960
|
+
# @return [String]
|
961
|
+
class DescribeBandwidthRateLimitInput < Struct.new(
|
962
|
+
:gateway_arn)
|
963
|
+
include Aws::Structure
|
964
|
+
end
|
965
|
+
|
966
|
+
# A JSON object containing the following fields:
|
967
|
+
# @!attribute [rw] gateway_arn
|
968
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
969
|
+
# operation to return a list of gateways for your account and region.
|
970
|
+
# @return [String]
|
971
|
+
#
|
972
|
+
# @!attribute [rw] average_upload_rate_limit_in_bits_per_sec
|
973
|
+
# The average upload bandwidth rate limit in bits per second. This
|
974
|
+
# field does not appear in the response if the upload rate limit is
|
975
|
+
# not set.
|
976
|
+
# @return [Integer]
|
977
|
+
#
|
978
|
+
# @!attribute [rw] average_download_rate_limit_in_bits_per_sec
|
979
|
+
# The average download bandwidth rate limit in bits per second. This
|
980
|
+
# field does not appear in the response if the download rate limit is
|
981
|
+
# not set.
|
982
|
+
# @return [Integer]
|
983
|
+
class DescribeBandwidthRateLimitOutput < Struct.new(
|
984
|
+
:gateway_arn,
|
985
|
+
:average_upload_rate_limit_in_bits_per_sec,
|
986
|
+
:average_download_rate_limit_in_bits_per_sec)
|
987
|
+
include Aws::Structure
|
988
|
+
end
|
989
|
+
|
990
|
+
# @note When making an API call, pass DescribeCacheInput
|
991
|
+
# data as a hash:
|
992
|
+
#
|
993
|
+
# {
|
994
|
+
# gateway_arn: "GatewayARN", # required
|
995
|
+
# }
|
996
|
+
# @!attribute [rw] gateway_arn
|
997
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
998
|
+
# operation to return a list of gateways for your account and region.
|
999
|
+
# @return [String]
|
1000
|
+
class DescribeCacheInput < Struct.new(
|
1001
|
+
:gateway_arn)
|
1002
|
+
include Aws::Structure
|
1003
|
+
end
|
1004
|
+
|
1005
|
+
# @!attribute [rw] gateway_arn
|
1006
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1007
|
+
# operation to return a list of gateways for your account and region.
|
1008
|
+
# @return [String]
|
1009
|
+
#
|
1010
|
+
# @!attribute [rw] disk_ids
|
1011
|
+
# @return [Array<String>]
|
1012
|
+
#
|
1013
|
+
# @!attribute [rw] cache_allocated_in_bytes
|
1014
|
+
# @return [Integer]
|
1015
|
+
#
|
1016
|
+
# @!attribute [rw] cache_used_percentage
|
1017
|
+
# @return [Float]
|
1018
|
+
#
|
1019
|
+
# @!attribute [rw] cache_dirty_percentage
|
1020
|
+
# @return [Float]
|
1021
|
+
#
|
1022
|
+
# @!attribute [rw] cache_hit_percentage
|
1023
|
+
# @return [Float]
|
1024
|
+
#
|
1025
|
+
# @!attribute [rw] cache_miss_percentage
|
1026
|
+
# @return [Float]
|
1027
|
+
class DescribeCacheOutput < Struct.new(
|
1028
|
+
:gateway_arn,
|
1029
|
+
:disk_ids,
|
1030
|
+
:cache_allocated_in_bytes,
|
1031
|
+
:cache_used_percentage,
|
1032
|
+
:cache_dirty_percentage,
|
1033
|
+
:cache_hit_percentage,
|
1034
|
+
:cache_miss_percentage)
|
1035
|
+
include Aws::Structure
|
1036
|
+
end
|
1037
|
+
|
1038
|
+
# @note When making an API call, pass DescribeCachediSCSIVolumesInput
|
1039
|
+
# data as a hash:
|
1040
|
+
#
|
1041
|
+
# {
|
1042
|
+
# volume_arns: ["VolumeARN"], # required
|
1043
|
+
# }
|
1044
|
+
# @!attribute [rw] volume_arns
|
1045
|
+
# @return [Array<String>]
|
1046
|
+
class DescribeCachediSCSIVolumesInput < Struct.new(
|
1047
|
+
:volume_arns)
|
1048
|
+
include Aws::Structure
|
1049
|
+
end
|
1050
|
+
|
1051
|
+
# A JSON object containing the following fields:
|
1052
|
+
# @!attribute [rw] cached_iscsi_volumes
|
1053
|
+
# An array of objects where each object contains metadata about one
|
1054
|
+
# cached volume.
|
1055
|
+
# @return [Array<Types::CachediSCSIVolume>]
|
1056
|
+
class DescribeCachediSCSIVolumesOutput < Struct.new(
|
1057
|
+
:cached_iscsi_volumes)
|
1058
|
+
include Aws::Structure
|
1059
|
+
end
|
1060
|
+
|
1061
|
+
# A JSON object containing the Amazon Resource Name (ARN) of the iSCSI
|
1062
|
+
# volume target.
|
1063
|
+
# @note When making an API call, pass DescribeChapCredentialsInput
|
1064
|
+
# data as a hash:
|
1065
|
+
#
|
1066
|
+
# {
|
1067
|
+
# target_arn: "TargetARN", # required
|
1068
|
+
# }
|
1069
|
+
# @!attribute [rw] target_arn
|
1070
|
+
# The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
|
1071
|
+
# DescribeStorediSCSIVolumes operation to return to retrieve the
|
1072
|
+
# TargetARN for specified VolumeARN.
|
1073
|
+
# @return [String]
|
1074
|
+
class DescribeChapCredentialsInput < Struct.new(
|
1075
|
+
:target_arn)
|
1076
|
+
include Aws::Structure
|
1077
|
+
end
|
1078
|
+
|
1079
|
+
# A JSON object containing a .
|
1080
|
+
# @!attribute [rw] chap_credentials
|
1081
|
+
# An array of ChapInfo objects that represent CHAP credentials. Each
|
1082
|
+
# object in the array contains CHAP credential information for one
|
1083
|
+
# target-initiator pair. If no CHAP credentials are set, an empty
|
1084
|
+
# array is returned. CHAP credential information is provided in a JSON
|
1085
|
+
# object with the following fields:
|
1086
|
+
#
|
1087
|
+
# * **InitiatorName**\: The iSCSI initiator that connects to the
|
1088
|
+
# target.
|
1089
|
+
#
|
1090
|
+
# * **SecretToAuthenticateInitiator**\: The secret key that the
|
1091
|
+
# initiator (for example, the Windows client) must provide to
|
1092
|
+
# participate in mutual CHAP with the target.
|
1093
|
+
#
|
1094
|
+
# * **SecretToAuthenticateTarget**\: The secret key that the target
|
1095
|
+
# must provide to participate in mutual CHAP with the initiator
|
1096
|
+
# (e.g. Windows client).
|
1097
|
+
#
|
1098
|
+
# * **TargetARN**\: The Amazon Resource Name (ARN) of the storage
|
1099
|
+
# volume.
|
1100
|
+
# @return [Array<Types::ChapInfo>]
|
1101
|
+
class DescribeChapCredentialsOutput < Struct.new(
|
1102
|
+
:chap_credentials)
|
1103
|
+
include Aws::Structure
|
1104
|
+
end
|
1105
|
+
|
1106
|
+
# A JSON object containing the id of the gateway.
|
1107
|
+
# @note When making an API call, pass DescribeGatewayInformationInput
|
1108
|
+
# data as a hash:
|
1109
|
+
#
|
1110
|
+
# {
|
1111
|
+
# gateway_arn: "GatewayARN", # required
|
1112
|
+
# }
|
1113
|
+
# @!attribute [rw] gateway_arn
|
1114
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1115
|
+
# operation to return a list of gateways for your account and region.
|
1116
|
+
# @return [String]
|
1117
|
+
class DescribeGatewayInformationInput < Struct.new(
|
1118
|
+
:gateway_arn)
|
1119
|
+
include Aws::Structure
|
1120
|
+
end
|
1121
|
+
|
1122
|
+
# A JSON object containing the following fields:
|
1123
|
+
# @!attribute [rw] gateway_arn
|
1124
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1125
|
+
# operation to return a list of gateways for your account and region.
|
1126
|
+
# @return [String]
|
1127
|
+
#
|
1128
|
+
# @!attribute [rw] gateway_id
|
1129
|
+
# The unique identifier assigned to your gateway during activation.
|
1130
|
+
# This ID becomes part of the gateway Amazon Resource Name (ARN),
|
1131
|
+
# which you use as input for other operations.
|
1132
|
+
# @return [String]
|
1133
|
+
#
|
1134
|
+
# @!attribute [rw] gateway_name
|
1135
|
+
# The name you configured for your gateway.
|
1136
|
+
# @return [String]
|
1137
|
+
#
|
1138
|
+
# @!attribute [rw] gateway_timezone
|
1139
|
+
# A value that indicates the time zone configured for the gateway.
|
1140
|
+
# @return [String]
|
1141
|
+
#
|
1142
|
+
# @!attribute [rw] gateway_state
|
1143
|
+
# A value that indicates the operating state of the gateway.
|
1144
|
+
# @return [String]
|
1145
|
+
#
|
1146
|
+
# @!attribute [rw] gateway_network_interfaces
|
1147
|
+
# A NetworkInterface array that contains descriptions of the gateway
|
1148
|
+
# network interfaces.
|
1149
|
+
# @return [Array<Types::NetworkInterface>]
|
1150
|
+
#
|
1151
|
+
# @!attribute [rw] gateway_type
|
1152
|
+
# The type of the gateway.
|
1153
|
+
# @return [String]
|
1154
|
+
#
|
1155
|
+
# @!attribute [rw] next_update_availability_date
|
1156
|
+
# The date on which an update to the gateway is available. This date
|
1157
|
+
# is in the time zone of the gateway. If the gateway is not available
|
1158
|
+
# for an update this field is not returned in the response.
|
1159
|
+
# @return [String]
|
1160
|
+
#
|
1161
|
+
# @!attribute [rw] last_software_update
|
1162
|
+
# The date on which the last software update was applied to the
|
1163
|
+
# gateway. If the gateway has never been updated, this field does not
|
1164
|
+
# return a value in the response.
|
1165
|
+
# @return [String]
|
1166
|
+
class DescribeGatewayInformationOutput < Struct.new(
|
1167
|
+
:gateway_arn,
|
1168
|
+
:gateway_id,
|
1169
|
+
:gateway_name,
|
1170
|
+
:gateway_timezone,
|
1171
|
+
:gateway_state,
|
1172
|
+
:gateway_network_interfaces,
|
1173
|
+
:gateway_type,
|
1174
|
+
:next_update_availability_date,
|
1175
|
+
:last_software_update)
|
1176
|
+
include Aws::Structure
|
1177
|
+
end
|
1178
|
+
|
1179
|
+
# A JSON object containing the of the gateway.
|
1180
|
+
# @note When making an API call, pass DescribeMaintenanceStartTimeInput
|
1181
|
+
# data as a hash:
|
1182
|
+
#
|
1183
|
+
# {
|
1184
|
+
# gateway_arn: "GatewayARN", # required
|
1185
|
+
# }
|
1186
|
+
# @!attribute [rw] gateway_arn
|
1187
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1188
|
+
# operation to return a list of gateways for your account and region.
|
1189
|
+
# @return [String]
|
1190
|
+
class DescribeMaintenanceStartTimeInput < Struct.new(
|
1191
|
+
:gateway_arn)
|
1192
|
+
include Aws::Structure
|
1193
|
+
end
|
1194
|
+
|
1195
|
+
# @!attribute [rw] gateway_arn
|
1196
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1197
|
+
# operation to return a list of gateways for your account and region.
|
1198
|
+
# @return [String]
|
1199
|
+
#
|
1200
|
+
# @!attribute [rw] hour_of_day
|
1201
|
+
# @return [Integer]
|
1202
|
+
#
|
1203
|
+
# @!attribute [rw] minute_of_hour
|
1204
|
+
# @return [Integer]
|
1205
|
+
#
|
1206
|
+
# @!attribute [rw] day_of_week
|
1207
|
+
# @return [Integer]
|
1208
|
+
#
|
1209
|
+
# @!attribute [rw] timezone
|
1210
|
+
# @return [String]
|
1211
|
+
class DescribeMaintenanceStartTimeOutput < Struct.new(
|
1212
|
+
:gateway_arn,
|
1213
|
+
:hour_of_day,
|
1214
|
+
:minute_of_hour,
|
1215
|
+
:day_of_week,
|
1216
|
+
:timezone)
|
1217
|
+
include Aws::Structure
|
1218
|
+
end
|
1219
|
+
|
1220
|
+
# A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN
|
1221
|
+
# of the volume.
|
1222
|
+
# @note When making an API call, pass DescribeSnapshotScheduleInput
|
1223
|
+
# data as a hash:
|
1224
|
+
#
|
1225
|
+
# {
|
1226
|
+
# volume_arn: "VolumeARN", # required
|
1227
|
+
# }
|
1228
|
+
# @!attribute [rw] volume_arn
|
1229
|
+
# The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
|
1230
|
+
# operation to return a list of gateway volumes.
|
1231
|
+
# @return [String]
|
1232
|
+
class DescribeSnapshotScheduleInput < Struct.new(
|
1233
|
+
:volume_arn)
|
1234
|
+
include Aws::Structure
|
1235
|
+
end
|
1236
|
+
|
1237
|
+
# @!attribute [rw] volume_arn
|
1238
|
+
# @return [String]
|
1239
|
+
#
|
1240
|
+
# @!attribute [rw] start_at
|
1241
|
+
# @return [Integer]
|
1242
|
+
#
|
1243
|
+
# @!attribute [rw] recurrence_in_hours
|
1244
|
+
# @return [Integer]
|
1245
|
+
#
|
1246
|
+
# @!attribute [rw] description
|
1247
|
+
# @return [String]
|
1248
|
+
#
|
1249
|
+
# @!attribute [rw] timezone
|
1250
|
+
# @return [String]
|
1251
|
+
class DescribeSnapshotScheduleOutput < Struct.new(
|
1252
|
+
:volume_arn,
|
1253
|
+
:start_at,
|
1254
|
+
:recurrence_in_hours,
|
1255
|
+
:description,
|
1256
|
+
:timezone)
|
1257
|
+
include Aws::Structure
|
1258
|
+
end
|
1259
|
+
|
1260
|
+
# A JSON object containing a list of
|
1261
|
+
# DescribeStorediSCSIVolumesInput$VolumeARNs.
|
1262
|
+
# @note When making an API call, pass DescribeStorediSCSIVolumesInput
|
1263
|
+
# data as a hash:
|
1264
|
+
#
|
1265
|
+
# {
|
1266
|
+
# volume_arns: ["VolumeARN"], # required
|
1267
|
+
# }
|
1268
|
+
# @!attribute [rw] volume_arns
|
1269
|
+
# An array of strings where each string represents the Amazon Resource
|
1270
|
+
# Name (ARN) of a stored volume. All of the specified stored volumes
|
1271
|
+
# must from the same gateway. Use ListVolumes to get volume ARNs for a
|
1272
|
+
# gateway.
|
1273
|
+
# @return [Array<String>]
|
1274
|
+
class DescribeStorediSCSIVolumesInput < Struct.new(
|
1275
|
+
:volume_arns)
|
1276
|
+
include Aws::Structure
|
1277
|
+
end
|
1278
|
+
|
1279
|
+
# @!attribute [rw] stored_iscsi_volumes
|
1280
|
+
# @return [Array<Types::StorediSCSIVolume>]
|
1281
|
+
class DescribeStorediSCSIVolumesOutput < Struct.new(
|
1282
|
+
:stored_iscsi_volumes)
|
1283
|
+
include Aws::Structure
|
1284
|
+
end
|
1285
|
+
|
1286
|
+
# DescribeTapeArchivesInput
|
1287
|
+
# @note When making an API call, pass DescribeTapeArchivesInput
|
1288
|
+
# data as a hash:
|
1289
|
+
#
|
1290
|
+
# {
|
1291
|
+
# tape_arns: ["TapeARN"],
|
1292
|
+
# marker: "Marker",
|
1293
|
+
# limit: 1,
|
1294
|
+
# }
|
1295
|
+
# @!attribute [rw] tape_arns
|
1296
|
+
# Specifies one or more unique Amazon Resource Names (ARNs) that
|
1297
|
+
# represent the virtual tapes you want to describe.
|
1298
|
+
# @return [Array<String>]
|
1299
|
+
#
|
1300
|
+
# @!attribute [rw] marker
|
1301
|
+
# An opaque string that indicates the position at which to begin
|
1302
|
+
# describing virtual tapes.
|
1303
|
+
# @return [String]
|
1304
|
+
#
|
1305
|
+
# @!attribute [rw] limit
|
1306
|
+
# Specifies that the number of virtual tapes descried be limited to
|
1307
|
+
# the specified number.
|
1308
|
+
# @return [Integer]
|
1309
|
+
class DescribeTapeArchivesInput < Struct.new(
|
1310
|
+
:tape_arns,
|
1311
|
+
:marker,
|
1312
|
+
:limit)
|
1313
|
+
include Aws::Structure
|
1314
|
+
end
|
1315
|
+
|
1316
|
+
# DescribeTapeArchivesOutput
|
1317
|
+
# @!attribute [rw] tape_archives
|
1318
|
+
# An array of virtual tape objects in the virtual tape shelf (VTS).
|
1319
|
+
# The description includes of the Amazon Resource Name(ARN) of the
|
1320
|
+
# virtual tapes. The information returned includes the Amazon Resource
|
1321
|
+
# Names (ARNs) of the tapes, size of the tapes, status of the tapes,
|
1322
|
+
# progress of the description and tape barcode.
|
1323
|
+
# @return [Array<Types::TapeArchive>]
|
1324
|
+
#
|
1325
|
+
# @!attribute [rw] marker
|
1326
|
+
# An opaque string that indicates the position at which the virtual
|
1327
|
+
# tapes that were fetched for description ended. Use this marker in
|
1328
|
+
# your next request to fetch the next set of virtual tapes in the
|
1329
|
+
# virtual tape shelf (VTS). If there are no more virtual tapes to
|
1330
|
+
# describe, this field does not appear in the response.
|
1331
|
+
# @return [String]
|
1332
|
+
class DescribeTapeArchivesOutput < Struct.new(
|
1333
|
+
:tape_archives,
|
1334
|
+
:marker)
|
1335
|
+
include Aws::Structure
|
1336
|
+
end
|
1337
|
+
|
1338
|
+
# DescribeTapeRecoveryPointsInput
|
1339
|
+
# @note When making an API call, pass DescribeTapeRecoveryPointsInput
|
1340
|
+
# data as a hash:
|
1341
|
+
#
|
1342
|
+
# {
|
1343
|
+
# gateway_arn: "GatewayARN", # required
|
1344
|
+
# marker: "Marker",
|
1345
|
+
# limit: 1,
|
1346
|
+
# }
|
1347
|
+
# @!attribute [rw] gateway_arn
|
1348
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1349
|
+
# operation to return a list of gateways for your account and region.
|
1350
|
+
# @return [String]
|
1351
|
+
#
|
1352
|
+
# @!attribute [rw] marker
|
1353
|
+
# An opaque string that indicates the position at which to begin
|
1354
|
+
# describing the virtual tape recovery points.
|
1355
|
+
# @return [String]
|
1356
|
+
#
|
1357
|
+
# @!attribute [rw] limit
|
1358
|
+
# Specifies that the number of virtual tape recovery points that are
|
1359
|
+
# described be limited to the specified number.
|
1360
|
+
# @return [Integer]
|
1361
|
+
class DescribeTapeRecoveryPointsInput < Struct.new(
|
1362
|
+
:gateway_arn,
|
1363
|
+
:marker,
|
1364
|
+
:limit)
|
1365
|
+
include Aws::Structure
|
1366
|
+
end
|
1367
|
+
|
1368
|
+
# DescribeTapeRecoveryPointsOutput
|
1369
|
+
# @!attribute [rw] gateway_arn
|
1370
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1371
|
+
# operation to return a list of gateways for your account and region.
|
1372
|
+
# @return [String]
|
1373
|
+
#
|
1374
|
+
# @!attribute [rw] tape_recovery_point_infos
|
1375
|
+
# An array of TapeRecoveryPointInfos that are available for the
|
1376
|
+
# specified gateway.
|
1377
|
+
# @return [Array<Types::TapeRecoveryPointInfo>]
|
1378
|
+
#
|
1379
|
+
# @!attribute [rw] marker
|
1380
|
+
# An opaque string that indicates the position at which the virtual
|
1381
|
+
# tape recovery points that were listed for description ended.
|
1382
|
+
#
|
1383
|
+
# Use this marker in your next request to list the next set of virtual
|
1384
|
+
# tape recovery points in the list. If there are no more recovery
|
1385
|
+
# points to describe, this field does not appear in the response.
|
1386
|
+
# @return [String]
|
1387
|
+
class DescribeTapeRecoveryPointsOutput < Struct.new(
|
1388
|
+
:gateway_arn,
|
1389
|
+
:tape_recovery_point_infos,
|
1390
|
+
:marker)
|
1391
|
+
include Aws::Structure
|
1392
|
+
end
|
1393
|
+
|
1394
|
+
# DescribeTapesInput
|
1395
|
+
# @note When making an API call, pass DescribeTapesInput
|
1396
|
+
# data as a hash:
|
1397
|
+
#
|
1398
|
+
# {
|
1399
|
+
# gateway_arn: "GatewayARN", # required
|
1400
|
+
# tape_arns: ["TapeARN"],
|
1401
|
+
# marker: "Marker",
|
1402
|
+
# limit: 1,
|
1403
|
+
# }
|
1404
|
+
# @!attribute [rw] gateway_arn
|
1405
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1406
|
+
# operation to return a list of gateways for your account and region.
|
1407
|
+
# @return [String]
|
1408
|
+
#
|
1409
|
+
# @!attribute [rw] tape_arns
|
1410
|
+
# Specifies one or more unique Amazon Resource Names (ARNs) that
|
1411
|
+
# represent the virtual tapes you want to describe. If this parameter
|
1412
|
+
# is not specified, AWS Storage Gateway returns a description of all
|
1413
|
+
# virtual tapes associated with the specified gateway.
|
1414
|
+
# @return [Array<String>]
|
1415
|
+
#
|
1416
|
+
# @!attribute [rw] marker
|
1417
|
+
# A marker value, obtained in a previous call to `DescribeTapes`. This
|
1418
|
+
# marker indicates which page of results to retrieve.
|
1419
|
+
#
|
1420
|
+
# If not specified, the first page of results is retrieved.
|
1421
|
+
# @return [String]
|
1422
|
+
#
|
1423
|
+
# @!attribute [rw] limit
|
1424
|
+
# Specifies that the number of virtual tapes described be limited to
|
1425
|
+
# the specified number.
|
1426
|
+
#
|
1427
|
+
# <note markdown="1">Amazon Web Services may impose its own limit, if this field is not
|
1428
|
+
# set.
|
1429
|
+
#
|
1430
|
+
# </note>
|
1431
|
+
# @return [Integer]
|
1432
|
+
class DescribeTapesInput < Struct.new(
|
1433
|
+
:gateway_arn,
|
1434
|
+
:tape_arns,
|
1435
|
+
:marker,
|
1436
|
+
:limit)
|
1437
|
+
include Aws::Structure
|
1438
|
+
end
|
1439
|
+
|
1440
|
+
# DescribeTapesOutput
|
1441
|
+
# @!attribute [rw] tapes
|
1442
|
+
# An array of virtual tape descriptions.
|
1443
|
+
# @return [Array<Types::Tape>]
|
1444
|
+
#
|
1445
|
+
# @!attribute [rw] marker
|
1446
|
+
# An opaque string which can be used as part of a subsequent
|
1447
|
+
# DescribeTapes call to retrieve the next page of results.
|
1448
|
+
#
|
1449
|
+
# If a response does not contain a marker, then there are no more
|
1450
|
+
# results to be retrieved.
|
1451
|
+
# @return [String]
|
1452
|
+
class DescribeTapesOutput < Struct.new(
|
1453
|
+
:tapes,
|
1454
|
+
:marker)
|
1455
|
+
include Aws::Structure
|
1456
|
+
end
|
1457
|
+
|
1458
|
+
# @note When making an API call, pass DescribeUploadBufferInput
|
1459
|
+
# data as a hash:
|
1460
|
+
#
|
1461
|
+
# {
|
1462
|
+
# gateway_arn: "GatewayARN", # required
|
1463
|
+
# }
|
1464
|
+
# @!attribute [rw] gateway_arn
|
1465
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1466
|
+
# operation to return a list of gateways for your account and region.
|
1467
|
+
# @return [String]
|
1468
|
+
class DescribeUploadBufferInput < Struct.new(
|
1469
|
+
:gateway_arn)
|
1470
|
+
include Aws::Structure
|
1471
|
+
end
|
1472
|
+
|
1473
|
+
# @!attribute [rw] gateway_arn
|
1474
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1475
|
+
# operation to return a list of gateways for your account and region.
|
1476
|
+
# @return [String]
|
1477
|
+
#
|
1478
|
+
# @!attribute [rw] disk_ids
|
1479
|
+
# @return [Array<String>]
|
1480
|
+
#
|
1481
|
+
# @!attribute [rw] upload_buffer_used_in_bytes
|
1482
|
+
# @return [Integer]
|
1483
|
+
#
|
1484
|
+
# @!attribute [rw] upload_buffer_allocated_in_bytes
|
1485
|
+
# @return [Integer]
|
1486
|
+
class DescribeUploadBufferOutput < Struct.new(
|
1487
|
+
:gateway_arn,
|
1488
|
+
:disk_ids,
|
1489
|
+
:upload_buffer_used_in_bytes,
|
1490
|
+
:upload_buffer_allocated_in_bytes)
|
1491
|
+
include Aws::Structure
|
1492
|
+
end
|
1493
|
+
|
1494
|
+
# DescribeVTLDevicesInput
|
1495
|
+
# @note When making an API call, pass DescribeVTLDevicesInput
|
1496
|
+
# data as a hash:
|
1497
|
+
#
|
1498
|
+
# {
|
1499
|
+
# gateway_arn: "GatewayARN", # required
|
1500
|
+
# vtl_device_arns: ["VTLDeviceARN"],
|
1501
|
+
# marker: "Marker",
|
1502
|
+
# limit: 1,
|
1503
|
+
# }
|
1504
|
+
# @!attribute [rw] gateway_arn
|
1505
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1506
|
+
# operation to return a list of gateways for your account and region.
|
1507
|
+
# @return [String]
|
1508
|
+
#
|
1509
|
+
# @!attribute [rw] vtl_device_arns
|
1510
|
+
# An array of strings, where each string represents the Amazon
|
1511
|
+
# Resource Name (ARN) of a VTL device.
|
1512
|
+
#
|
1513
|
+
# <note markdown="1">All of the specified VTL devices must be from the same gateway. If
|
1514
|
+
# no VTL devices are specified, the result will contain all devices on
|
1515
|
+
# the specified gateway.
|
1516
|
+
#
|
1517
|
+
# </note>
|
1518
|
+
# @return [Array<String>]
|
1519
|
+
#
|
1520
|
+
# @!attribute [rw] marker
|
1521
|
+
# An opaque string that indicates the position at which to begin
|
1522
|
+
# describing the VTL devices.
|
1523
|
+
# @return [String]
|
1524
|
+
#
|
1525
|
+
# @!attribute [rw] limit
|
1526
|
+
# Specifies that the number of VTL devices described be limited to the
|
1527
|
+
# specified number.
|
1528
|
+
# @return [Integer]
|
1529
|
+
class DescribeVTLDevicesInput < Struct.new(
|
1530
|
+
:gateway_arn,
|
1531
|
+
:vtl_device_arns,
|
1532
|
+
:marker,
|
1533
|
+
:limit)
|
1534
|
+
include Aws::Structure
|
1535
|
+
end
|
1536
|
+
|
1537
|
+
# DescribeVTLDevicesOutput
|
1538
|
+
# @!attribute [rw] gateway_arn
|
1539
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1540
|
+
# operation to return a list of gateways for your account and region.
|
1541
|
+
# @return [String]
|
1542
|
+
#
|
1543
|
+
# @!attribute [rw] vtl_devices
|
1544
|
+
# An array of VTL device objects composed of the Amazon Resource
|
1545
|
+
# Name(ARN) of the VTL devices.
|
1546
|
+
# @return [Array<Types::VTLDevice>]
|
1547
|
+
#
|
1548
|
+
# @!attribute [rw] marker
|
1549
|
+
# An opaque string that indicates the position at which the VTL
|
1550
|
+
# devices that were fetched for description ended. Use the marker in
|
1551
|
+
# your next request to fetch the next set of VTL devices in the list.
|
1552
|
+
# If there are no more VTL devices to describe, this field does not
|
1553
|
+
# appear in the response.
|
1554
|
+
# @return [String]
|
1555
|
+
class DescribeVTLDevicesOutput < Struct.new(
|
1556
|
+
:gateway_arn,
|
1557
|
+
:vtl_devices,
|
1558
|
+
:marker)
|
1559
|
+
include Aws::Structure
|
1560
|
+
end
|
1561
|
+
|
1562
|
+
# A JSON object containing the of the gateway.
|
1563
|
+
# @note When making an API call, pass DescribeWorkingStorageInput
|
1564
|
+
# data as a hash:
|
1565
|
+
#
|
1566
|
+
# {
|
1567
|
+
# gateway_arn: "GatewayARN", # required
|
1568
|
+
# }
|
1569
|
+
# @!attribute [rw] gateway_arn
|
1570
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1571
|
+
# operation to return a list of gateways for your account and region.
|
1572
|
+
# @return [String]
|
1573
|
+
class DescribeWorkingStorageInput < Struct.new(
|
1574
|
+
:gateway_arn)
|
1575
|
+
include Aws::Structure
|
1576
|
+
end
|
1577
|
+
|
1578
|
+
# A JSON object containing the following fields:
|
1579
|
+
# @!attribute [rw] gateway_arn
|
1580
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1581
|
+
# operation to return a list of gateways for your account and region.
|
1582
|
+
# @return [String]
|
1583
|
+
#
|
1584
|
+
# @!attribute [rw] disk_ids
|
1585
|
+
# An array of the gateway's local disk IDs that are configured as
|
1586
|
+
# working storage. Each local disk ID is specified as a string
|
1587
|
+
# (minimum length of 1 and maximum length of 300). If no local disks
|
1588
|
+
# are configured as working storage, then the DiskIds array is empty.
|
1589
|
+
# @return [Array<String>]
|
1590
|
+
#
|
1591
|
+
# @!attribute [rw] working_storage_used_in_bytes
|
1592
|
+
# The total working storage in bytes in use by the gateway. If no
|
1593
|
+
# working storage is configured for the gateway, this field returns 0.
|
1594
|
+
# @return [Integer]
|
1595
|
+
#
|
1596
|
+
# @!attribute [rw] working_storage_allocated_in_bytes
|
1597
|
+
# The total working storage in bytes allocated for the gateway. If no
|
1598
|
+
# working storage is configured for the gateway, this field returns 0.
|
1599
|
+
# @return [Integer]
|
1600
|
+
class DescribeWorkingStorageOutput < Struct.new(
|
1601
|
+
:gateway_arn,
|
1602
|
+
:disk_ids,
|
1603
|
+
:working_storage_used_in_bytes,
|
1604
|
+
:working_storage_allocated_in_bytes)
|
1605
|
+
include Aws::Structure
|
1606
|
+
end
|
1607
|
+
|
1608
|
+
# Lists iSCSI information about a VTL device.
|
1609
|
+
# @!attribute [rw] target_arn
|
1610
|
+
# Specifies the unique Amazon Resource Name(ARN) that encodes the
|
1611
|
+
# iSCSI qualified name(iqn) of a tape drive or media changer target.
|
1612
|
+
# @return [String]
|
1613
|
+
#
|
1614
|
+
# @!attribute [rw] network_interface_id
|
1615
|
+
# The network interface identifier of the VTL device.
|
1616
|
+
# @return [String]
|
1617
|
+
#
|
1618
|
+
# @!attribute [rw] network_interface_port
|
1619
|
+
# The port used to communicate with iSCSI VTL device targets.
|
1620
|
+
# @return [Integer]
|
1621
|
+
#
|
1622
|
+
# @!attribute [rw] chap_enabled
|
1623
|
+
# Indicates whether mutual CHAP is enabled for the iSCSI target.
|
1624
|
+
# @return [Boolean]
|
1625
|
+
class DeviceiSCSIAttributes < Struct.new(
|
1626
|
+
:target_arn,
|
1627
|
+
:network_interface_id,
|
1628
|
+
:network_interface_port,
|
1629
|
+
:chap_enabled)
|
1630
|
+
include Aws::Structure
|
1631
|
+
end
|
1632
|
+
|
1633
|
+
# DisableGatewayInput
|
1634
|
+
# @note When making an API call, pass DisableGatewayInput
|
1635
|
+
# data as a hash:
|
1636
|
+
#
|
1637
|
+
# {
|
1638
|
+
# gateway_arn: "GatewayARN", # required
|
1639
|
+
# }
|
1640
|
+
# @!attribute [rw] gateway_arn
|
1641
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1642
|
+
# operation to return a list of gateways for your account and region.
|
1643
|
+
# @return [String]
|
1644
|
+
class DisableGatewayInput < Struct.new(
|
1645
|
+
:gateway_arn)
|
1646
|
+
include Aws::Structure
|
1647
|
+
end
|
1648
|
+
|
1649
|
+
# DisableGatewayOutput
|
1650
|
+
# @!attribute [rw] gateway_arn
|
1651
|
+
# The unique Amazon Resource Name of the disabled gateway.
|
1652
|
+
# @return [String]
|
1653
|
+
class DisableGatewayOutput < Struct.new(
|
1654
|
+
:gateway_arn)
|
1655
|
+
include Aws::Structure
|
1656
|
+
end
|
1657
|
+
|
1658
|
+
# @!attribute [rw] disk_id
|
1659
|
+
# @return [String]
|
1660
|
+
#
|
1661
|
+
# @!attribute [rw] disk_path
|
1662
|
+
# @return [String]
|
1663
|
+
#
|
1664
|
+
# @!attribute [rw] disk_node
|
1665
|
+
# @return [String]
|
1666
|
+
#
|
1667
|
+
# @!attribute [rw] disk_status
|
1668
|
+
# @return [String]
|
1669
|
+
#
|
1670
|
+
# @!attribute [rw] disk_size_in_bytes
|
1671
|
+
# @return [Integer]
|
1672
|
+
#
|
1673
|
+
# @!attribute [rw] disk_allocation_type
|
1674
|
+
# @return [String]
|
1675
|
+
#
|
1676
|
+
# @!attribute [rw] disk_allocation_resource
|
1677
|
+
# @return [String]
|
1678
|
+
class Disk < Struct.new(
|
1679
|
+
:disk_id,
|
1680
|
+
:disk_path,
|
1681
|
+
:disk_node,
|
1682
|
+
:disk_status,
|
1683
|
+
:disk_size_in_bytes,
|
1684
|
+
:disk_allocation_type,
|
1685
|
+
:disk_allocation_resource)
|
1686
|
+
include Aws::Structure
|
1687
|
+
end
|
1688
|
+
|
1689
|
+
# Describes a gateway object.
|
1690
|
+
# @!attribute [rw] gateway_id
|
1691
|
+
# The unique identifier assigned to your gateway during activation.
|
1692
|
+
# This ID becomes part of the gateway Amazon Resource Name (ARN),
|
1693
|
+
# which you use as input for other operations.
|
1694
|
+
# @return [String]
|
1695
|
+
#
|
1696
|
+
# @!attribute [rw] gateway_arn
|
1697
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1698
|
+
# operation to return a list of gateways for your account and region.
|
1699
|
+
# @return [String]
|
1700
|
+
#
|
1701
|
+
# @!attribute [rw] gateway_type
|
1702
|
+
# The type of the gateway.
|
1703
|
+
# @return [String]
|
1704
|
+
#
|
1705
|
+
# @!attribute [rw] gateway_operational_state
|
1706
|
+
# The state of the gateway.
|
1707
|
+
#
|
1708
|
+
# Valid Values: DISABLED or ACTIVE
|
1709
|
+
# @return [String]
|
1710
|
+
#
|
1711
|
+
# @!attribute [rw] gateway_name
|
1712
|
+
# The name of the gateway.
|
1713
|
+
# @return [String]
|
1714
|
+
class GatewayInfo < Struct.new(
|
1715
|
+
:gateway_id,
|
1716
|
+
:gateway_arn,
|
1717
|
+
:gateway_type,
|
1718
|
+
:gateway_operational_state,
|
1719
|
+
:gateway_name)
|
1720
|
+
include Aws::Structure
|
1721
|
+
end
|
1722
|
+
|
1723
|
+
# A JSON object containing zero or more of the following fields:
|
1724
|
+
#
|
1725
|
+
# * ListGatewaysInput$Limit
|
1726
|
+
#
|
1727
|
+
# * ListGatewaysInput$Marker
|
1728
|
+
# @note When making an API call, pass ListGatewaysInput
|
1729
|
+
# data as a hash:
|
1730
|
+
#
|
1731
|
+
# {
|
1732
|
+
# marker: "Marker",
|
1733
|
+
# limit: 1,
|
1734
|
+
# }
|
1735
|
+
# @!attribute [rw] marker
|
1736
|
+
# An opaque string that indicates the position at which to begin the
|
1737
|
+
# returned list of gateways.
|
1738
|
+
# @return [String]
|
1739
|
+
#
|
1740
|
+
# @!attribute [rw] limit
|
1741
|
+
# Specifies that the list of gateways returned be limited to the
|
1742
|
+
# specified number of items.
|
1743
|
+
# @return [Integer]
|
1744
|
+
class ListGatewaysInput < Struct.new(
|
1745
|
+
:marker,
|
1746
|
+
:limit)
|
1747
|
+
include Aws::Structure
|
1748
|
+
end
|
1749
|
+
|
1750
|
+
# @!attribute [rw] gateways
|
1751
|
+
# @return [Array<Types::GatewayInfo>]
|
1752
|
+
#
|
1753
|
+
# @!attribute [rw] marker
|
1754
|
+
# @return [String]
|
1755
|
+
class ListGatewaysOutput < Struct.new(
|
1756
|
+
:gateways,
|
1757
|
+
:marker)
|
1758
|
+
include Aws::Structure
|
1759
|
+
end
|
1760
|
+
|
1761
|
+
# A JSON object containing the of the gateway.
|
1762
|
+
# @note When making an API call, pass ListLocalDisksInput
|
1763
|
+
# data as a hash:
|
1764
|
+
#
|
1765
|
+
# {
|
1766
|
+
# gateway_arn: "GatewayARN", # required
|
1767
|
+
# }
|
1768
|
+
# @!attribute [rw] gateway_arn
|
1769
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1770
|
+
# operation to return a list of gateways for your account and region.
|
1771
|
+
# @return [String]
|
1772
|
+
class ListLocalDisksInput < Struct.new(
|
1773
|
+
:gateway_arn)
|
1774
|
+
include Aws::Structure
|
1775
|
+
end
|
1776
|
+
|
1777
|
+
# @!attribute [rw] gateway_arn
|
1778
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1779
|
+
# operation to return a list of gateways for your account and region.
|
1780
|
+
# @return [String]
|
1781
|
+
#
|
1782
|
+
# @!attribute [rw] disks
|
1783
|
+
# @return [Array<Types::Disk>]
|
1784
|
+
class ListLocalDisksOutput < Struct.new(
|
1785
|
+
:gateway_arn,
|
1786
|
+
:disks)
|
1787
|
+
include Aws::Structure
|
1788
|
+
end
|
1789
|
+
|
1790
|
+
# ListTagsForResourceInput
|
1791
|
+
# @note When making an API call, pass ListTagsForResourceInput
|
1792
|
+
# data as a hash:
|
1793
|
+
#
|
1794
|
+
# {
|
1795
|
+
# resource_arn: "ResourceARN", # required
|
1796
|
+
# marker: "Marker",
|
1797
|
+
# limit: 1,
|
1798
|
+
# }
|
1799
|
+
# @!attribute [rw] resource_arn
|
1800
|
+
# The Amazon Resource Name (ARN) of the resource for which you want to
|
1801
|
+
# list tags.
|
1802
|
+
# @return [String]
|
1803
|
+
#
|
1804
|
+
# @!attribute [rw] marker
|
1805
|
+
# An opaque string that indicates the position at which to begin
|
1806
|
+
# returning the list of tags.
|
1807
|
+
# @return [String]
|
1808
|
+
#
|
1809
|
+
# @!attribute [rw] limit
|
1810
|
+
# Specifies that the list of tags returned be limited to the specified
|
1811
|
+
# number of items.
|
1812
|
+
# @return [Integer]
|
1813
|
+
class ListTagsForResourceInput < Struct.new(
|
1814
|
+
:resource_arn,
|
1815
|
+
:marker,
|
1816
|
+
:limit)
|
1817
|
+
include Aws::Structure
|
1818
|
+
end
|
1819
|
+
|
1820
|
+
# ListTagsForResourceOutput
|
1821
|
+
# @!attribute [rw] resource_arn
|
1822
|
+
# he Amazon Resource Name (ARN) of the resource for which you want to
|
1823
|
+
# list tags.
|
1824
|
+
# @return [String]
|
1825
|
+
#
|
1826
|
+
# @!attribute [rw] marker
|
1827
|
+
# An opaque string that indicates the position at which to stop
|
1828
|
+
# returning the list of tags.
|
1829
|
+
# @return [String]
|
1830
|
+
#
|
1831
|
+
# @!attribute [rw] tags
|
1832
|
+
# An array that contains the tags for the specified resource.
|
1833
|
+
# @return [Array<Types::Tag>]
|
1834
|
+
class ListTagsForResourceOutput < Struct.new(
|
1835
|
+
:resource_arn,
|
1836
|
+
:marker,
|
1837
|
+
:tags)
|
1838
|
+
include Aws::Structure
|
1839
|
+
end
|
1840
|
+
|
1841
|
+
# A JSON object that contains one or more of the following fields:
|
1842
|
+
#
|
1843
|
+
# * ListTapesInput$Limit
|
1844
|
+
#
|
1845
|
+
# * ListTapesInput$Marker
|
1846
|
+
#
|
1847
|
+
# * ListTapesInput$TapeARNs
|
1848
|
+
# @note When making an API call, pass ListTapesInput
|
1849
|
+
# data as a hash:
|
1850
|
+
#
|
1851
|
+
# {
|
1852
|
+
# tape_arns: ["TapeARN"],
|
1853
|
+
# marker: "Marker",
|
1854
|
+
# limit: 1,
|
1855
|
+
# }
|
1856
|
+
# @!attribute [rw] tape_arns
|
1857
|
+
# The Amazon Resource Name (ARN) of each of the tapes you want to
|
1858
|
+
# list. If you don't specify a tape ARN, the response lists all tapes
|
1859
|
+
# in both your VTL and VTS.
|
1860
|
+
# @return [Array<String>]
|
1861
|
+
#
|
1862
|
+
# @!attribute [rw] marker
|
1863
|
+
# A string that indicates the position at which to begin the returned
|
1864
|
+
# list of tapes.
|
1865
|
+
# @return [String]
|
1866
|
+
#
|
1867
|
+
# @!attribute [rw] limit
|
1868
|
+
# An optional number limit for the tapes in the list returned by this
|
1869
|
+
# call.
|
1870
|
+
# @return [Integer]
|
1871
|
+
class ListTapesInput < Struct.new(
|
1872
|
+
:tape_arns,
|
1873
|
+
:marker,
|
1874
|
+
:limit)
|
1875
|
+
include Aws::Structure
|
1876
|
+
end
|
1877
|
+
|
1878
|
+
# A JSON object containing the following fields:
|
1879
|
+
#
|
1880
|
+
# * ListTapesOutput$Marker
|
1881
|
+
#
|
1882
|
+
# * ListTapesOutput$VolumeInfos
|
1883
|
+
# @!attribute [rw] tape_infos
|
1884
|
+
# An array of TapeInfo objects, where each object describes an a
|
1885
|
+
# single tape. If there not tapes in the tape library or VTS, then the
|
1886
|
+
# `TapeInfos` is an empty array.
|
1887
|
+
# @return [Array<Types::TapeInfo>]
|
1888
|
+
#
|
1889
|
+
# @!attribute [rw] marker
|
1890
|
+
# A string that indicates the position at which to begin returning the
|
1891
|
+
# next list of tapes. Use the marker in your next request to continue
|
1892
|
+
# pagination of tapes. If there are no more tapes to list, this
|
1893
|
+
# element does not appear in the response body.
|
1894
|
+
# @return [String]
|
1895
|
+
class ListTapesOutput < Struct.new(
|
1896
|
+
:tape_infos,
|
1897
|
+
:marker)
|
1898
|
+
include Aws::Structure
|
1899
|
+
end
|
1900
|
+
|
1901
|
+
# ListVolumeInitiatorsInput
|
1902
|
+
# @note When making an API call, pass ListVolumeInitiatorsInput
|
1903
|
+
# data as a hash:
|
1904
|
+
#
|
1905
|
+
# {
|
1906
|
+
# volume_arn: "VolumeARN", # required
|
1907
|
+
# }
|
1908
|
+
# @!attribute [rw] volume_arn
|
1909
|
+
# The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
|
1910
|
+
# operation to return a list of gateway volumes for the gateway.
|
1911
|
+
# @return [String]
|
1912
|
+
class ListVolumeInitiatorsInput < Struct.new(
|
1913
|
+
:volume_arn)
|
1914
|
+
include Aws::Structure
|
1915
|
+
end
|
1916
|
+
|
1917
|
+
# ListVolumeInitiatorsOutput
|
1918
|
+
# @!attribute [rw] initiators
|
1919
|
+
# The host names and port numbers of all iSCSI initiators that are
|
1920
|
+
# connected to the gateway.
|
1921
|
+
# @return [Array<String>]
|
1922
|
+
class ListVolumeInitiatorsOutput < Struct.new(
|
1923
|
+
:initiators)
|
1924
|
+
include Aws::Structure
|
1925
|
+
end
|
1926
|
+
|
1927
|
+
# @note When making an API call, pass ListVolumeRecoveryPointsInput
|
1928
|
+
# data as a hash:
|
1929
|
+
#
|
1930
|
+
# {
|
1931
|
+
# gateway_arn: "GatewayARN", # required
|
1932
|
+
# }
|
1933
|
+
# @!attribute [rw] gateway_arn
|
1934
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1935
|
+
# operation to return a list of gateways for your account and region.
|
1936
|
+
# @return [String]
|
1937
|
+
class ListVolumeRecoveryPointsInput < Struct.new(
|
1938
|
+
:gateway_arn)
|
1939
|
+
include Aws::Structure
|
1940
|
+
end
|
1941
|
+
|
1942
|
+
# @!attribute [rw] gateway_arn
|
1943
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1944
|
+
# operation to return a list of gateways for your account and region.
|
1945
|
+
# @return [String]
|
1946
|
+
#
|
1947
|
+
# @!attribute [rw] volume_recovery_point_infos
|
1948
|
+
# @return [Array<Types::VolumeRecoveryPointInfo>]
|
1949
|
+
class ListVolumeRecoveryPointsOutput < Struct.new(
|
1950
|
+
:gateway_arn,
|
1951
|
+
:volume_recovery_point_infos)
|
1952
|
+
include Aws::Structure
|
1953
|
+
end
|
1954
|
+
|
1955
|
+
# A JSON object that contains one or more of the following fields:
|
1956
|
+
#
|
1957
|
+
# * ListVolumesInput$Limit
|
1958
|
+
#
|
1959
|
+
# * ListVolumesInput$Marker
|
1960
|
+
# @note When making an API call, pass ListVolumesInput
|
1961
|
+
# data as a hash:
|
1962
|
+
#
|
1963
|
+
# {
|
1964
|
+
# gateway_arn: "GatewayARN",
|
1965
|
+
# marker: "Marker",
|
1966
|
+
# limit: 1,
|
1967
|
+
# }
|
1968
|
+
# @!attribute [rw] gateway_arn
|
1969
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1970
|
+
# operation to return a list of gateways for your account and region.
|
1971
|
+
# @return [String]
|
1972
|
+
#
|
1973
|
+
# @!attribute [rw] marker
|
1974
|
+
# A string that indicates the position at which to begin the returned
|
1975
|
+
# list of volumes. Obtain the marker from the response of a previous
|
1976
|
+
# List iSCSI Volumes request.
|
1977
|
+
# @return [String]
|
1978
|
+
#
|
1979
|
+
# @!attribute [rw] limit
|
1980
|
+
# Specifies that the list of volumes returned be limited to the
|
1981
|
+
# specified number of items.
|
1982
|
+
# @return [Integer]
|
1983
|
+
class ListVolumesInput < Struct.new(
|
1984
|
+
:gateway_arn,
|
1985
|
+
:marker,
|
1986
|
+
:limit)
|
1987
|
+
include Aws::Structure
|
1988
|
+
end
|
1989
|
+
|
1990
|
+
# @!attribute [rw] gateway_arn
|
1991
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1992
|
+
# operation to return a list of gateways for your account and region.
|
1993
|
+
# @return [String]
|
1994
|
+
#
|
1995
|
+
# @!attribute [rw] marker
|
1996
|
+
# @return [String]
|
1997
|
+
#
|
1998
|
+
# @!attribute [rw] volume_infos
|
1999
|
+
# @return [Array<Types::VolumeInfo>]
|
2000
|
+
class ListVolumesOutput < Struct.new(
|
2001
|
+
:gateway_arn,
|
2002
|
+
:marker,
|
2003
|
+
:volume_infos)
|
2004
|
+
include Aws::Structure
|
2005
|
+
end
|
2006
|
+
|
2007
|
+
# Describes a gateway's network interface.
|
2008
|
+
# @!attribute [rw] ipv_4_address
|
2009
|
+
# The Internet Protocol version 4 (IPv4) address of the interface.
|
2010
|
+
# @return [String]
|
2011
|
+
#
|
2012
|
+
# @!attribute [rw] mac_address
|
2013
|
+
# The Media Access Control (MAC) address of the interface.
|
2014
|
+
#
|
2015
|
+
# <note markdown="1">This is currently unsupported and will not be returned in output.
|
2016
|
+
#
|
2017
|
+
# </note>
|
2018
|
+
# @return [String]
|
2019
|
+
#
|
2020
|
+
# @!attribute [rw] ipv_6_address
|
2021
|
+
# The Internet Protocol version 6 (IPv6) address of the interface.
|
2022
|
+
# *Currently not supported*.
|
2023
|
+
# @return [String]
|
2024
|
+
class NetworkInterface < Struct.new(
|
2025
|
+
:ipv_4_address,
|
2026
|
+
:mac_address,
|
2027
|
+
:ipv_6_address)
|
2028
|
+
include Aws::Structure
|
2029
|
+
end
|
2030
|
+
|
2031
|
+
# RemoveTagsFromResourceInput
|
2032
|
+
# @note When making an API call, pass RemoveTagsFromResourceInput
|
2033
|
+
# data as a hash:
|
2034
|
+
#
|
2035
|
+
# {
|
2036
|
+
# resource_arn: "ResourceARN", # required
|
2037
|
+
# tag_keys: ["TagKey"], # required
|
2038
|
+
# }
|
2039
|
+
# @!attribute [rw] resource_arn
|
2040
|
+
# The Amazon Resource Name (ARN) of the resource you want to remove
|
2041
|
+
# the tags from.
|
2042
|
+
# @return [String]
|
2043
|
+
#
|
2044
|
+
# @!attribute [rw] tag_keys
|
2045
|
+
# The keys of the tags you want to remove from the specified resource.
|
2046
|
+
# A tag is composed of a key/value pair.
|
2047
|
+
# @return [Array<String>]
|
2048
|
+
class RemoveTagsFromResourceInput < Struct.new(
|
2049
|
+
:resource_arn,
|
2050
|
+
:tag_keys)
|
2051
|
+
include Aws::Structure
|
2052
|
+
end
|
2053
|
+
|
2054
|
+
# RemoveTagsFromResourceOutput
|
2055
|
+
# @!attribute [rw] resource_arn
|
2056
|
+
# The Amazon Resource Name (ARN) of the resource that the tags were
|
2057
|
+
# removed from.
|
2058
|
+
# @return [String]
|
2059
|
+
class RemoveTagsFromResourceOutput < Struct.new(
|
2060
|
+
:resource_arn)
|
2061
|
+
include Aws::Structure
|
2062
|
+
end
|
2063
|
+
|
2064
|
+
# @note When making an API call, pass ResetCacheInput
|
2065
|
+
# data as a hash:
|
2066
|
+
#
|
2067
|
+
# {
|
2068
|
+
# gateway_arn: "GatewayARN", # required
|
2069
|
+
# }
|
2070
|
+
# @!attribute [rw] gateway_arn
|
2071
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2072
|
+
# operation to return a list of gateways for your account and region.
|
2073
|
+
# @return [String]
|
2074
|
+
class ResetCacheInput < Struct.new(
|
2075
|
+
:gateway_arn)
|
2076
|
+
include Aws::Structure
|
2077
|
+
end
|
2078
|
+
|
2079
|
+
# @!attribute [rw] gateway_arn
|
2080
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2081
|
+
# operation to return a list of gateways for your account and region.
|
2082
|
+
# @return [String]
|
2083
|
+
class ResetCacheOutput < Struct.new(
|
2084
|
+
:gateway_arn)
|
2085
|
+
include Aws::Structure
|
2086
|
+
end
|
2087
|
+
|
2088
|
+
# RetrieveTapeArchiveInput
|
2089
|
+
# @note When making an API call, pass RetrieveTapeArchiveInput
|
2090
|
+
# data as a hash:
|
2091
|
+
#
|
2092
|
+
# {
|
2093
|
+
# tape_arn: "TapeARN", # required
|
2094
|
+
# gateway_arn: "GatewayARN", # required
|
2095
|
+
# }
|
2096
|
+
# @!attribute [rw] tape_arn
|
2097
|
+
# The Amazon Resource Name (ARN) of the virtual tape you want to
|
2098
|
+
# retrieve from the virtual tape shelf (VTS).
|
2099
|
+
# @return [String]
|
2100
|
+
#
|
2101
|
+
# @!attribute [rw] gateway_arn
|
2102
|
+
# The Amazon Resource Name (ARN) of the gateway you want to retrieve
|
2103
|
+
# the virtual tape to. Use the ListGateways operation to return a list
|
2104
|
+
# of gateways for your account and region.
|
2105
|
+
#
|
2106
|
+
# You retrieve archived virtual tapes to only one gateway and the
|
2107
|
+
# gateway must be a gateway-VTL.
|
2108
|
+
# @return [String]
|
2109
|
+
class RetrieveTapeArchiveInput < Struct.new(
|
2110
|
+
:tape_arn,
|
2111
|
+
:gateway_arn)
|
2112
|
+
include Aws::Structure
|
2113
|
+
end
|
2114
|
+
|
2115
|
+
# RetrieveTapeArchiveOutput
|
2116
|
+
# @!attribute [rw] tape_arn
|
2117
|
+
# The Amazon Resource Name (ARN) of the retrieved virtual tape.
|
2118
|
+
# @return [String]
|
2119
|
+
class RetrieveTapeArchiveOutput < Struct.new(
|
2120
|
+
:tape_arn)
|
2121
|
+
include Aws::Structure
|
2122
|
+
end
|
2123
|
+
|
2124
|
+
# RetrieveTapeRecoveryPointInput
|
2125
|
+
# @note When making an API call, pass RetrieveTapeRecoveryPointInput
|
2126
|
+
# data as a hash:
|
2127
|
+
#
|
2128
|
+
# {
|
2129
|
+
# tape_arn: "TapeARN", # required
|
2130
|
+
# gateway_arn: "GatewayARN", # required
|
2131
|
+
# }
|
2132
|
+
# @!attribute [rw] tape_arn
|
2133
|
+
# The Amazon Resource Name (ARN) of the virtual tape for which you
|
2134
|
+
# want to retrieve the recovery point.
|
2135
|
+
# @return [String]
|
2136
|
+
#
|
2137
|
+
# @!attribute [rw] gateway_arn
|
2138
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2139
|
+
# operation to return a list of gateways for your account and region.
|
2140
|
+
# @return [String]
|
2141
|
+
class RetrieveTapeRecoveryPointInput < Struct.new(
|
2142
|
+
:tape_arn,
|
2143
|
+
:gateway_arn)
|
2144
|
+
include Aws::Structure
|
2145
|
+
end
|
2146
|
+
|
2147
|
+
# RetrieveTapeRecoveryPointOutput
|
2148
|
+
# @!attribute [rw] tape_arn
|
2149
|
+
# The Amazon Resource Name (ARN) of the virtual tape for which the
|
2150
|
+
# recovery point was retrieved.
|
2151
|
+
# @return [String]
|
2152
|
+
class RetrieveTapeRecoveryPointOutput < Struct.new(
|
2153
|
+
:tape_arn)
|
2154
|
+
include Aws::Structure
|
2155
|
+
end
|
2156
|
+
|
2157
|
+
# SetLocalConsolePasswordInput
|
2158
|
+
# @note When making an API call, pass SetLocalConsolePasswordInput
|
2159
|
+
# data as a hash:
|
2160
|
+
#
|
2161
|
+
# {
|
2162
|
+
# gateway_arn: "GatewayARN", # required
|
2163
|
+
# local_console_password: "LocalConsolePassword", # required
|
2164
|
+
# }
|
2165
|
+
# @!attribute [rw] gateway_arn
|
2166
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2167
|
+
# operation to return a list of gateways for your account and region.
|
2168
|
+
# @return [String]
|
2169
|
+
#
|
2170
|
+
# @!attribute [rw] local_console_password
|
2171
|
+
# The password you want to set for your VM local console.
|
2172
|
+
# @return [String]
|
2173
|
+
class SetLocalConsolePasswordInput < Struct.new(
|
2174
|
+
:gateway_arn,
|
2175
|
+
:local_console_password)
|
2176
|
+
include Aws::Structure
|
2177
|
+
end
|
2178
|
+
|
2179
|
+
# @!attribute [rw] gateway_arn
|
2180
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2181
|
+
# operation to return a list of gateways for your account and region.
|
2182
|
+
# @return [String]
|
2183
|
+
class SetLocalConsolePasswordOutput < Struct.new(
|
2184
|
+
:gateway_arn)
|
2185
|
+
include Aws::Structure
|
2186
|
+
end
|
2187
|
+
|
2188
|
+
# A JSON object containing the of the gateway to shut down.
|
2189
|
+
# @note When making an API call, pass ShutdownGatewayInput
|
2190
|
+
# data as a hash:
|
2191
|
+
#
|
2192
|
+
# {
|
2193
|
+
# gateway_arn: "GatewayARN", # required
|
2194
|
+
# }
|
2195
|
+
# @!attribute [rw] gateway_arn
|
2196
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2197
|
+
# operation to return a list of gateways for your account and region.
|
2198
|
+
# @return [String]
|
2199
|
+
class ShutdownGatewayInput < Struct.new(
|
2200
|
+
:gateway_arn)
|
2201
|
+
include Aws::Structure
|
2202
|
+
end
|
2203
|
+
|
2204
|
+
# A JSON object containing the of the gateway that was shut down.
|
2205
|
+
# @!attribute [rw] gateway_arn
|
2206
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2207
|
+
# operation to return a list of gateways for your account and region.
|
2208
|
+
# @return [String]
|
2209
|
+
class ShutdownGatewayOutput < Struct.new(
|
2210
|
+
:gateway_arn)
|
2211
|
+
include Aws::Structure
|
2212
|
+
end
|
2213
|
+
|
2214
|
+
# A JSON object containing the of the gateway to start.
|
2215
|
+
# @note When making an API call, pass StartGatewayInput
|
2216
|
+
# data as a hash:
|
2217
|
+
#
|
2218
|
+
# {
|
2219
|
+
# gateway_arn: "GatewayARN", # required
|
2220
|
+
# }
|
2221
|
+
# @!attribute [rw] gateway_arn
|
2222
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2223
|
+
# operation to return a list of gateways for your account and region.
|
2224
|
+
# @return [String]
|
2225
|
+
class StartGatewayInput < Struct.new(
|
2226
|
+
:gateway_arn)
|
2227
|
+
include Aws::Structure
|
2228
|
+
end
|
2229
|
+
|
2230
|
+
# A JSON object containing the of the gateway that was restarted.
|
2231
|
+
# @!attribute [rw] gateway_arn
|
2232
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2233
|
+
# operation to return a list of gateways for your account and region.
|
2234
|
+
# @return [String]
|
2235
|
+
class StartGatewayOutput < Struct.new(
|
2236
|
+
:gateway_arn)
|
2237
|
+
include Aws::Structure
|
2238
|
+
end
|
2239
|
+
|
2240
|
+
# Provides additional information about an error that was returned by
|
2241
|
+
# the service as an or. See the `errorCode` and `errorDetails` members
|
2242
|
+
# for more information about the error.
|
2243
|
+
# @!attribute [rw] error_code
|
2244
|
+
# Additional information about the error.
|
2245
|
+
# @return [String]
|
2246
|
+
#
|
2247
|
+
# @!attribute [rw] error_details
|
2248
|
+
# Human-readable text that provides detail about the error that
|
2249
|
+
# occurred.
|
2250
|
+
# @return [Hash<String,String>]
|
2251
|
+
class StorageGatewayError < Struct.new(
|
2252
|
+
:error_code,
|
2253
|
+
:error_details)
|
2254
|
+
include Aws::Structure
|
2255
|
+
end
|
2256
|
+
|
2257
|
+
# @!attribute [rw] volume_arn
|
2258
|
+
# @return [String]
|
2259
|
+
#
|
2260
|
+
# @!attribute [rw] volume_id
|
2261
|
+
# @return [String]
|
2262
|
+
#
|
2263
|
+
# @!attribute [rw] volume_type
|
2264
|
+
# @return [String]
|
2265
|
+
#
|
2266
|
+
# @!attribute [rw] volume_status
|
2267
|
+
# @return [String]
|
2268
|
+
#
|
2269
|
+
# @!attribute [rw] volume_size_in_bytes
|
2270
|
+
# @return [Integer]
|
2271
|
+
#
|
2272
|
+
# @!attribute [rw] volume_progress
|
2273
|
+
# @return [Float]
|
2274
|
+
#
|
2275
|
+
# @!attribute [rw] volume_disk_id
|
2276
|
+
# @return [String]
|
2277
|
+
#
|
2278
|
+
# @!attribute [rw] source_snapshot_id
|
2279
|
+
# @return [String]
|
2280
|
+
#
|
2281
|
+
# @!attribute [rw] preserved_existing_data
|
2282
|
+
# @return [Boolean]
|
2283
|
+
#
|
2284
|
+
# @!attribute [rw] volume_iscsi_attributes
|
2285
|
+
# Lists iSCSI information about a volume.
|
2286
|
+
# @return [Types::VolumeiSCSIAttributes]
|
2287
|
+
class StorediSCSIVolume < Struct.new(
|
2288
|
+
:volume_arn,
|
2289
|
+
:volume_id,
|
2290
|
+
:volume_type,
|
2291
|
+
:volume_status,
|
2292
|
+
:volume_size_in_bytes,
|
2293
|
+
:volume_progress,
|
2294
|
+
:volume_disk_id,
|
2295
|
+
:source_snapshot_id,
|
2296
|
+
:preserved_existing_data,
|
2297
|
+
:volume_iscsi_attributes)
|
2298
|
+
include Aws::Structure
|
2299
|
+
end
|
2300
|
+
|
2301
|
+
# @note When making an API call, pass Tag
|
2302
|
+
# data as a hash:
|
2303
|
+
#
|
2304
|
+
# {
|
2305
|
+
# key: "TagKey", # required
|
2306
|
+
# value: "TagValue", # required
|
2307
|
+
# }
|
2308
|
+
# @!attribute [rw] key
|
2309
|
+
# @return [String]
|
2310
|
+
#
|
2311
|
+
# @!attribute [rw] value
|
2312
|
+
# @return [String]
|
2313
|
+
class Tag < Struct.new(
|
2314
|
+
:key,
|
2315
|
+
:value)
|
2316
|
+
include Aws::Structure
|
2317
|
+
end
|
2318
|
+
|
2319
|
+
# Describes a virtual tape object.
|
2320
|
+
# @!attribute [rw] tape_arn
|
2321
|
+
# The Amazon Resource Name (ARN) of the virtual tape.
|
2322
|
+
# @return [String]
|
2323
|
+
#
|
2324
|
+
# @!attribute [rw] tape_barcode
|
2325
|
+
# The barcode that identifies a specific virtual tape.
|
2326
|
+
# @return [String]
|
2327
|
+
#
|
2328
|
+
# @!attribute [rw] tape_size_in_bytes
|
2329
|
+
# The size, in bytes, of the virtual tape.
|
2330
|
+
# @return [Integer]
|
2331
|
+
#
|
2332
|
+
# @!attribute [rw] tape_status
|
2333
|
+
# The current state of the virtual tape.
|
2334
|
+
# @return [String]
|
2335
|
+
#
|
2336
|
+
# @!attribute [rw] vtl_device
|
2337
|
+
# The virtual tape library (VTL) device that the virtual tape is
|
2338
|
+
# associated with.
|
2339
|
+
# @return [String]
|
2340
|
+
#
|
2341
|
+
# @!attribute [rw] progress
|
2342
|
+
# For archiving virtual tapes, indicates how much data remains to be
|
2343
|
+
# uploaded before archiving is complete.
|
2344
|
+
#
|
2345
|
+
# Range: 0 (not started) to 100 (complete).
|
2346
|
+
# @return [Float]
|
2347
|
+
class Tape < Struct.new(
|
2348
|
+
:tape_arn,
|
2349
|
+
:tape_barcode,
|
2350
|
+
:tape_size_in_bytes,
|
2351
|
+
:tape_status,
|
2352
|
+
:vtl_device,
|
2353
|
+
:progress)
|
2354
|
+
include Aws::Structure
|
2355
|
+
end
|
2356
|
+
|
2357
|
+
# Represents a virtual tape that is archived in the virtual tape shelf
|
2358
|
+
# (VTS).
|
2359
|
+
# @!attribute [rw] tape_arn
|
2360
|
+
# The Amazon Resource Name (ARN) of an archived virtual tape.
|
2361
|
+
# @return [String]
|
2362
|
+
#
|
2363
|
+
# @!attribute [rw] tape_barcode
|
2364
|
+
# The barcode that identifies the archived virtual tape.
|
2365
|
+
# @return [String]
|
2366
|
+
#
|
2367
|
+
# @!attribute [rw] tape_size_in_bytes
|
2368
|
+
# The size, in bytes, of the archived virtual tape.
|
2369
|
+
# @return [Integer]
|
2370
|
+
#
|
2371
|
+
# @!attribute [rw] completion_time
|
2372
|
+
# The time that the archiving of the virtual tape was completed.
|
2373
|
+
#
|
2374
|
+
# The string format of the completion time is in the ISO8601 extended
|
2375
|
+
# YYYY-MM-DD'T'HH:MM:SS'Z' format.
|
2376
|
+
# @return [Time]
|
2377
|
+
#
|
2378
|
+
# @!attribute [rw] retrieved_to
|
2379
|
+
# The Amazon Resource Name (ARN) of the gateway-VTL that the virtual
|
2380
|
+
# tape is being retrieved to.
|
2381
|
+
#
|
2382
|
+
# The virtual tape is retrieved from the virtual tape shelf (VTS).
|
2383
|
+
# @return [String]
|
2384
|
+
#
|
2385
|
+
# @!attribute [rw] tape_status
|
2386
|
+
# The current state of the archived virtual tape.
|
2387
|
+
# @return [String]
|
2388
|
+
class TapeArchive < Struct.new(
|
2389
|
+
:tape_arn,
|
2390
|
+
:tape_barcode,
|
2391
|
+
:tape_size_in_bytes,
|
2392
|
+
:completion_time,
|
2393
|
+
:retrieved_to,
|
2394
|
+
:tape_status)
|
2395
|
+
include Aws::Structure
|
2396
|
+
end
|
2397
|
+
|
2398
|
+
# Describes a virtual tape.
|
2399
|
+
# @!attribute [rw] tape_arn
|
2400
|
+
# The Amazon Resource Name (ARN) of a virtual tape.
|
2401
|
+
# @return [String]
|
2402
|
+
#
|
2403
|
+
# @!attribute [rw] tape_barcode
|
2404
|
+
# The barcode that identifies a specific virtual tape.
|
2405
|
+
# @return [String]
|
2406
|
+
#
|
2407
|
+
# @!attribute [rw] tape_size_in_bytes
|
2408
|
+
# The size, in bytes, of a virtual tape.
|
2409
|
+
# @return [Integer]
|
2410
|
+
#
|
2411
|
+
# @!attribute [rw] tape_status
|
2412
|
+
# The status of the tape.
|
2413
|
+
# @return [String]
|
2414
|
+
#
|
2415
|
+
# @!attribute [rw] gateway_arn
|
2416
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2417
|
+
# operation to return a list of gateways for your account and region.
|
2418
|
+
# @return [String]
|
2419
|
+
class TapeInfo < Struct.new(
|
2420
|
+
:tape_arn,
|
2421
|
+
:tape_barcode,
|
2422
|
+
:tape_size_in_bytes,
|
2423
|
+
:tape_status,
|
2424
|
+
:gateway_arn)
|
2425
|
+
include Aws::Structure
|
2426
|
+
end
|
2427
|
+
|
2428
|
+
# Describes a recovery point.
|
2429
|
+
# @!attribute [rw] tape_arn
|
2430
|
+
# The Amazon Resource Name (ARN) of the virtual tape.
|
2431
|
+
# @return [String]
|
2432
|
+
#
|
2433
|
+
# @!attribute [rw] tape_recovery_point_time
|
2434
|
+
# The time when the point-in-time view of the virtual tape was
|
2435
|
+
# replicated for later recovery.
|
2436
|
+
#
|
2437
|
+
# The string format of the tape recovery point time is in the ISO8601
|
2438
|
+
# extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
|
2439
|
+
# @return [Time]
|
2440
|
+
#
|
2441
|
+
# @!attribute [rw] tape_size_in_bytes
|
2442
|
+
# The size, in bytes, of the virtual tapes to recover.
|
2443
|
+
# @return [Integer]
|
2444
|
+
#
|
2445
|
+
# @!attribute [rw] tape_status
|
2446
|
+
# @return [String]
|
2447
|
+
class TapeRecoveryPointInfo < Struct.new(
|
2448
|
+
:tape_arn,
|
2449
|
+
:tape_recovery_point_time,
|
2450
|
+
:tape_size_in_bytes,
|
2451
|
+
:tape_status)
|
2452
|
+
include Aws::Structure
|
2453
|
+
end
|
2454
|
+
|
2455
|
+
# A JSON object containing one or more of the following fields:
|
2456
|
+
#
|
2457
|
+
# * UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSec
|
2458
|
+
#
|
2459
|
+
# * UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec
|
2460
|
+
# @note When making an API call, pass UpdateBandwidthRateLimitInput
|
2461
|
+
# data as a hash:
|
2462
|
+
#
|
2463
|
+
# {
|
2464
|
+
# gateway_arn: "GatewayARN", # required
|
2465
|
+
# average_upload_rate_limit_in_bits_per_sec: 1,
|
2466
|
+
# average_download_rate_limit_in_bits_per_sec: 1,
|
2467
|
+
# }
|
2468
|
+
# @!attribute [rw] gateway_arn
|
2469
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2470
|
+
# operation to return a list of gateways for your account and region.
|
2471
|
+
# @return [String]
|
2472
|
+
#
|
2473
|
+
# @!attribute [rw] average_upload_rate_limit_in_bits_per_sec
|
2474
|
+
# The average upload bandwidth rate limit in bits per second.
|
2475
|
+
# @return [Integer]
|
2476
|
+
#
|
2477
|
+
# @!attribute [rw] average_download_rate_limit_in_bits_per_sec
|
2478
|
+
# The average download bandwidth rate limit in bits per second.
|
2479
|
+
# @return [Integer]
|
2480
|
+
class UpdateBandwidthRateLimitInput < Struct.new(
|
2481
|
+
:gateway_arn,
|
2482
|
+
:average_upload_rate_limit_in_bits_per_sec,
|
2483
|
+
:average_download_rate_limit_in_bits_per_sec)
|
2484
|
+
include Aws::Structure
|
2485
|
+
end
|
2486
|
+
|
2487
|
+
# A JSON object containing the of the gateway whose throttle information
|
2488
|
+
# was updated.
|
2489
|
+
# @!attribute [rw] gateway_arn
|
2490
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2491
|
+
# operation to return a list of gateways for your account and region.
|
2492
|
+
# @return [String]
|
2493
|
+
class UpdateBandwidthRateLimitOutput < Struct.new(
|
2494
|
+
:gateway_arn)
|
2495
|
+
include Aws::Structure
|
2496
|
+
end
|
2497
|
+
|
2498
|
+
# A JSON object containing one or more of the following fields:
|
2499
|
+
#
|
2500
|
+
# * UpdateChapCredentialsInput$InitiatorName
|
2501
|
+
#
|
2502
|
+
# * UpdateChapCredentialsInput$SecretToAuthenticateInitiator
|
2503
|
+
#
|
2504
|
+
# * UpdateChapCredentialsInput$SecretToAuthenticateTarget
|
2505
|
+
#
|
2506
|
+
# * UpdateChapCredentialsInput$TargetARN
|
2507
|
+
# @note When making an API call, pass UpdateChapCredentialsInput
|
2508
|
+
# data as a hash:
|
2509
|
+
#
|
2510
|
+
# {
|
2511
|
+
# target_arn: "TargetARN", # required
|
2512
|
+
# secret_to_authenticate_initiator: "ChapSecret", # required
|
2513
|
+
# initiator_name: "IqnName", # required
|
2514
|
+
# secret_to_authenticate_target: "ChapSecret",
|
2515
|
+
# }
|
2516
|
+
# @!attribute [rw] target_arn
|
2517
|
+
# The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
|
2518
|
+
# DescribeStorediSCSIVolumes operation to return the TargetARN for
|
2519
|
+
# specified VolumeARN.
|
2520
|
+
# @return [String]
|
2521
|
+
#
|
2522
|
+
# @!attribute [rw] secret_to_authenticate_initiator
|
2523
|
+
# The secret key that the initiator (for example, the Windows client)
|
2524
|
+
# must provide to participate in mutual CHAP with the target.
|
2525
|
+
#
|
2526
|
+
# <note markdown="1">The secret key must be between 12 and 16 bytes when encoded in
|
2527
|
+
# UTF-8.
|
2528
|
+
#
|
2529
|
+
# </note>
|
2530
|
+
# @return [String]
|
2531
|
+
#
|
2532
|
+
# @!attribute [rw] initiator_name
|
2533
|
+
# The iSCSI initiator that connects to the target.
|
2534
|
+
# @return [String]
|
2535
|
+
#
|
2536
|
+
# @!attribute [rw] secret_to_authenticate_target
|
2537
|
+
# The secret key that the target must provide to participate in mutual
|
2538
|
+
# CHAP with the initiator (e.g. Windows client).
|
2539
|
+
#
|
2540
|
+
# Byte constraints: Minimum bytes of 12. Maximum bytes of 16.
|
2541
|
+
#
|
2542
|
+
# <note markdown="1">The secret key must be between 12 and 16 bytes when encoded in
|
2543
|
+
# UTF-8.
|
2544
|
+
#
|
2545
|
+
# </note>
|
2546
|
+
# @return [String]
|
2547
|
+
class UpdateChapCredentialsInput < Struct.new(
|
2548
|
+
:target_arn,
|
2549
|
+
:secret_to_authenticate_initiator,
|
2550
|
+
:initiator_name,
|
2551
|
+
:secret_to_authenticate_target)
|
2552
|
+
include Aws::Structure
|
2553
|
+
end
|
2554
|
+
|
2555
|
+
# A JSON object containing the following fields:
|
2556
|
+
# @!attribute [rw] target_arn
|
2557
|
+
# The Amazon Resource Name (ARN) of the target. This is the same
|
2558
|
+
# target specified in the request.
|
2559
|
+
# @return [String]
|
2560
|
+
#
|
2561
|
+
# @!attribute [rw] initiator_name
|
2562
|
+
# The iSCSI initiator that connects to the target. This is the same
|
2563
|
+
# initiator name specified in the request.
|
2564
|
+
# @return [String]
|
2565
|
+
class UpdateChapCredentialsOutput < Struct.new(
|
2566
|
+
:target_arn,
|
2567
|
+
:initiator_name)
|
2568
|
+
include Aws::Structure
|
2569
|
+
end
|
2570
|
+
|
2571
|
+
# @note When making an API call, pass UpdateGatewayInformationInput
|
2572
|
+
# data as a hash:
|
2573
|
+
#
|
2574
|
+
# {
|
2575
|
+
# gateway_arn: "GatewayARN", # required
|
2576
|
+
# gateway_name: "GatewayName",
|
2577
|
+
# gateway_timezone: "GatewayTimezone",
|
2578
|
+
# }
|
2579
|
+
# @!attribute [rw] gateway_arn
|
2580
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2581
|
+
# operation to return a list of gateways for your account and region.
|
2582
|
+
# @return [String]
|
2583
|
+
#
|
2584
|
+
# @!attribute [rw] gateway_name
|
2585
|
+
# The name you configured for your gateway.
|
2586
|
+
# @return [String]
|
2587
|
+
#
|
2588
|
+
# @!attribute [rw] gateway_timezone
|
2589
|
+
# @return [String]
|
2590
|
+
class UpdateGatewayInformationInput < Struct.new(
|
2591
|
+
:gateway_arn,
|
2592
|
+
:gateway_name,
|
2593
|
+
:gateway_timezone)
|
2594
|
+
include Aws::Structure
|
2595
|
+
end
|
2596
|
+
|
2597
|
+
# A JSON object containing the ARN of the gateway that was updated.
|
2598
|
+
# @!attribute [rw] gateway_arn
|
2599
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2600
|
+
# operation to return a list of gateways for your account and region.
|
2601
|
+
# @return [String]
|
2602
|
+
#
|
2603
|
+
# @!attribute [rw] gateway_name
|
2604
|
+
# @return [String]
|
2605
|
+
class UpdateGatewayInformationOutput < Struct.new(
|
2606
|
+
:gateway_arn,
|
2607
|
+
:gateway_name)
|
2608
|
+
include Aws::Structure
|
2609
|
+
end
|
2610
|
+
|
2611
|
+
# A JSON object containing the of the gateway to update.
|
2612
|
+
# @note When making an API call, pass UpdateGatewaySoftwareNowInput
|
2613
|
+
# data as a hash:
|
2614
|
+
#
|
2615
|
+
# {
|
2616
|
+
# gateway_arn: "GatewayARN", # required
|
2617
|
+
# }
|
2618
|
+
# @!attribute [rw] gateway_arn
|
2619
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2620
|
+
# operation to return a list of gateways for your account and region.
|
2621
|
+
# @return [String]
|
2622
|
+
class UpdateGatewaySoftwareNowInput < Struct.new(
|
2623
|
+
:gateway_arn)
|
2624
|
+
include Aws::Structure
|
2625
|
+
end
|
2626
|
+
|
2627
|
+
# A JSON object containing the of the gateway that was updated.
|
2628
|
+
# @!attribute [rw] gateway_arn
|
2629
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2630
|
+
# operation to return a list of gateways for your account and region.
|
2631
|
+
# @return [String]
|
2632
|
+
class UpdateGatewaySoftwareNowOutput < Struct.new(
|
2633
|
+
:gateway_arn)
|
2634
|
+
include Aws::Structure
|
2635
|
+
end
|
2636
|
+
|
2637
|
+
# A JSON object containing the following fields:
|
2638
|
+
#
|
2639
|
+
# * UpdateMaintenanceStartTimeInput$DayOfWeek
|
2640
|
+
#
|
2641
|
+
# * UpdateMaintenanceStartTimeInput$HourOfDay
|
2642
|
+
#
|
2643
|
+
# * UpdateMaintenanceStartTimeInput$MinuteOfHour
|
2644
|
+
# @note When making an API call, pass UpdateMaintenanceStartTimeInput
|
2645
|
+
# data as a hash:
|
2646
|
+
#
|
2647
|
+
# {
|
2648
|
+
# gateway_arn: "GatewayARN", # required
|
2649
|
+
# hour_of_day: 1, # required
|
2650
|
+
# minute_of_hour: 1, # required
|
2651
|
+
# day_of_week: 1, # required
|
2652
|
+
# }
|
2653
|
+
# @!attribute [rw] gateway_arn
|
2654
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2655
|
+
# operation to return a list of gateways for your account and region.
|
2656
|
+
# @return [String]
|
2657
|
+
#
|
2658
|
+
# @!attribute [rw] hour_of_day
|
2659
|
+
# The hour component of the maintenance start time represented as
|
2660
|
+
# *hh*, where *hh* is the hour (00 to 23). The hour of the day is in
|
2661
|
+
# the time zone of the gateway.
|
2662
|
+
# @return [Integer]
|
2663
|
+
#
|
2664
|
+
# @!attribute [rw] minute_of_hour
|
2665
|
+
# The minute component of the maintenance start time represented as
|
2666
|
+
# *mm*, where *mm* is the minute (00 to 59). The minute of the hour is
|
2667
|
+
# in the time zone of the gateway.
|
2668
|
+
# @return [Integer]
|
2669
|
+
#
|
2670
|
+
# @!attribute [rw] day_of_week
|
2671
|
+
# The maintenance start time day of the week.
|
2672
|
+
# @return [Integer]
|
2673
|
+
class UpdateMaintenanceStartTimeInput < Struct.new(
|
2674
|
+
:gateway_arn,
|
2675
|
+
:hour_of_day,
|
2676
|
+
:minute_of_hour,
|
2677
|
+
:day_of_week)
|
2678
|
+
include Aws::Structure
|
2679
|
+
end
|
2680
|
+
|
2681
|
+
# A JSON object containing the of the gateway whose maintenance start
|
2682
|
+
# time is updated.
|
2683
|
+
# @!attribute [rw] gateway_arn
|
2684
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2685
|
+
# operation to return a list of gateways for your account and region.
|
2686
|
+
# @return [String]
|
2687
|
+
class UpdateMaintenanceStartTimeOutput < Struct.new(
|
2688
|
+
:gateway_arn)
|
2689
|
+
include Aws::Structure
|
2690
|
+
end
|
2691
|
+
|
2692
|
+
# A JSON object containing one or more of the following fields:
|
2693
|
+
#
|
2694
|
+
# * UpdateSnapshotScheduleInput$Description
|
2695
|
+
#
|
2696
|
+
# * UpdateSnapshotScheduleInput$RecurrenceInHours
|
2697
|
+
#
|
2698
|
+
# * UpdateSnapshotScheduleInput$StartAt
|
2699
|
+
#
|
2700
|
+
# * UpdateSnapshotScheduleInput$VolumeARN
|
2701
|
+
# @note When making an API call, pass UpdateSnapshotScheduleInput
|
2702
|
+
# data as a hash:
|
2703
|
+
#
|
2704
|
+
# {
|
2705
|
+
# volume_arn: "VolumeARN", # required
|
2706
|
+
# start_at: 1, # required
|
2707
|
+
# recurrence_in_hours: 1, # required
|
2708
|
+
# description: "Description",
|
2709
|
+
# }
|
2710
|
+
# @!attribute [rw] volume_arn
|
2711
|
+
# The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
|
2712
|
+
# operation to return a list of gateway volumes.
|
2713
|
+
# @return [String]
|
2714
|
+
#
|
2715
|
+
# @!attribute [rw] start_at
|
2716
|
+
# The hour of the day at which the snapshot schedule begins
|
2717
|
+
# represented as *hh*, where *hh* is the hour (0 to 23). The hour of
|
2718
|
+
# the day is in the time zone of the gateway.
|
2719
|
+
# @return [Integer]
|
2720
|
+
#
|
2721
|
+
# @!attribute [rw] recurrence_in_hours
|
2722
|
+
# Frequency of snapshots. Specify the number of hours between
|
2723
|
+
# snapshots.
|
2724
|
+
# @return [Integer]
|
2725
|
+
#
|
2726
|
+
# @!attribute [rw] description
|
2727
|
+
# Optional description of the snapshot that overwrites the existing
|
2728
|
+
# description.
|
2729
|
+
# @return [String]
|
2730
|
+
class UpdateSnapshotScheduleInput < Struct.new(
|
2731
|
+
:volume_arn,
|
2732
|
+
:start_at,
|
2733
|
+
:recurrence_in_hours,
|
2734
|
+
:description)
|
2735
|
+
include Aws::Structure
|
2736
|
+
end
|
2737
|
+
|
2738
|
+
# A JSON object containing the of the updated storage volume.
|
2739
|
+
# @!attribute [rw] volume_arn
|
2740
|
+
# @return [String]
|
2741
|
+
class UpdateSnapshotScheduleOutput < Struct.new(
|
2742
|
+
:volume_arn)
|
2743
|
+
include Aws::Structure
|
2744
|
+
end
|
2745
|
+
|
2746
|
+
# @note When making an API call, pass UpdateVTLDeviceTypeInput
|
2747
|
+
# data as a hash:
|
2748
|
+
#
|
2749
|
+
# {
|
2750
|
+
# vtl_device_arn: "VTLDeviceARN", # required
|
2751
|
+
# device_type: "DeviceType", # required
|
2752
|
+
# }
|
2753
|
+
# @!attribute [rw] vtl_device_arn
|
2754
|
+
# The Amazon Resource Name (ARN) of the medium changer you want to
|
2755
|
+
# select.
|
2756
|
+
# @return [String]
|
2757
|
+
#
|
2758
|
+
# @!attribute [rw] device_type
|
2759
|
+
# The type of medium changer you want to select.
|
2760
|
+
#
|
2761
|
+
# Valid Values: "STK-L700", "AWS-Gateway-VTL"
|
2762
|
+
# @return [String]
|
2763
|
+
class UpdateVTLDeviceTypeInput < Struct.new(
|
2764
|
+
:vtl_device_arn,
|
2765
|
+
:device_type)
|
2766
|
+
include Aws::Structure
|
2767
|
+
end
|
2768
|
+
|
2769
|
+
# UpdateVTLDeviceTypeOutput
|
2770
|
+
# @!attribute [rw] vtl_device_arn
|
2771
|
+
# The Amazon Resource Name (ARN) of the medium changer you have
|
2772
|
+
# selected.
|
2773
|
+
# @return [String]
|
2774
|
+
class UpdateVTLDeviceTypeOutput < Struct.new(
|
2775
|
+
:vtl_device_arn)
|
2776
|
+
include Aws::Structure
|
2777
|
+
end
|
2778
|
+
|
2779
|
+
# Represents a device object associated with a gateway-VTL.
|
2780
|
+
# @!attribute [rw] vtl_device_arn
|
2781
|
+
# Specifies the unique Amazon Resource Name (ARN) of the device (tape
|
2782
|
+
# drive or media changer).
|
2783
|
+
# @return [String]
|
2784
|
+
#
|
2785
|
+
# @!attribute [rw] vtl_device_type
|
2786
|
+
# @return [String]
|
2787
|
+
#
|
2788
|
+
# @!attribute [rw] vtl_device_vendor
|
2789
|
+
# @return [String]
|
2790
|
+
#
|
2791
|
+
# @!attribute [rw] vtl_device_product_identifier
|
2792
|
+
# @return [String]
|
2793
|
+
#
|
2794
|
+
# @!attribute [rw] device_iscsi_attributes
|
2795
|
+
# A list of iSCSI information about a VTL device.
|
2796
|
+
# @return [Types::DeviceiSCSIAttributes]
|
2797
|
+
class VTLDevice < Struct.new(
|
2798
|
+
:vtl_device_arn,
|
2799
|
+
:vtl_device_type,
|
2800
|
+
:vtl_device_vendor,
|
2801
|
+
:vtl_device_product_identifier,
|
2802
|
+
:device_iscsi_attributes)
|
2803
|
+
include Aws::Structure
|
2804
|
+
end
|
2805
|
+
|
2806
|
+
# Describes a storage volume object.
|
2807
|
+
# @!attribute [rw] volume_arn
|
2808
|
+
# The Amazon Resource Name (ARN) for the storage volume. For example,
|
2809
|
+
# the following is a valid ARN:
|
2810
|
+
#
|
2811
|
+
# `arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB`
|
2812
|
+
#
|
2813
|
+
# Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and
|
2814
|
+
# hyphens (-).
|
2815
|
+
# @return [String]
|
2816
|
+
#
|
2817
|
+
# @!attribute [rw] volume_id
|
2818
|
+
# The unique identifier assigned to the volume. This ID becomes part
|
2819
|
+
# of the volume Amazon Resource Name (ARN), which you use as input for
|
2820
|
+
# other operations.
|
2821
|
+
#
|
2822
|
+
# Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and
|
2823
|
+
# hyphens (-).
|
2824
|
+
# @return [String]
|
2825
|
+
#
|
2826
|
+
# @!attribute [rw] gateway_arn
|
2827
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2828
|
+
# operation to return a list of gateways for your account and region.
|
2829
|
+
# @return [String]
|
2830
|
+
#
|
2831
|
+
# @!attribute [rw] gateway_id
|
2832
|
+
# The unique identifier assigned to your gateway during activation.
|
2833
|
+
# This ID becomes part of the gateway Amazon Resource Name (ARN),
|
2834
|
+
# which you use as input for other operations.
|
2835
|
+
#
|
2836
|
+
# Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and
|
2837
|
+
# hyphens (-).
|
2838
|
+
# @return [String]
|
2839
|
+
#
|
2840
|
+
# @!attribute [rw] volume_type
|
2841
|
+
# @return [String]
|
2842
|
+
#
|
2843
|
+
# @!attribute [rw] volume_size_in_bytes
|
2844
|
+
# The size, in bytes, of the volume.
|
2845
|
+
#
|
2846
|
+
# Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and
|
2847
|
+
# hyphens (-).
|
2848
|
+
# @return [Integer]
|
2849
|
+
class VolumeInfo < Struct.new(
|
2850
|
+
:volume_arn,
|
2851
|
+
:volume_id,
|
2852
|
+
:gateway_arn,
|
2853
|
+
:gateway_id,
|
2854
|
+
:volume_type,
|
2855
|
+
:volume_size_in_bytes)
|
2856
|
+
include Aws::Structure
|
2857
|
+
end
|
2858
|
+
|
2859
|
+
# @!attribute [rw] volume_arn
|
2860
|
+
# @return [String]
|
2861
|
+
#
|
2862
|
+
# @!attribute [rw] volume_size_in_bytes
|
2863
|
+
# @return [Integer]
|
2864
|
+
#
|
2865
|
+
# @!attribute [rw] volume_usage_in_bytes
|
2866
|
+
# @return [Integer]
|
2867
|
+
#
|
2868
|
+
# @!attribute [rw] volume_recovery_point_time
|
2869
|
+
# @return [String]
|
2870
|
+
class VolumeRecoveryPointInfo < Struct.new(
|
2871
|
+
:volume_arn,
|
2872
|
+
:volume_size_in_bytes,
|
2873
|
+
:volume_usage_in_bytes,
|
2874
|
+
:volume_recovery_point_time)
|
2875
|
+
include Aws::Structure
|
2876
|
+
end
|
2877
|
+
|
2878
|
+
# Lists iSCSI information about a volume.
|
2879
|
+
# @!attribute [rw] target_arn
|
2880
|
+
# The Amazon Resource Name (ARN) of the volume target.
|
2881
|
+
# @return [String]
|
2882
|
+
#
|
2883
|
+
# @!attribute [rw] network_interface_id
|
2884
|
+
# The network interface identifier.
|
2885
|
+
# @return [String]
|
2886
|
+
#
|
2887
|
+
# @!attribute [rw] network_interface_port
|
2888
|
+
# The port used to communicate with iSCSI targets.
|
2889
|
+
# @return [Integer]
|
2890
|
+
#
|
2891
|
+
# @!attribute [rw] lun_number
|
2892
|
+
# The logical disk number.
|
2893
|
+
# @return [Integer]
|
2894
|
+
#
|
2895
|
+
# @!attribute [rw] chap_enabled
|
2896
|
+
# Indicates whether mutual CHAP is enabled for the iSCSI target.
|
2897
|
+
# @return [Boolean]
|
2898
|
+
class VolumeiSCSIAttributes < Struct.new(
|
2899
|
+
:target_arn,
|
2900
|
+
:network_interface_id,
|
2901
|
+
:network_interface_port,
|
2902
|
+
:lun_number,
|
2903
|
+
:chap_enabled)
|
2904
|
+
include Aws::Structure
|
2905
|
+
end
|
2906
|
+
|
2907
|
+
end
|
2908
|
+
end
|
2909
|
+
end
|