aws-sdk-storagegateway 1.0.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- 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
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: a4d88ba6a50438412ad16698b788814115654f24
|
4
|
+
data.tar.gz: 2689397519ecb1f0fba1e11647857421cdccf320
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 24d445cf76f6455b4978991225bcfd99edc0de461e2f0403d61de0cf73e4a414e58bda7bd8aac3e6f218dc385eccd52023bc7704336c0ccb59f5a799cb71d991
|
7
|
+
data.tar.gz: a54ac755e72e1d4906cc1c414515befa3adc0692515b9715c70a2c96e658d1dc44daa8acf066469897ef1d3831004943e75598f38581541b97d3166e03e631c1
|
@@ -0,0 +1,47 @@
|
|
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
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-storagegateway/types'
|
12
|
+
require_relative 'aws-sdk-storagegateway/client_api'
|
13
|
+
require_relative 'aws-sdk-storagegateway/client'
|
14
|
+
require_relative 'aws-sdk-storagegateway/errors'
|
15
|
+
require_relative 'aws-sdk-storagegateway/resource'
|
16
|
+
require_relative 'aws-sdk-storagegateway/customizations'
|
17
|
+
|
18
|
+
# This module provides support for AWS Storage Gateway. This module is available in the
|
19
|
+
# `aws-sdk-storagegateway` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from AWS Storage Gateway all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::StorageGateway::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::StorageGateway
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0.rc1'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,2441 @@
|
|
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
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
22
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
23
|
+
|
24
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:storagegateway)
|
25
|
+
|
26
|
+
module Aws
|
27
|
+
module StorageGateway
|
28
|
+
class Client < Seahorse::Client::Base
|
29
|
+
|
30
|
+
include Aws::ClientStubs
|
31
|
+
|
32
|
+
@identifier = :storagegateway
|
33
|
+
|
34
|
+
set_api(ClientApi::API)
|
35
|
+
|
36
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
37
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
38
|
+
add_plugin(Aws::Plugins::Logging)
|
39
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
40
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
41
|
+
add_plugin(Aws::Plugins::UserAgent)
|
42
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
43
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
44
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
45
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
46
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
47
|
+
add_plugin(Aws::Plugins::StubResponses)
|
48
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
49
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
50
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
51
|
+
|
52
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
53
|
+
# Your AWS credentials. This can be an instance of any one of the
|
54
|
+
# following classes:
|
55
|
+
#
|
56
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
57
|
+
# credentials.
|
58
|
+
#
|
59
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
60
|
+
# from an EC2 IMDS on an EC2 instance.
|
61
|
+
#
|
62
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
63
|
+
# shared file, such as `~/.aws/config`.
|
64
|
+
#
|
65
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
66
|
+
#
|
67
|
+
# When `:credentials` are not configured directly, the following
|
68
|
+
# locations will be searched for credentials:
|
69
|
+
#
|
70
|
+
# * `Aws.config[:credentials]`
|
71
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
72
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
73
|
+
# * `~/.aws/credentials`
|
74
|
+
# * `~/.aws/config`
|
75
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
76
|
+
# very aggressive. Construct and pass an instance of
|
77
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
78
|
+
# timeouts.
|
79
|
+
# @option options [required, String] :region
|
80
|
+
# The AWS region to connect to. The configured `:region` is
|
81
|
+
# used to determine the service `:endpoint`. When not passed,
|
82
|
+
# a default `:region` is search for in the following locations:
|
83
|
+
#
|
84
|
+
# * `Aws.config[:region]`
|
85
|
+
# * `ENV['AWS_REGION']`
|
86
|
+
# * `ENV['AMAZON_REGION']`
|
87
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
88
|
+
# * `~/.aws/credentials`
|
89
|
+
# * `~/.aws/config`
|
90
|
+
# @option options [String] :access_key_id
|
91
|
+
# @option options [Boolean] :convert_params (true)
|
92
|
+
# When `true`, an attempt is made to coerce request parameters into
|
93
|
+
# the required types.
|
94
|
+
# @option options [String] :endpoint
|
95
|
+
# The client endpoint is normally constructed from the `:region`
|
96
|
+
# option. You should only configure an `:endpoint` when connecting
|
97
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
98
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
99
|
+
# The log formatter.
|
100
|
+
# @option options [Symbol] :log_level (:info)
|
101
|
+
# The log level to send messages to the `:logger` at.
|
102
|
+
# @option options [Logger] :logger
|
103
|
+
# The Logger instance to send log messages to. If this option
|
104
|
+
# is not set, logging will be disabled.
|
105
|
+
# @option options [String] :profile ("default")
|
106
|
+
# Used when loading credentials from the shared credentials file
|
107
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
108
|
+
# @option options [Integer] :retry_limit (3)
|
109
|
+
# The maximum number of times to retry failed requests. Only
|
110
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
111
|
+
# are retried. Generally, these are throttling errors, data
|
112
|
+
# checksum errors, networking errors, timeout errors and auth
|
113
|
+
# errors from expired credentials.
|
114
|
+
# @option options [String] :secret_access_key
|
115
|
+
# @option options [String] :session_token
|
116
|
+
# @option options [Boolean] :simple_json (false)
|
117
|
+
# Disables request parameter conversion, validation, and formatting.
|
118
|
+
# Also disable response data type conversions. This option is useful
|
119
|
+
# when you want to ensure the highest level of performance by
|
120
|
+
# avoiding overhead of walking request parameters and response data
|
121
|
+
# structures.
|
122
|
+
#
|
123
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
124
|
+
# be formatted exactly as the DynamoDB API expects.
|
125
|
+
# @option options [Boolean] :stub_responses (false)
|
126
|
+
# Causes the client to return stubbed responses. By default
|
127
|
+
# fake responses are generated and returned. You can specify
|
128
|
+
# the response data to return or errors to raise by calling
|
129
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
130
|
+
#
|
131
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
132
|
+
# requests are made, and retries are disabled.
|
133
|
+
# @option options [Boolean] :validate_params (true)
|
134
|
+
# When `true`, request parameters are validated before
|
135
|
+
# sending the request.
|
136
|
+
def initialize(*args)
|
137
|
+
super
|
138
|
+
end
|
139
|
+
|
140
|
+
# @!group API Operations
|
141
|
+
|
142
|
+
# Activates the gateway you previously deployed on your host. For more
|
143
|
+
# information, see [ Activate the AWS Storage Gateway][1]. In the
|
144
|
+
# activation process, you specify information such as the you want to
|
145
|
+
# use for storing snapshots, the time zone for scheduled snapshots the
|
146
|
+
# gateway snapshot schedule window, an activation key, and a name for
|
147
|
+
# your gateway. The activation process also associates your gateway with
|
148
|
+
# your account; for more information, see UpdateGatewayInformation.
|
149
|
+
#
|
150
|
+
# <note markdown="1">You must turn on the gateway VM before you can activate your gateway.
|
151
|
+
#
|
152
|
+
# </note>
|
153
|
+
#
|
154
|
+
#
|
155
|
+
#
|
156
|
+
# [1]: http://docs.aws.amazon.com/storagegateway/latest/userguide/GettingStartedActivateGateway-common.html
|
157
|
+
# @option params [required, String] :activation_key
|
158
|
+
# Your gateway activation key. You can obtain the activation key by
|
159
|
+
# sending an HTTP GET request with redirects enabled to the gateway IP
|
160
|
+
# address (port 80). The redirect URL returned in the response provides
|
161
|
+
# you the activation key for your gateway in the query string parameter
|
162
|
+
# `activationKey`. It may also include other activation-related
|
163
|
+
# parameters, however, these are merely defaults -- the arguments you
|
164
|
+
# pass to the `ActivateGateway` API call determine the actual
|
165
|
+
# configuration of your gateway.
|
166
|
+
# @option params [required, String] :gateway_name
|
167
|
+
# The name you configured for your gateway.
|
168
|
+
# @option params [required, String] :gateway_timezone
|
169
|
+
# A value that indicates the time zone you want to set for the gateway.
|
170
|
+
# The time zone is used, for example, for scheduling snapshots and your
|
171
|
+
# gateway's maintenance schedule.
|
172
|
+
# @option params [required, String] :gateway_region
|
173
|
+
# A value that indicates the region where you want to store the snapshot
|
174
|
+
# backups. The gateway region specified must be the same region as the
|
175
|
+
# region in your `Host` header in the request. For more information
|
176
|
+
# about available regions and endpoints for AWS Storage Gateway, see
|
177
|
+
# [Regions and Endpoints][1] in the *Amazon Web Services Glossary*.
|
178
|
+
#
|
179
|
+
# Valid Values: "us-east-1", "us-west-1", "us-west-2",
|
180
|
+
# "eu-west-1", "eu-central-1", "ap-northeast-1",
|
181
|
+
# "ap-northeast-2", "ap-southeast-1", "ap-southeast-2",
|
182
|
+
# "sa-east-1"
|
183
|
+
#
|
184
|
+
#
|
185
|
+
#
|
186
|
+
# [1]: http://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region
|
187
|
+
# @option params [String] :gateway_type
|
188
|
+
# A value that defines the type of gateway to activate. The type
|
189
|
+
# specified is critical to all later functions of the gateway and cannot
|
190
|
+
# be changed after activation. The default value is `STORED`.
|
191
|
+
# @option params [String] :tape_drive_type
|
192
|
+
# The value that indicates the type of tape drive to use for
|
193
|
+
# gateway-VTL. This field is optional.
|
194
|
+
#
|
195
|
+
# Valid Values: "IBM-ULT3580-TD5"
|
196
|
+
# @option params [String] :medium_changer_type
|
197
|
+
# The value that indicates the type of medium changer to use for
|
198
|
+
# gateway-VTL. This field is optional.
|
199
|
+
#
|
200
|
+
# Valid Values: "STK-L700", "AWS-Gateway-VTL"
|
201
|
+
# @return [Types::ActivateGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
202
|
+
#
|
203
|
+
# * {Types::ActivateGatewayOutput#gateway_arn #GatewayARN} => String
|
204
|
+
#
|
205
|
+
# @example Request syntax with placeholder values
|
206
|
+
# resp = client.activate_gateway({
|
207
|
+
# activation_key: "ActivationKey", # required
|
208
|
+
# gateway_name: "GatewayName", # required
|
209
|
+
# gateway_timezone: "GatewayTimezone", # required
|
210
|
+
# gateway_region: "RegionId", # required
|
211
|
+
# gateway_type: "GatewayType",
|
212
|
+
# tape_drive_type: "TapeDriveType",
|
213
|
+
# medium_changer_type: "MediumChangerType",
|
214
|
+
# })
|
215
|
+
#
|
216
|
+
# @example Response structure
|
217
|
+
# resp.gateway_arn #=> String
|
218
|
+
# @overload activate_gateway(params = {})
|
219
|
+
# @param [Hash] params ({})
|
220
|
+
def activate_gateway(params = {}, options = {})
|
221
|
+
req = build_request(:activate_gateway, params)
|
222
|
+
req.send_request(options)
|
223
|
+
end
|
224
|
+
|
225
|
+
# Configures one or more gateway local disks as cache for a
|
226
|
+
# cached-volume gateway. This operation is supported only for the
|
227
|
+
# gateway-cached volume architecture (see [Storage Gateway
|
228
|
+
# Concepts][1]).
|
229
|
+
#
|
230
|
+
# In the request, you specify the gateway Amazon Resource Name (ARN) to
|
231
|
+
# which you want to add cache, and one or more disk IDs that you want to
|
232
|
+
# configure as cache.
|
233
|
+
#
|
234
|
+
#
|
235
|
+
#
|
236
|
+
# [1]: http://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html
|
237
|
+
# @option params [required, String] :gateway_arn
|
238
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
239
|
+
# operation to return a list of gateways for your account and region.
|
240
|
+
# @option params [required, Array<String>] :disk_ids
|
241
|
+
# @return [Types::AddCacheOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
242
|
+
#
|
243
|
+
# * {Types::AddCacheOutput#gateway_arn #GatewayARN} => String
|
244
|
+
#
|
245
|
+
# @example Request syntax with placeholder values
|
246
|
+
# resp = client.add_cache({
|
247
|
+
# gateway_arn: "GatewayARN", # required
|
248
|
+
# disk_ids: ["DiskId"], # required
|
249
|
+
# })
|
250
|
+
#
|
251
|
+
# @example Response structure
|
252
|
+
# resp.gateway_arn #=> String
|
253
|
+
# @overload add_cache(params = {})
|
254
|
+
# @param [Hash] params ({})
|
255
|
+
def add_cache(params = {}, options = {})
|
256
|
+
req = build_request(:add_cache, params)
|
257
|
+
req.send_request(options)
|
258
|
+
end
|
259
|
+
|
260
|
+
# Adds one or more tags to the specified resource. You use tags to add
|
261
|
+
# metadata to resources, which you can use to categorize these
|
262
|
+
# resources. For example, you can categorize resources by purpose,
|
263
|
+
# owner, environment, or team. Each tag consists of a key and a value,
|
264
|
+
# which you define. You can add tags to the following AWS Storage
|
265
|
+
# Gateway resources:
|
266
|
+
#
|
267
|
+
# * Storage gateways of all types
|
268
|
+
#
|
269
|
+
# ^
|
270
|
+
# ^
|
271
|
+
#
|
272
|
+
# * Storage Volumes
|
273
|
+
#
|
274
|
+
# ^
|
275
|
+
# ^
|
276
|
+
#
|
277
|
+
# * Virtual Tapes
|
278
|
+
#
|
279
|
+
# ^
|
280
|
+
#
|
281
|
+
# You can create a maximum of 10 tags for each resource. Virtual tapes
|
282
|
+
# and storage volumes that are recovered to a new gateway maintain their
|
283
|
+
# tags.
|
284
|
+
# @option params [required, String] :resource_arn
|
285
|
+
# The Amazon Resource Name (ARN) of the resource you want to add tags
|
286
|
+
# to.
|
287
|
+
# @option params [required, Array<Types::Tag>] :tags
|
288
|
+
# The key-value pair that represents the tag you want to add to the
|
289
|
+
# resource. The value can be an empty string.
|
290
|
+
#
|
291
|
+
# <note markdown="1"> Valid characters for key and value are letters, spaces, and numbers
|
292
|
+
# representable in UTF-8 format, and the following special characters: +
|
293
|
+
# - = . \_ : / @.
|
294
|
+
#
|
295
|
+
# </note>
|
296
|
+
# @return [Types::AddTagsToResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
297
|
+
#
|
298
|
+
# * {Types::AddTagsToResourceOutput#resource_arn #ResourceARN} => String
|
299
|
+
#
|
300
|
+
# @example Request syntax with placeholder values
|
301
|
+
# resp = client.add_tags_to_resource({
|
302
|
+
# resource_arn: "ResourceARN", # required
|
303
|
+
# tags: [ # required
|
304
|
+
# {
|
305
|
+
# key: "TagKey", # required
|
306
|
+
# value: "TagValue", # required
|
307
|
+
# },
|
308
|
+
# ],
|
309
|
+
# })
|
310
|
+
#
|
311
|
+
# @example Response structure
|
312
|
+
# resp.resource_arn #=> String
|
313
|
+
# @overload add_tags_to_resource(params = {})
|
314
|
+
# @param [Hash] params ({})
|
315
|
+
def add_tags_to_resource(params = {}, options = {})
|
316
|
+
req = build_request(:add_tags_to_resource, params)
|
317
|
+
req.send_request(options)
|
318
|
+
end
|
319
|
+
|
320
|
+
# Configures one or more gateway local disks as upload buffer for a
|
321
|
+
# specified gateway. This operation is supported for both the
|
322
|
+
# gateway-stored and gateway-cached volume architectures.
|
323
|
+
#
|
324
|
+
# In the request, you specify the gateway Amazon Resource Name (ARN) to
|
325
|
+
# which you want to add upload buffer, and one or more disk IDs that you
|
326
|
+
# want to configure as upload buffer.
|
327
|
+
# @option params [required, String] :gateway_arn
|
328
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
329
|
+
# operation to return a list of gateways for your account and region.
|
330
|
+
# @option params [required, Array<String>] :disk_ids
|
331
|
+
# @return [Types::AddUploadBufferOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
332
|
+
#
|
333
|
+
# * {Types::AddUploadBufferOutput#gateway_arn #GatewayARN} => String
|
334
|
+
#
|
335
|
+
# @example Request syntax with placeholder values
|
336
|
+
# resp = client.add_upload_buffer({
|
337
|
+
# gateway_arn: "GatewayARN", # required
|
338
|
+
# disk_ids: ["DiskId"], # required
|
339
|
+
# })
|
340
|
+
#
|
341
|
+
# @example Response structure
|
342
|
+
# resp.gateway_arn #=> String
|
343
|
+
# @overload add_upload_buffer(params = {})
|
344
|
+
# @param [Hash] params ({})
|
345
|
+
def add_upload_buffer(params = {}, options = {})
|
346
|
+
req = build_request(:add_upload_buffer, params)
|
347
|
+
req.send_request(options)
|
348
|
+
end
|
349
|
+
|
350
|
+
# Configures one or more gateway local disks as working storage for a
|
351
|
+
# gateway. This operation is supported only for the gateway-stored
|
352
|
+
# volume architecture. This operation is deprecated in cached-volumes
|
353
|
+
# API version 20120630. Use AddUploadBuffer instead.
|
354
|
+
#
|
355
|
+
# <note markdown="1"> Working storage is also referred to as upload buffer. You can also use
|
356
|
+
# the AddUploadBuffer operation to add upload buffer to a stored-volume
|
357
|
+
# gateway.
|
358
|
+
#
|
359
|
+
# </note>
|
360
|
+
#
|
361
|
+
# In the request, you specify the gateway Amazon Resource Name (ARN) to
|
362
|
+
# which you want to add working storage, and one or more disk IDs that
|
363
|
+
# you want to configure as working storage.
|
364
|
+
# @option params [required, String] :gateway_arn
|
365
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
366
|
+
# operation to return a list of gateways for your account and region.
|
367
|
+
# @option params [required, Array<String>] :disk_ids
|
368
|
+
# An array of strings that identify disks that are to be configured as
|
369
|
+
# working storage. Each string have a minimum length of 1 and maximum
|
370
|
+
# length of 300. You can get the disk IDs from the ListLocalDisks API.
|
371
|
+
# @return [Types::AddWorkingStorageOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
372
|
+
#
|
373
|
+
# * {Types::AddWorkingStorageOutput#gateway_arn #GatewayARN} => String
|
374
|
+
#
|
375
|
+
# @example Request syntax with placeholder values
|
376
|
+
# resp = client.add_working_storage({
|
377
|
+
# gateway_arn: "GatewayARN", # required
|
378
|
+
# disk_ids: ["DiskId"], # required
|
379
|
+
# })
|
380
|
+
#
|
381
|
+
# @example Response structure
|
382
|
+
# resp.gateway_arn #=> String
|
383
|
+
# @overload add_working_storage(params = {})
|
384
|
+
# @param [Hash] params ({})
|
385
|
+
def add_working_storage(params = {}, options = {})
|
386
|
+
req = build_request(:add_working_storage, params)
|
387
|
+
req.send_request(options)
|
388
|
+
end
|
389
|
+
|
390
|
+
# Cancels archiving of a virtual tape to the virtual tape shelf (VTS)
|
391
|
+
# after the archiving process is initiated.
|
392
|
+
# @option params [required, String] :gateway_arn
|
393
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
394
|
+
# operation to return a list of gateways for your account and region.
|
395
|
+
# @option params [required, String] :tape_arn
|
396
|
+
# The Amazon Resource Name (ARN) of the virtual tape you want to cancel
|
397
|
+
# archiving for.
|
398
|
+
# @return [Types::CancelArchivalOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
399
|
+
#
|
400
|
+
# * {Types::CancelArchivalOutput#tape_arn #TapeARN} => String
|
401
|
+
#
|
402
|
+
# @example Request syntax with placeholder values
|
403
|
+
# resp = client.cancel_archival({
|
404
|
+
# gateway_arn: "GatewayARN", # required
|
405
|
+
# tape_arn: "TapeARN", # required
|
406
|
+
# })
|
407
|
+
#
|
408
|
+
# @example Response structure
|
409
|
+
# resp.tape_arn #=> String
|
410
|
+
# @overload cancel_archival(params = {})
|
411
|
+
# @param [Hash] params ({})
|
412
|
+
def cancel_archival(params = {}, options = {})
|
413
|
+
req = build_request(:cancel_archival, params)
|
414
|
+
req.send_request(options)
|
415
|
+
end
|
416
|
+
|
417
|
+
# Cancels retrieval of a virtual tape from the virtual tape shelf (VTS)
|
418
|
+
# to a gateway after the retrieval process is initiated. The virtual
|
419
|
+
# tape is returned to the VTS.
|
420
|
+
# @option params [required, String] :gateway_arn
|
421
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
422
|
+
# operation to return a list of gateways for your account and region.
|
423
|
+
# @option params [required, String] :tape_arn
|
424
|
+
# The Amazon Resource Name (ARN) of the virtual tape you want to cancel
|
425
|
+
# retrieval for.
|
426
|
+
# @return [Types::CancelRetrievalOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
427
|
+
#
|
428
|
+
# * {Types::CancelRetrievalOutput#tape_arn #TapeARN} => String
|
429
|
+
#
|
430
|
+
# @example Request syntax with placeholder values
|
431
|
+
# resp = client.cancel_retrieval({
|
432
|
+
# gateway_arn: "GatewayARN", # required
|
433
|
+
# tape_arn: "TapeARN", # required
|
434
|
+
# })
|
435
|
+
#
|
436
|
+
# @example Response structure
|
437
|
+
# resp.tape_arn #=> String
|
438
|
+
# @overload cancel_retrieval(params = {})
|
439
|
+
# @param [Hash] params ({})
|
440
|
+
def cancel_retrieval(params = {}, options = {})
|
441
|
+
req = build_request(:cancel_retrieval, params)
|
442
|
+
req.send_request(options)
|
443
|
+
end
|
444
|
+
|
445
|
+
# Creates a cached volume on a specified cached gateway. This operation
|
446
|
+
# is supported only for the gateway-cached volume architecture.
|
447
|
+
#
|
448
|
+
# <note markdown="1">Cache storage must be allocated to the gateway before you can create a
|
449
|
+
# cached volume. Use the AddCache operation to add cache storage to a
|
450
|
+
# gateway.
|
451
|
+
#
|
452
|
+
# </note>
|
453
|
+
#
|
454
|
+
# In the request, you must specify the gateway, size of the volume in
|
455
|
+
# bytes, the iSCSI target name, an IP address on which to expose the
|
456
|
+
# target, and a unique client token. In response, AWS Storage Gateway
|
457
|
+
# creates the volume and returns information about it such as the volume
|
458
|
+
# Amazon Resource Name (ARN), its size, and the iSCSI target ARN that
|
459
|
+
# initiators can use to connect to the volume target.
|
460
|
+
# @option params [required, String] :gateway_arn
|
461
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
462
|
+
# operation to return a list of gateways for your account and region.
|
463
|
+
# @option params [required, Integer] :volume_size_in_bytes
|
464
|
+
# @option params [String] :snapshot_id
|
465
|
+
# @option params [required, String] :target_name
|
466
|
+
# @option params [required, String] :network_interface_id
|
467
|
+
# @option params [required, String] :client_token
|
468
|
+
# @return [Types::CreateCachediSCSIVolumeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
469
|
+
#
|
470
|
+
# * {Types::CreateCachediSCSIVolumeOutput#volume_arn #VolumeARN} => String
|
471
|
+
# * {Types::CreateCachediSCSIVolumeOutput#target_arn #TargetARN} => String
|
472
|
+
#
|
473
|
+
# @example Request syntax with placeholder values
|
474
|
+
# resp = client.create_cached_iscsi_volume({
|
475
|
+
# gateway_arn: "GatewayARN", # required
|
476
|
+
# volume_size_in_bytes: 1, # required
|
477
|
+
# snapshot_id: "SnapshotId",
|
478
|
+
# target_name: "TargetName", # required
|
479
|
+
# network_interface_id: "NetworkInterfaceId", # required
|
480
|
+
# client_token: "ClientToken", # required
|
481
|
+
# })
|
482
|
+
#
|
483
|
+
# @example Response structure
|
484
|
+
# resp.volume_arn #=> String
|
485
|
+
# resp.target_arn #=> String
|
486
|
+
# @overload create_cached_iscsi_volume(params = {})
|
487
|
+
# @param [Hash] params ({})
|
488
|
+
def create_cached_iscsi_volume(params = {}, options = {})
|
489
|
+
req = build_request(:create_cached_iscsi_volume, params)
|
490
|
+
req.send_request(options)
|
491
|
+
end
|
492
|
+
|
493
|
+
# Initiates a snapshot of a volume.
|
494
|
+
#
|
495
|
+
# AWS Storage Gateway provides the ability to back up point-in-time
|
496
|
+
# snapshots of your data to Amazon Simple Storage (S3) for durable
|
497
|
+
# off-site recovery, as well as import the data to an Amazon Elastic
|
498
|
+
# Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You
|
499
|
+
# can take snapshots of your gateway volume on a scheduled or ad-hoc
|
500
|
+
# basis. This API enables you to take ad-hoc snapshot. For more
|
501
|
+
# information, see [Working With Snapshots in the AWS Storage Gateway
|
502
|
+
# Console][1].
|
503
|
+
#
|
504
|
+
# In the CreateSnapshot request you identify the volume by providing its
|
505
|
+
# Amazon Resource Name (ARN). You must also provide description for the
|
506
|
+
# snapshot. When AWS Storage Gateway takes the snapshot of specified
|
507
|
+
# volume, the snapshot and description appears in the AWS Storage
|
508
|
+
# Gateway Console. In response, AWS Storage Gateway returns you a
|
509
|
+
# snapshot ID. You can use this snapshot ID to check the snapshot
|
510
|
+
# progress or later use it when you want to create a volume from a
|
511
|
+
# snapshot.
|
512
|
+
#
|
513
|
+
# <note markdown="1">To list or delete a snapshot, you must use the Amazon EC2 API. For
|
514
|
+
# more information, see DescribeSnapshots or DeleteSnapshot in the [EC2
|
515
|
+
# API reference][2].
|
516
|
+
#
|
517
|
+
# </note>
|
518
|
+
#
|
519
|
+
# Volume and snapshot IDs are changing to a longer length ID format. For
|
520
|
+
# more information, see the important note on the [Welcome][3] page.
|
521
|
+
#
|
522
|
+
#
|
523
|
+
#
|
524
|
+
# [1]: http://docs.aws.amazon.com/storagegateway/latest/userguide/WorkingWithSnapshots.html
|
525
|
+
# [2]: http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Operations.html
|
526
|
+
# [3]: http://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html
|
527
|
+
# @option params [required, String] :volume_arn
|
528
|
+
# The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
|
529
|
+
# operation to return a list of gateway volumes.
|
530
|
+
# @option params [required, String] :snapshot_description
|
531
|
+
# Textual description of the snapshot that appears in the Amazon EC2
|
532
|
+
# console, Elastic Block Store snapshots panel in the **Description**
|
533
|
+
# field, and in the AWS Storage Gateway snapshot **Details** pane,
|
534
|
+
# **Description** field
|
535
|
+
# @return [Types::CreateSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
536
|
+
#
|
537
|
+
# * {Types::CreateSnapshotOutput#volume_arn #VolumeARN} => String
|
538
|
+
# * {Types::CreateSnapshotOutput#snapshot_id #SnapshotId} => String
|
539
|
+
#
|
540
|
+
# @example Request syntax with placeholder values
|
541
|
+
# resp = client.create_snapshot({
|
542
|
+
# volume_arn: "VolumeARN", # required
|
543
|
+
# snapshot_description: "SnapshotDescription", # required
|
544
|
+
# })
|
545
|
+
#
|
546
|
+
# @example Response structure
|
547
|
+
# resp.volume_arn #=> String
|
548
|
+
# resp.snapshot_id #=> String
|
549
|
+
# @overload create_snapshot(params = {})
|
550
|
+
# @param [Hash] params ({})
|
551
|
+
def create_snapshot(params = {}, options = {})
|
552
|
+
req = build_request(:create_snapshot, params)
|
553
|
+
req.send_request(options)
|
554
|
+
end
|
555
|
+
|
556
|
+
# Initiates a snapshot of a gateway from a volume recovery point. This
|
557
|
+
# operation is supported only for the gateway-cached volume
|
558
|
+
# architecture.
|
559
|
+
#
|
560
|
+
# A volume recovery point is a point in time at which all data of the
|
561
|
+
# volume is consistent and from which you can create a snapshot. To get
|
562
|
+
# a list of volume recovery point for gateway-cached volumes, use
|
563
|
+
# ListVolumeRecoveryPoints.
|
564
|
+
#
|
565
|
+
# In the `CreateSnapshotFromVolumeRecoveryPoint` request, you identify
|
566
|
+
# the volume by providing its Amazon Resource Name (ARN). You must also
|
567
|
+
# provide a description for the snapshot. When AWS Storage Gateway takes
|
568
|
+
# a snapshot of the specified volume, the snapshot and its description
|
569
|
+
# appear in the AWS Storage Gateway console. In response, AWS Storage
|
570
|
+
# Gateway returns you a snapshot ID. You can use this snapshot ID to
|
571
|
+
# check the snapshot progress or later use it when you want to create a
|
572
|
+
# volume from a snapshot.
|
573
|
+
#
|
574
|
+
# <note markdown="1"> To list or delete a snapshot, you must use the Amazon EC2 API. For
|
575
|
+
# more information, in *Amazon Elastic Compute Cloud API Reference*.
|
576
|
+
#
|
577
|
+
# </note>
|
578
|
+
# @option params [required, String] :volume_arn
|
579
|
+
# @option params [required, String] :snapshot_description
|
580
|
+
# @return [Types::CreateSnapshotFromVolumeRecoveryPointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
581
|
+
#
|
582
|
+
# * {Types::CreateSnapshotFromVolumeRecoveryPointOutput#snapshot_id #SnapshotId} => String
|
583
|
+
# * {Types::CreateSnapshotFromVolumeRecoveryPointOutput#volume_arn #VolumeARN} => String
|
584
|
+
# * {Types::CreateSnapshotFromVolumeRecoveryPointOutput#volume_recovery_point_time #VolumeRecoveryPointTime} => String
|
585
|
+
#
|
586
|
+
# @example Request syntax with placeholder values
|
587
|
+
# resp = client.create_snapshot_from_volume_recovery_point({
|
588
|
+
# volume_arn: "VolumeARN", # required
|
589
|
+
# snapshot_description: "SnapshotDescription", # required
|
590
|
+
# })
|
591
|
+
#
|
592
|
+
# @example Response structure
|
593
|
+
# resp.snapshot_id #=> String
|
594
|
+
# resp.volume_arn #=> String
|
595
|
+
# resp.volume_recovery_point_time #=> String
|
596
|
+
# @overload create_snapshot_from_volume_recovery_point(params = {})
|
597
|
+
# @param [Hash] params ({})
|
598
|
+
def create_snapshot_from_volume_recovery_point(params = {}, options = {})
|
599
|
+
req = build_request(:create_snapshot_from_volume_recovery_point, params)
|
600
|
+
req.send_request(options)
|
601
|
+
end
|
602
|
+
|
603
|
+
# Creates a volume on a specified gateway. This operation is supported
|
604
|
+
# only for the gateway-stored volume architecture.
|
605
|
+
#
|
606
|
+
# The size of the volume to create is inferred from the disk size. You
|
607
|
+
# can choose to preserve existing data on the disk, create volume from
|
608
|
+
# an existing snapshot, or create an empty volume. If you choose to
|
609
|
+
# create an empty gateway volume, then any existing data on the disk is
|
610
|
+
# erased.
|
611
|
+
#
|
612
|
+
# In the request you must specify the gateway and the disk information
|
613
|
+
# on which you are creating the volume. In response, AWS Storage Gateway
|
614
|
+
# creates the volume and returns volume information such as the volume
|
615
|
+
# Amazon Resource Name (ARN), its size, and the iSCSI target ARN that
|
616
|
+
# initiators can use to connect to the volume target.
|
617
|
+
# @option params [required, String] :gateway_arn
|
618
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
619
|
+
# operation to return a list of gateways for your account and region.
|
620
|
+
# @option params [required, String] :disk_id
|
621
|
+
# The unique identifier for the gateway local disk that is configured as
|
622
|
+
# a stored volume. Use [ListLocalDisks][1] to list disk IDs for a
|
623
|
+
# gateway.
|
624
|
+
#
|
625
|
+
#
|
626
|
+
#
|
627
|
+
# [1]: http://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html
|
628
|
+
# @option params [String] :snapshot_id
|
629
|
+
# The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
|
630
|
+
# the new stored volume. Specify this field if you want to create the
|
631
|
+
# iSCSI storage volume from a snapshot otherwise do not include this
|
632
|
+
# field. To list snapshots for your account use [DescribeSnapshots][1]
|
633
|
+
# in the *Amazon Elastic Compute Cloud API Reference*.
|
634
|
+
#
|
635
|
+
#
|
636
|
+
#
|
637
|
+
# [1]: http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html
|
638
|
+
# @option params [required, Boolean] :preserve_existing_data
|
639
|
+
# Specify this field as true if you want to preserve the data on the
|
640
|
+
# local disk. Otherwise, specifying this field as false creates an empty
|
641
|
+
# volume.
|
642
|
+
#
|
643
|
+
# Valid Values: true, false
|
644
|
+
# @option params [required, String] :target_name
|
645
|
+
# The name of the iSCSI target used by initiators to connect to the
|
646
|
+
# target and as a suffix for the target ARN. For example, specifying
|
647
|
+
# `TargetName` as *myvolume* results in the target ARN of
|
648
|
+
# arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.
|
649
|
+
# The target name must be unique across all volumes of a gateway.
|
650
|
+
# @option params [required, String] :network_interface_id
|
651
|
+
# The network interface of the gateway on which to expose the iSCSI
|
652
|
+
# target. Only IPv4 addresses are accepted. Use
|
653
|
+
# DescribeGatewayInformation to get a list of the network interfaces
|
654
|
+
# available on a gateway.
|
655
|
+
#
|
656
|
+
# Valid Values: A valid IP address.
|
657
|
+
# @return [Types::CreateStorediSCSIVolumeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
658
|
+
#
|
659
|
+
# * {Types::CreateStorediSCSIVolumeOutput#volume_arn #VolumeARN} => String
|
660
|
+
# * {Types::CreateStorediSCSIVolumeOutput#volume_size_in_bytes #VolumeSizeInBytes} => Integer
|
661
|
+
# * {Types::CreateStorediSCSIVolumeOutput#target_arn #TargetARN} => String
|
662
|
+
#
|
663
|
+
# @example Request syntax with placeholder values
|
664
|
+
# resp = client.create_stored_iscsi_volume({
|
665
|
+
# gateway_arn: "GatewayARN", # required
|
666
|
+
# disk_id: "DiskId", # required
|
667
|
+
# snapshot_id: "SnapshotId",
|
668
|
+
# preserve_existing_data: false, # required
|
669
|
+
# target_name: "TargetName", # required
|
670
|
+
# network_interface_id: "NetworkInterfaceId", # required
|
671
|
+
# })
|
672
|
+
#
|
673
|
+
# @example Response structure
|
674
|
+
# resp.volume_arn #=> String
|
675
|
+
# resp.volume_size_in_bytes #=> Integer
|
676
|
+
# resp.target_arn #=> String
|
677
|
+
# @overload create_stored_iscsi_volume(params = {})
|
678
|
+
# @param [Hash] params ({})
|
679
|
+
def create_stored_iscsi_volume(params = {}, options = {})
|
680
|
+
req = build_request(:create_stored_iscsi_volume, params)
|
681
|
+
req.send_request(options)
|
682
|
+
end
|
683
|
+
|
684
|
+
# Creates a virtual tape by using your own barcode. You write data to
|
685
|
+
# the virtual tape and then archive the tape.
|
686
|
+
#
|
687
|
+
# <note markdown="1">Cache storage must be allocated to the gateway before you can create a
|
688
|
+
# virtual tape. Use the AddCache operation to add cache storage to a
|
689
|
+
# gateway.
|
690
|
+
#
|
691
|
+
# </note>
|
692
|
+
# @option params [required, String] :gateway_arn
|
693
|
+
# The unique Amazon Resource Name (ARN) that represents the gateway to
|
694
|
+
# associate the virtual tape with. Use the ListGateways operation to
|
695
|
+
# return a list of gateways for your account and region.
|
696
|
+
# @option params [required, Integer] :tape_size_in_bytes
|
697
|
+
# The size, in bytes, of the virtual tape that you want to create.
|
698
|
+
#
|
699
|
+
# <note markdown="1">The size must be aligned by gigabyte (1024*1024*1024 byte).
|
700
|
+
#
|
701
|
+
# </note>
|
702
|
+
# @option params [required, String] :tape_barcode
|
703
|
+
# The barcode that you want to assign to the tape.
|
704
|
+
# @return [Types::CreateTapeWithBarcodeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
705
|
+
#
|
706
|
+
# * {Types::CreateTapeWithBarcodeOutput#tape_arn #TapeARN} => String
|
707
|
+
#
|
708
|
+
# @example Request syntax with placeholder values
|
709
|
+
# resp = client.create_tape_with_barcode({
|
710
|
+
# gateway_arn: "GatewayARN", # required
|
711
|
+
# tape_size_in_bytes: 1, # required
|
712
|
+
# tape_barcode: "TapeBarcode", # required
|
713
|
+
# })
|
714
|
+
#
|
715
|
+
# @example Response structure
|
716
|
+
# resp.tape_arn #=> String
|
717
|
+
# @overload create_tape_with_barcode(params = {})
|
718
|
+
# @param [Hash] params ({})
|
719
|
+
def create_tape_with_barcode(params = {}, options = {})
|
720
|
+
req = build_request(:create_tape_with_barcode, params)
|
721
|
+
req.send_request(options)
|
722
|
+
end
|
723
|
+
|
724
|
+
# Creates one or more virtual tapes. You write data to the virtual tapes
|
725
|
+
# and then archive the tapes.
|
726
|
+
#
|
727
|
+
# <note markdown="1">Cache storage must be allocated to the gateway before you can create
|
728
|
+
# virtual tapes. Use the AddCache operation to add cache storage to a
|
729
|
+
# gateway.
|
730
|
+
#
|
731
|
+
# </note>
|
732
|
+
# @option params [required, String] :gateway_arn
|
733
|
+
# The unique Amazon Resource Name (ARN) that represents the gateway to
|
734
|
+
# associate the virtual tapes with. Use the ListGateways operation to
|
735
|
+
# return a list of gateways for your account and region.
|
736
|
+
# @option params [required, Integer] :tape_size_in_bytes
|
737
|
+
# The size, in bytes, of the virtual tapes that you want to create.
|
738
|
+
#
|
739
|
+
# <note markdown="1">The size must be aligned by gigabyte (1024*1024*1024 byte).
|
740
|
+
#
|
741
|
+
# </note>
|
742
|
+
# @option params [required, String] :client_token
|
743
|
+
# A unique identifier that you use to retry a request. If you retry a
|
744
|
+
# request, use the same `ClientToken` you specified in the initial
|
745
|
+
# request.
|
746
|
+
#
|
747
|
+
# <note markdown="1">Using the same `ClientToken` prevents creating the tape multiple
|
748
|
+
# times.
|
749
|
+
#
|
750
|
+
# </note>
|
751
|
+
# @option params [required, Integer] :num_tapes_to_create
|
752
|
+
# The number of virtual tapes that you want to create.
|
753
|
+
# @option params [required, String] :tape_barcode_prefix
|
754
|
+
# A prefix that you append to the barcode of the virtual tape you are
|
755
|
+
# creating. This prefix makes the barcode unique.
|
756
|
+
#
|
757
|
+
# <note markdown="1">The prefix must be 1 to 4 characters in length and must be one of the
|
758
|
+
# uppercase letters from A to Z.
|
759
|
+
#
|
760
|
+
# </note>
|
761
|
+
# @return [Types::CreateTapesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
762
|
+
#
|
763
|
+
# * {Types::CreateTapesOutput#tape_arns #TapeARNs} => Array<String>
|
764
|
+
#
|
765
|
+
# @example Request syntax with placeholder values
|
766
|
+
# resp = client.create_tapes({
|
767
|
+
# gateway_arn: "GatewayARN", # required
|
768
|
+
# tape_size_in_bytes: 1, # required
|
769
|
+
# client_token: "ClientToken", # required
|
770
|
+
# num_tapes_to_create: 1, # required
|
771
|
+
# tape_barcode_prefix: "TapeBarcodePrefix", # required
|
772
|
+
# })
|
773
|
+
#
|
774
|
+
# @example Response structure
|
775
|
+
# resp.tape_arns #=> Array
|
776
|
+
# resp.tape_arns[0] #=> String
|
777
|
+
# @overload create_tapes(params = {})
|
778
|
+
# @param [Hash] params ({})
|
779
|
+
def create_tapes(params = {}, options = {})
|
780
|
+
req = build_request(:create_tapes, params)
|
781
|
+
req.send_request(options)
|
782
|
+
end
|
783
|
+
|
784
|
+
# Deletes the bandwidth rate limits of a gateway. You can delete either
|
785
|
+
# the upload and download bandwidth rate limit, or you can delete both.
|
786
|
+
# If you delete only one of the limits, the other limit remains
|
787
|
+
# unchanged. To specify which gateway to work with, use the Amazon
|
788
|
+
# Resource Name (ARN) of the gateway in your request.
|
789
|
+
# @option params [required, String] :gateway_arn
|
790
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
791
|
+
# operation to return a list of gateways for your account and region.
|
792
|
+
# @option params [required, String] :bandwidth_type
|
793
|
+
# @return [Types::DeleteBandwidthRateLimitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
794
|
+
#
|
795
|
+
# * {Types::DeleteBandwidthRateLimitOutput#gateway_arn #GatewayARN} => String
|
796
|
+
#
|
797
|
+
# @example Request syntax with placeholder values
|
798
|
+
# resp = client.delete_bandwidth_rate_limit({
|
799
|
+
# gateway_arn: "GatewayARN", # required
|
800
|
+
# bandwidth_type: "BandwidthType", # required
|
801
|
+
# })
|
802
|
+
#
|
803
|
+
# @example Response structure
|
804
|
+
# resp.gateway_arn #=> String
|
805
|
+
# @overload delete_bandwidth_rate_limit(params = {})
|
806
|
+
# @param [Hash] params ({})
|
807
|
+
def delete_bandwidth_rate_limit(params = {}, options = {})
|
808
|
+
req = build_request(:delete_bandwidth_rate_limit, params)
|
809
|
+
req.send_request(options)
|
810
|
+
end
|
811
|
+
|
812
|
+
# Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials
|
813
|
+
# for a specified iSCSI target and initiator pair.
|
814
|
+
# @option params [required, String] :target_arn
|
815
|
+
# The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
|
816
|
+
# DescribeStorediSCSIVolumes operation to return to retrieve the
|
817
|
+
# TargetARN for specified VolumeARN.
|
818
|
+
# @option params [required, String] :initiator_name
|
819
|
+
# The iSCSI initiator that connects to the target.
|
820
|
+
# @return [Types::DeleteChapCredentialsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
821
|
+
#
|
822
|
+
# * {Types::DeleteChapCredentialsOutput#target_arn #TargetARN} => String
|
823
|
+
# * {Types::DeleteChapCredentialsOutput#initiator_name #InitiatorName} => String
|
824
|
+
#
|
825
|
+
# @example Request syntax with placeholder values
|
826
|
+
# resp = client.delete_chap_credentials({
|
827
|
+
# target_arn: "TargetARN", # required
|
828
|
+
# initiator_name: "IqnName", # required
|
829
|
+
# })
|
830
|
+
#
|
831
|
+
# @example Response structure
|
832
|
+
# resp.target_arn #=> String
|
833
|
+
# resp.initiator_name #=> String
|
834
|
+
# @overload delete_chap_credentials(params = {})
|
835
|
+
# @param [Hash] params ({})
|
836
|
+
def delete_chap_credentials(params = {}, options = {})
|
837
|
+
req = build_request(:delete_chap_credentials, params)
|
838
|
+
req.send_request(options)
|
839
|
+
end
|
840
|
+
|
841
|
+
# Deletes a gateway. To specify which gateway to delete, use the Amazon
|
842
|
+
# Resource Name (ARN) of the gateway in your request. The operation
|
843
|
+
# deletes the gateway; however, it does not delete the gateway virtual
|
844
|
+
# machine (VM) from your host computer.
|
845
|
+
#
|
846
|
+
# After you delete a gateway, you cannot reactivate it. Completed
|
847
|
+
# snapshots of the gateway volumes are not deleted upon deleting the
|
848
|
+
# gateway, however, pending snapshots will not complete. After you
|
849
|
+
# delete a gateway, your next step is to remove it from your
|
850
|
+
# environment.
|
851
|
+
#
|
852
|
+
# You no longer pay software charges after the gateway is deleted;
|
853
|
+
# however, your existing Amazon EBS snapshots persist and you will
|
854
|
+
# continue to be billed for these snapshots. You can choose to remove
|
855
|
+
# all remaining Amazon EBS snapshots by canceling your Amazon EC2
|
856
|
+
# subscription. If you prefer not to cancel your Amazon EC2
|
857
|
+
# subscription, you can delete your snapshots using the Amazon EC2
|
858
|
+
# console. For more information, see the [ AWS Storage Gateway Detail
|
859
|
+
# Page][1].
|
860
|
+
#
|
861
|
+
#
|
862
|
+
#
|
863
|
+
# [1]: http://aws.amazon.com/storagegateway
|
864
|
+
# @option params [required, String] :gateway_arn
|
865
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
866
|
+
# operation to return a list of gateways for your account and region.
|
867
|
+
# @return [Types::DeleteGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
868
|
+
#
|
869
|
+
# * {Types::DeleteGatewayOutput#gateway_arn #GatewayARN} => String
|
870
|
+
#
|
871
|
+
# @example Request syntax with placeholder values
|
872
|
+
# resp = client.delete_gateway({
|
873
|
+
# gateway_arn: "GatewayARN", # required
|
874
|
+
# })
|
875
|
+
#
|
876
|
+
# @example Response structure
|
877
|
+
# resp.gateway_arn #=> String
|
878
|
+
# @overload delete_gateway(params = {})
|
879
|
+
# @param [Hash] params ({})
|
880
|
+
def delete_gateway(params = {}, options = {})
|
881
|
+
req = build_request(:delete_gateway, params)
|
882
|
+
req.send_request(options)
|
883
|
+
end
|
884
|
+
|
885
|
+
# Deletes a snapshot of a volume.
|
886
|
+
#
|
887
|
+
# You can take snapshots of your gateway volumes on a scheduled or ad
|
888
|
+
# hoc basis. This API action enables you to delete a snapshot schedule
|
889
|
+
# for a volume. For more information, see [Working with Snapshots][1].
|
890
|
+
# In the `DeleteSnapshotSchedule` request, you identify the volume by
|
891
|
+
# providing its Amazon Resource Name (ARN).
|
892
|
+
#
|
893
|
+
# <note markdown="1"> To list or delete a snapshot, you must use the Amazon EC2 API. in
|
894
|
+
# *Amazon Elastic Compute Cloud API Reference*.
|
895
|
+
#
|
896
|
+
# </note>
|
897
|
+
#
|
898
|
+
#
|
899
|
+
#
|
900
|
+
# [1]: http://docs.aws.amazon.com/storagegateway/latest/userguide/WorkingWithSnapshots.html
|
901
|
+
# @option params [required, String] :volume_arn
|
902
|
+
# @return [Types::DeleteSnapshotScheduleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
903
|
+
#
|
904
|
+
# * {Types::DeleteSnapshotScheduleOutput#volume_arn #VolumeARN} => String
|
905
|
+
#
|
906
|
+
# @example Request syntax with placeholder values
|
907
|
+
# resp = client.delete_snapshot_schedule({
|
908
|
+
# volume_arn: "VolumeARN", # required
|
909
|
+
# })
|
910
|
+
#
|
911
|
+
# @example Response structure
|
912
|
+
# resp.volume_arn #=> String
|
913
|
+
# @overload delete_snapshot_schedule(params = {})
|
914
|
+
# @param [Hash] params ({})
|
915
|
+
def delete_snapshot_schedule(params = {}, options = {})
|
916
|
+
req = build_request(:delete_snapshot_schedule, params)
|
917
|
+
req.send_request(options)
|
918
|
+
end
|
919
|
+
|
920
|
+
# Deletes the specified virtual tape.
|
921
|
+
# @option params [required, String] :gateway_arn
|
922
|
+
# The unique Amazon Resource Name (ARN) of the gateway that the virtual
|
923
|
+
# tape to delete is associated with. Use the ListGateways operation to
|
924
|
+
# return a list of gateways for your account and region.
|
925
|
+
# @option params [required, String] :tape_arn
|
926
|
+
# The Amazon Resource Name (ARN) of the virtual tape to delete.
|
927
|
+
# @return [Types::DeleteTapeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
928
|
+
#
|
929
|
+
# * {Types::DeleteTapeOutput#tape_arn #TapeARN} => String
|
930
|
+
#
|
931
|
+
# @example Request syntax with placeholder values
|
932
|
+
# resp = client.delete_tape({
|
933
|
+
# gateway_arn: "GatewayARN", # required
|
934
|
+
# tape_arn: "TapeARN", # required
|
935
|
+
# })
|
936
|
+
#
|
937
|
+
# @example Response structure
|
938
|
+
# resp.tape_arn #=> String
|
939
|
+
# @overload delete_tape(params = {})
|
940
|
+
# @param [Hash] params ({})
|
941
|
+
def delete_tape(params = {}, options = {})
|
942
|
+
req = build_request(:delete_tape, params)
|
943
|
+
req.send_request(options)
|
944
|
+
end
|
945
|
+
|
946
|
+
# Deletes the specified virtual tape from the virtual tape shelf (VTS).
|
947
|
+
# @option params [required, String] :tape_arn
|
948
|
+
# The Amazon Resource Name (ARN) of the virtual tape to delete from the
|
949
|
+
# virtual tape shelf (VTS).
|
950
|
+
# @return [Types::DeleteTapeArchiveOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
951
|
+
#
|
952
|
+
# * {Types::DeleteTapeArchiveOutput#tape_arn #TapeARN} => String
|
953
|
+
#
|
954
|
+
# @example Request syntax with placeholder values
|
955
|
+
# resp = client.delete_tape_archive({
|
956
|
+
# tape_arn: "TapeARN", # required
|
957
|
+
# })
|
958
|
+
#
|
959
|
+
# @example Response structure
|
960
|
+
# resp.tape_arn #=> String
|
961
|
+
# @overload delete_tape_archive(params = {})
|
962
|
+
# @param [Hash] params ({})
|
963
|
+
def delete_tape_archive(params = {}, options = {})
|
964
|
+
req = build_request(:delete_tape_archive, params)
|
965
|
+
req.send_request(options)
|
966
|
+
end
|
967
|
+
|
968
|
+
# Deletes the specified gateway volume that you previously created using
|
969
|
+
# the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. For
|
970
|
+
# gateway-stored volumes, the local disk that was configured as the
|
971
|
+
# storage volume is not deleted. You can reuse the local disk to create
|
972
|
+
# another storage volume.
|
973
|
+
#
|
974
|
+
# Before you delete a gateway volume, make sure there are no iSCSI
|
975
|
+
# connections to the volume you are deleting. You should also make sure
|
976
|
+
# there is no snapshot in progress. You can use the Amazon Elastic
|
977
|
+
# Compute Cloud (Amazon EC2) API to query snapshots on the volume you
|
978
|
+
# are deleting and check the snapshot status. For more information, go
|
979
|
+
# to [DescribeSnapshots][1] in the *Amazon Elastic Compute Cloud API
|
980
|
+
# Reference*.
|
981
|
+
#
|
982
|
+
# In the request, you must provide the Amazon Resource Name (ARN) of the
|
983
|
+
# storage volume you want to delete.
|
984
|
+
#
|
985
|
+
#
|
986
|
+
#
|
987
|
+
# [1]: http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html
|
988
|
+
# @option params [required, String] :volume_arn
|
989
|
+
# The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
|
990
|
+
# operation to return a list of gateway volumes.
|
991
|
+
# @return [Types::DeleteVolumeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
992
|
+
#
|
993
|
+
# * {Types::DeleteVolumeOutput#volume_arn #VolumeARN} => String
|
994
|
+
#
|
995
|
+
# @example Request syntax with placeholder values
|
996
|
+
# resp = client.delete_volume({
|
997
|
+
# volume_arn: "VolumeARN", # required
|
998
|
+
# })
|
999
|
+
#
|
1000
|
+
# @example Response structure
|
1001
|
+
# resp.volume_arn #=> String
|
1002
|
+
# @overload delete_volume(params = {})
|
1003
|
+
# @param [Hash] params ({})
|
1004
|
+
def delete_volume(params = {}, options = {})
|
1005
|
+
req = build_request(:delete_volume, params)
|
1006
|
+
req.send_request(options)
|
1007
|
+
end
|
1008
|
+
|
1009
|
+
# Returns the bandwidth rate limits of a gateway. By default, these
|
1010
|
+
# limits are not set, which means no bandwidth rate limiting is in
|
1011
|
+
# effect.
|
1012
|
+
#
|
1013
|
+
# This operation only returns a value for a bandwidth rate limit only if
|
1014
|
+
# the limit is set. If no limits are set for the gateway, then this
|
1015
|
+
# operation returns only the gateway ARN in the response body. To
|
1016
|
+
# specify which gateway to describe, use the Amazon Resource Name (ARN)
|
1017
|
+
# of the gateway in your request.
|
1018
|
+
# @option params [required, String] :gateway_arn
|
1019
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1020
|
+
# operation to return a list of gateways for your account and region.
|
1021
|
+
# @return [Types::DescribeBandwidthRateLimitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1022
|
+
#
|
1023
|
+
# * {Types::DescribeBandwidthRateLimitOutput#gateway_arn #GatewayARN} => String
|
1024
|
+
# * {Types::DescribeBandwidthRateLimitOutput#average_upload_rate_limit_in_bits_per_sec #AverageUploadRateLimitInBitsPerSec} => Integer
|
1025
|
+
# * {Types::DescribeBandwidthRateLimitOutput#average_download_rate_limit_in_bits_per_sec #AverageDownloadRateLimitInBitsPerSec} => Integer
|
1026
|
+
#
|
1027
|
+
# @example Request syntax with placeholder values
|
1028
|
+
# resp = client.describe_bandwidth_rate_limit({
|
1029
|
+
# gateway_arn: "GatewayARN", # required
|
1030
|
+
# })
|
1031
|
+
#
|
1032
|
+
# @example Response structure
|
1033
|
+
# resp.gateway_arn #=> String
|
1034
|
+
# resp.average_upload_rate_limit_in_bits_per_sec #=> Integer
|
1035
|
+
# resp.average_download_rate_limit_in_bits_per_sec #=> Integer
|
1036
|
+
# @overload describe_bandwidth_rate_limit(params = {})
|
1037
|
+
# @param [Hash] params ({})
|
1038
|
+
def describe_bandwidth_rate_limit(params = {}, options = {})
|
1039
|
+
req = build_request(:describe_bandwidth_rate_limit, params)
|
1040
|
+
req.send_request(options)
|
1041
|
+
end
|
1042
|
+
|
1043
|
+
# Returns information about the cache of a gateway. This operation is
|
1044
|
+
# supported only for the gateway-cached volume architecture.
|
1045
|
+
#
|
1046
|
+
# The response includes disk IDs that are configured as cache, and it
|
1047
|
+
# includes the amount of cache allocated and used.
|
1048
|
+
# @option params [required, String] :gateway_arn
|
1049
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1050
|
+
# operation to return a list of gateways for your account and region.
|
1051
|
+
# @return [Types::DescribeCacheOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1052
|
+
#
|
1053
|
+
# * {Types::DescribeCacheOutput#gateway_arn #GatewayARN} => String
|
1054
|
+
# * {Types::DescribeCacheOutput#disk_ids #DiskIds} => Array<String>
|
1055
|
+
# * {Types::DescribeCacheOutput#cache_allocated_in_bytes #CacheAllocatedInBytes} => Integer
|
1056
|
+
# * {Types::DescribeCacheOutput#cache_used_percentage #CacheUsedPercentage} => Float
|
1057
|
+
# * {Types::DescribeCacheOutput#cache_dirty_percentage #CacheDirtyPercentage} => Float
|
1058
|
+
# * {Types::DescribeCacheOutput#cache_hit_percentage #CacheHitPercentage} => Float
|
1059
|
+
# * {Types::DescribeCacheOutput#cache_miss_percentage #CacheMissPercentage} => Float
|
1060
|
+
#
|
1061
|
+
# @example Request syntax with placeholder values
|
1062
|
+
# resp = client.describe_cache({
|
1063
|
+
# gateway_arn: "GatewayARN", # required
|
1064
|
+
# })
|
1065
|
+
#
|
1066
|
+
# @example Response structure
|
1067
|
+
# resp.gateway_arn #=> String
|
1068
|
+
# resp.disk_ids #=> Array
|
1069
|
+
# resp.disk_ids[0] #=> String
|
1070
|
+
# resp.cache_allocated_in_bytes #=> Integer
|
1071
|
+
# resp.cache_used_percentage #=> Float
|
1072
|
+
# resp.cache_dirty_percentage #=> Float
|
1073
|
+
# resp.cache_hit_percentage #=> Float
|
1074
|
+
# resp.cache_miss_percentage #=> Float
|
1075
|
+
# @overload describe_cache(params = {})
|
1076
|
+
# @param [Hash] params ({})
|
1077
|
+
def describe_cache(params = {}, options = {})
|
1078
|
+
req = build_request(:describe_cache, params)
|
1079
|
+
req.send_request(options)
|
1080
|
+
end
|
1081
|
+
|
1082
|
+
# Returns a description of the gateway volumes specified in the request.
|
1083
|
+
# This operation is supported only for the gateway-cached volume
|
1084
|
+
# architecture.
|
1085
|
+
#
|
1086
|
+
# The list of gateway volumes in the request must be from one gateway.
|
1087
|
+
# In the response Amazon Storage Gateway returns volume information
|
1088
|
+
# sorted by volume Amazon Resource Name (ARN).
|
1089
|
+
# @option params [required, Array<String>] :volume_arns
|
1090
|
+
# @return [Types::DescribeCachediSCSIVolumesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1091
|
+
#
|
1092
|
+
# * {Types::DescribeCachediSCSIVolumesOutput#cached_iscsi_volumes #CachediSCSIVolumes} => Array<Types::CachediSCSIVolume>
|
1093
|
+
#
|
1094
|
+
# @example Request syntax with placeholder values
|
1095
|
+
# resp = client.describe_cached_iscsi_volumes({
|
1096
|
+
# volume_arns: ["VolumeARN"], # required
|
1097
|
+
# })
|
1098
|
+
#
|
1099
|
+
# @example Response structure
|
1100
|
+
# resp.cached_iscsi_volumes #=> Array
|
1101
|
+
# resp.cached_iscsi_volumes[0].volume_arn #=> String
|
1102
|
+
# resp.cached_iscsi_volumes[0].volume_id #=> String
|
1103
|
+
# resp.cached_iscsi_volumes[0].volume_type #=> String
|
1104
|
+
# resp.cached_iscsi_volumes[0].volume_status #=> String
|
1105
|
+
# resp.cached_iscsi_volumes[0].volume_size_in_bytes #=> Integer
|
1106
|
+
# resp.cached_iscsi_volumes[0].volume_progress #=> Float
|
1107
|
+
# resp.cached_iscsi_volumes[0].source_snapshot_id #=> String
|
1108
|
+
# resp.cached_iscsi_volumes[0].volume_iscsi_attributes.target_arn #=> String
|
1109
|
+
# resp.cached_iscsi_volumes[0].volume_iscsi_attributes.network_interface_id #=> String
|
1110
|
+
# resp.cached_iscsi_volumes[0].volume_iscsi_attributes.network_interface_port #=> Integer
|
1111
|
+
# resp.cached_iscsi_volumes[0].volume_iscsi_attributes.lun_number #=> Integer
|
1112
|
+
# resp.cached_iscsi_volumes[0].volume_iscsi_attributes.chap_enabled #=> Boolean
|
1113
|
+
# @overload describe_cached_iscsi_volumes(params = {})
|
1114
|
+
# @param [Hash] params ({})
|
1115
|
+
def describe_cached_iscsi_volumes(params = {}, options = {})
|
1116
|
+
req = build_request(:describe_cached_iscsi_volumes, params)
|
1117
|
+
req.send_request(options)
|
1118
|
+
end
|
1119
|
+
|
1120
|
+
# Returns an array of Challenge-Handshake Authentication Protocol (CHAP)
|
1121
|
+
# credentials information for a specified iSCSI target, one for each
|
1122
|
+
# target-initiator pair.
|
1123
|
+
# @option params [required, String] :target_arn
|
1124
|
+
# The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
|
1125
|
+
# DescribeStorediSCSIVolumes operation to return to retrieve the
|
1126
|
+
# TargetARN for specified VolumeARN.
|
1127
|
+
# @return [Types::DescribeChapCredentialsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1128
|
+
#
|
1129
|
+
# * {Types::DescribeChapCredentialsOutput#chap_credentials #ChapCredentials} => Array<Types::ChapInfo>
|
1130
|
+
#
|
1131
|
+
# @example Request syntax with placeholder values
|
1132
|
+
# resp = client.describe_chap_credentials({
|
1133
|
+
# target_arn: "TargetARN", # required
|
1134
|
+
# })
|
1135
|
+
#
|
1136
|
+
# @example Response structure
|
1137
|
+
# resp.chap_credentials #=> Array
|
1138
|
+
# resp.chap_credentials[0].target_arn #=> String
|
1139
|
+
# resp.chap_credentials[0].secret_to_authenticate_initiator #=> String
|
1140
|
+
# resp.chap_credentials[0].initiator_name #=> String
|
1141
|
+
# resp.chap_credentials[0].secret_to_authenticate_target #=> String
|
1142
|
+
# @overload describe_chap_credentials(params = {})
|
1143
|
+
# @param [Hash] params ({})
|
1144
|
+
def describe_chap_credentials(params = {}, options = {})
|
1145
|
+
req = build_request(:describe_chap_credentials, params)
|
1146
|
+
req.send_request(options)
|
1147
|
+
end
|
1148
|
+
|
1149
|
+
# Returns metadata about a gateway such as its name, network interfaces,
|
1150
|
+
# configured time zone, and the state (whether the gateway is running or
|
1151
|
+
# not). To specify which gateway to describe, use the Amazon Resource
|
1152
|
+
# Name (ARN) of the gateway in your request.
|
1153
|
+
# @option params [required, String] :gateway_arn
|
1154
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1155
|
+
# operation to return a list of gateways for your account and region.
|
1156
|
+
# @return [Types::DescribeGatewayInformationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1157
|
+
#
|
1158
|
+
# * {Types::DescribeGatewayInformationOutput#gateway_arn #GatewayARN} => String
|
1159
|
+
# * {Types::DescribeGatewayInformationOutput#gateway_id #GatewayId} => String
|
1160
|
+
# * {Types::DescribeGatewayInformationOutput#gateway_name #GatewayName} => String
|
1161
|
+
# * {Types::DescribeGatewayInformationOutput#gateway_timezone #GatewayTimezone} => String
|
1162
|
+
# * {Types::DescribeGatewayInformationOutput#gateway_state #GatewayState} => String
|
1163
|
+
# * {Types::DescribeGatewayInformationOutput#gateway_network_interfaces #GatewayNetworkInterfaces} => Array<Types::NetworkInterface>
|
1164
|
+
# * {Types::DescribeGatewayInformationOutput#gateway_type #GatewayType} => String
|
1165
|
+
# * {Types::DescribeGatewayInformationOutput#next_update_availability_date #NextUpdateAvailabilityDate} => String
|
1166
|
+
# * {Types::DescribeGatewayInformationOutput#last_software_update #LastSoftwareUpdate} => String
|
1167
|
+
#
|
1168
|
+
# @example Request syntax with placeholder values
|
1169
|
+
# resp = client.describe_gateway_information({
|
1170
|
+
# gateway_arn: "GatewayARN", # required
|
1171
|
+
# })
|
1172
|
+
#
|
1173
|
+
# @example Response structure
|
1174
|
+
# resp.gateway_arn #=> String
|
1175
|
+
# resp.gateway_id #=> String
|
1176
|
+
# resp.gateway_name #=> String
|
1177
|
+
# resp.gateway_timezone #=> String
|
1178
|
+
# resp.gateway_state #=> String
|
1179
|
+
# resp.gateway_network_interfaces #=> Array
|
1180
|
+
# resp.gateway_network_interfaces[0].ipv_4_address #=> String
|
1181
|
+
# resp.gateway_network_interfaces[0].mac_address #=> String
|
1182
|
+
# resp.gateway_network_interfaces[0].ipv_6_address #=> String
|
1183
|
+
# resp.gateway_type #=> String
|
1184
|
+
# resp.next_update_availability_date #=> String
|
1185
|
+
# resp.last_software_update #=> String
|
1186
|
+
# @overload describe_gateway_information(params = {})
|
1187
|
+
# @param [Hash] params ({})
|
1188
|
+
def describe_gateway_information(params = {}, options = {})
|
1189
|
+
req = build_request(:describe_gateway_information, params)
|
1190
|
+
req.send_request(options)
|
1191
|
+
end
|
1192
|
+
|
1193
|
+
# Returns your gateway's weekly maintenance start time including the
|
1194
|
+
# day and time of the week. Note that values are in terms of the
|
1195
|
+
# gateway's time zone.
|
1196
|
+
# @option params [required, String] :gateway_arn
|
1197
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1198
|
+
# operation to return a list of gateways for your account and region.
|
1199
|
+
# @return [Types::DescribeMaintenanceStartTimeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1200
|
+
#
|
1201
|
+
# * {Types::DescribeMaintenanceStartTimeOutput#gateway_arn #GatewayARN} => String
|
1202
|
+
# * {Types::DescribeMaintenanceStartTimeOutput#hour_of_day #HourOfDay} => Integer
|
1203
|
+
# * {Types::DescribeMaintenanceStartTimeOutput#minute_of_hour #MinuteOfHour} => Integer
|
1204
|
+
# * {Types::DescribeMaintenanceStartTimeOutput#day_of_week #DayOfWeek} => Integer
|
1205
|
+
# * {Types::DescribeMaintenanceStartTimeOutput#timezone #Timezone} => String
|
1206
|
+
#
|
1207
|
+
# @example Request syntax with placeholder values
|
1208
|
+
# resp = client.describe_maintenance_start_time({
|
1209
|
+
# gateway_arn: "GatewayARN", # required
|
1210
|
+
# })
|
1211
|
+
#
|
1212
|
+
# @example Response structure
|
1213
|
+
# resp.gateway_arn #=> String
|
1214
|
+
# resp.hour_of_day #=> Integer
|
1215
|
+
# resp.minute_of_hour #=> Integer
|
1216
|
+
# resp.day_of_week #=> Integer
|
1217
|
+
# resp.timezone #=> String
|
1218
|
+
# @overload describe_maintenance_start_time(params = {})
|
1219
|
+
# @param [Hash] params ({})
|
1220
|
+
def describe_maintenance_start_time(params = {}, options = {})
|
1221
|
+
req = build_request(:describe_maintenance_start_time, params)
|
1222
|
+
req.send_request(options)
|
1223
|
+
end
|
1224
|
+
|
1225
|
+
# Describes the snapshot schedule for the specified gateway volume. The
|
1226
|
+
# snapshot schedule information includes intervals at which snapshots
|
1227
|
+
# are automatically initiated on the volume.
|
1228
|
+
# @option params [required, String] :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 [Types::DescribeSnapshotScheduleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1232
|
+
#
|
1233
|
+
# * {Types::DescribeSnapshotScheduleOutput#volume_arn #VolumeARN} => String
|
1234
|
+
# * {Types::DescribeSnapshotScheduleOutput#start_at #StartAt} => Integer
|
1235
|
+
# * {Types::DescribeSnapshotScheduleOutput#recurrence_in_hours #RecurrenceInHours} => Integer
|
1236
|
+
# * {Types::DescribeSnapshotScheduleOutput#description #Description} => String
|
1237
|
+
# * {Types::DescribeSnapshotScheduleOutput#timezone #Timezone} => String
|
1238
|
+
#
|
1239
|
+
# @example Request syntax with placeholder values
|
1240
|
+
# resp = client.describe_snapshot_schedule({
|
1241
|
+
# volume_arn: "VolumeARN", # required
|
1242
|
+
# })
|
1243
|
+
#
|
1244
|
+
# @example Response structure
|
1245
|
+
# resp.volume_arn #=> String
|
1246
|
+
# resp.start_at #=> Integer
|
1247
|
+
# resp.recurrence_in_hours #=> Integer
|
1248
|
+
# resp.description #=> String
|
1249
|
+
# resp.timezone #=> String
|
1250
|
+
# @overload describe_snapshot_schedule(params = {})
|
1251
|
+
# @param [Hash] params ({})
|
1252
|
+
def describe_snapshot_schedule(params = {}, options = {})
|
1253
|
+
req = build_request(:describe_snapshot_schedule, params)
|
1254
|
+
req.send_request(options)
|
1255
|
+
end
|
1256
|
+
|
1257
|
+
# Returns the description of the gateway volumes specified in the
|
1258
|
+
# request. The list of gateway volumes in the request must be from one
|
1259
|
+
# gateway. In the response Amazon Storage Gateway returns volume
|
1260
|
+
# information sorted by volume ARNs.
|
1261
|
+
# @option params [required, Array<String>] :volume_arns
|
1262
|
+
# An array of strings where each string represents the Amazon Resource
|
1263
|
+
# Name (ARN) of a stored volume. All of the specified stored volumes
|
1264
|
+
# must from the same gateway. Use ListVolumes to get volume ARNs for a
|
1265
|
+
# gateway.
|
1266
|
+
# @return [Types::DescribeStorediSCSIVolumesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1267
|
+
#
|
1268
|
+
# * {Types::DescribeStorediSCSIVolumesOutput#stored_iscsi_volumes #StorediSCSIVolumes} => Array<Types::StorediSCSIVolume>
|
1269
|
+
#
|
1270
|
+
# @example Request syntax with placeholder values
|
1271
|
+
# resp = client.describe_stored_iscsi_volumes({
|
1272
|
+
# volume_arns: ["VolumeARN"], # required
|
1273
|
+
# })
|
1274
|
+
#
|
1275
|
+
# @example Response structure
|
1276
|
+
# resp.stored_iscsi_volumes #=> Array
|
1277
|
+
# resp.stored_iscsi_volumes[0].volume_arn #=> String
|
1278
|
+
# resp.stored_iscsi_volumes[0].volume_id #=> String
|
1279
|
+
# resp.stored_iscsi_volumes[0].volume_type #=> String
|
1280
|
+
# resp.stored_iscsi_volumes[0].volume_status #=> String
|
1281
|
+
# resp.stored_iscsi_volumes[0].volume_size_in_bytes #=> Integer
|
1282
|
+
# resp.stored_iscsi_volumes[0].volume_progress #=> Float
|
1283
|
+
# resp.stored_iscsi_volumes[0].volume_disk_id #=> String
|
1284
|
+
# resp.stored_iscsi_volumes[0].source_snapshot_id #=> String
|
1285
|
+
# resp.stored_iscsi_volumes[0].preserved_existing_data #=> Boolean
|
1286
|
+
# resp.stored_iscsi_volumes[0].volume_iscsi_attributes.target_arn #=> String
|
1287
|
+
# resp.stored_iscsi_volumes[0].volume_iscsi_attributes.network_interface_id #=> String
|
1288
|
+
# resp.stored_iscsi_volumes[0].volume_iscsi_attributes.network_interface_port #=> Integer
|
1289
|
+
# resp.stored_iscsi_volumes[0].volume_iscsi_attributes.lun_number #=> Integer
|
1290
|
+
# resp.stored_iscsi_volumes[0].volume_iscsi_attributes.chap_enabled #=> Boolean
|
1291
|
+
# @overload describe_stored_iscsi_volumes(params = {})
|
1292
|
+
# @param [Hash] params ({})
|
1293
|
+
def describe_stored_iscsi_volumes(params = {}, options = {})
|
1294
|
+
req = build_request(:describe_stored_iscsi_volumes, params)
|
1295
|
+
req.send_request(options)
|
1296
|
+
end
|
1297
|
+
|
1298
|
+
# Returns a description of specified virtual tapes in the virtual tape
|
1299
|
+
# shelf (VTS).
|
1300
|
+
#
|
1301
|
+
# If a specific `TapeARN` is not specified, AWS Storage Gateway returns
|
1302
|
+
# a description of all virtual tapes found in the VTS associated with
|
1303
|
+
# your account.
|
1304
|
+
# @option params [Array<String>] :tape_arns
|
1305
|
+
# Specifies one or more unique Amazon Resource Names (ARNs) that
|
1306
|
+
# represent the virtual tapes you want to describe.
|
1307
|
+
# @option params [String] :marker
|
1308
|
+
# An opaque string that indicates the position at which to begin
|
1309
|
+
# describing virtual tapes.
|
1310
|
+
# @option params [Integer] :limit
|
1311
|
+
# Specifies that the number of virtual tapes descried be limited to the
|
1312
|
+
# specified number.
|
1313
|
+
# @return [Types::DescribeTapeArchivesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1314
|
+
#
|
1315
|
+
# * {Types::DescribeTapeArchivesOutput#tape_archives #TapeArchives} => Array<Types::TapeArchive>
|
1316
|
+
# * {Types::DescribeTapeArchivesOutput#marker #Marker} => String
|
1317
|
+
#
|
1318
|
+
# @example Request syntax with placeholder values
|
1319
|
+
# resp = client.describe_tape_archives({
|
1320
|
+
# tape_arns: ["TapeARN"],
|
1321
|
+
# marker: "Marker",
|
1322
|
+
# limit: 1,
|
1323
|
+
# })
|
1324
|
+
#
|
1325
|
+
# @example Response structure
|
1326
|
+
# resp.tape_archives #=> Array
|
1327
|
+
# resp.tape_archives[0].tape_arn #=> String
|
1328
|
+
# resp.tape_archives[0].tape_barcode #=> String
|
1329
|
+
# resp.tape_archives[0].tape_size_in_bytes #=> Integer
|
1330
|
+
# resp.tape_archives[0].completion_time #=> Time
|
1331
|
+
# resp.tape_archives[0].retrieved_to #=> String
|
1332
|
+
# resp.tape_archives[0].tape_status #=> String
|
1333
|
+
# resp.marker #=> String
|
1334
|
+
# @overload describe_tape_archives(params = {})
|
1335
|
+
# @param [Hash] params ({})
|
1336
|
+
def describe_tape_archives(params = {}, options = {})
|
1337
|
+
req = build_request(:describe_tape_archives, params)
|
1338
|
+
req.send_request(options)
|
1339
|
+
end
|
1340
|
+
|
1341
|
+
# Returns a list of virtual tape recovery points that are available for
|
1342
|
+
# the specified gateway-VTL.
|
1343
|
+
#
|
1344
|
+
# A recovery point is a point-in-time view of a virtual tape at which
|
1345
|
+
# all the data on the virtual tape is consistent. If your gateway
|
1346
|
+
# crashes, virtual tapes that have recovery points can be recovered to a
|
1347
|
+
# new gateway.
|
1348
|
+
# @option params [required, String] :gateway_arn
|
1349
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1350
|
+
# operation to return a list of gateways for your account and region.
|
1351
|
+
# @option params [String] :marker
|
1352
|
+
# An opaque string that indicates the position at which to begin
|
1353
|
+
# describing the virtual tape recovery points.
|
1354
|
+
# @option params [Integer] :limit
|
1355
|
+
# Specifies that the number of virtual tape recovery points that are
|
1356
|
+
# described be limited to the specified number.
|
1357
|
+
# @return [Types::DescribeTapeRecoveryPointsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1358
|
+
#
|
1359
|
+
# * {Types::DescribeTapeRecoveryPointsOutput#gateway_arn #GatewayARN} => String
|
1360
|
+
# * {Types::DescribeTapeRecoveryPointsOutput#tape_recovery_point_infos #TapeRecoveryPointInfos} => Array<Types::TapeRecoveryPointInfo>
|
1361
|
+
# * {Types::DescribeTapeRecoveryPointsOutput#marker #Marker} => String
|
1362
|
+
#
|
1363
|
+
# @example Request syntax with placeholder values
|
1364
|
+
# resp = client.describe_tape_recovery_points({
|
1365
|
+
# gateway_arn: "GatewayARN", # required
|
1366
|
+
# marker: "Marker",
|
1367
|
+
# limit: 1,
|
1368
|
+
# })
|
1369
|
+
#
|
1370
|
+
# @example Response structure
|
1371
|
+
# resp.gateway_arn #=> String
|
1372
|
+
# resp.tape_recovery_point_infos #=> Array
|
1373
|
+
# resp.tape_recovery_point_infos[0].tape_arn #=> String
|
1374
|
+
# resp.tape_recovery_point_infos[0].tape_recovery_point_time #=> Time
|
1375
|
+
# resp.tape_recovery_point_infos[0].tape_size_in_bytes #=> Integer
|
1376
|
+
# resp.tape_recovery_point_infos[0].tape_status #=> String
|
1377
|
+
# resp.marker #=> String
|
1378
|
+
# @overload describe_tape_recovery_points(params = {})
|
1379
|
+
# @param [Hash] params ({})
|
1380
|
+
def describe_tape_recovery_points(params = {}, options = {})
|
1381
|
+
req = build_request(:describe_tape_recovery_points, params)
|
1382
|
+
req.send_request(options)
|
1383
|
+
end
|
1384
|
+
|
1385
|
+
# Returns a description of the specified Amazon Resource Name (ARN) of
|
1386
|
+
# virtual tapes. If a `TapeARN` is not specified, returns a description
|
1387
|
+
# of all virtual tapes associated with the specified gateway.
|
1388
|
+
# @option params [required, String] :gateway_arn
|
1389
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1390
|
+
# operation to return a list of gateways for your account and region.
|
1391
|
+
# @option params [Array<String>] :tape_arns
|
1392
|
+
# Specifies one or more unique Amazon Resource Names (ARNs) that
|
1393
|
+
# represent the virtual tapes you want to describe. If this parameter is
|
1394
|
+
# not specified, AWS Storage Gateway returns a description of all
|
1395
|
+
# virtual tapes associated with the specified gateway.
|
1396
|
+
# @option params [String] :marker
|
1397
|
+
# A marker value, obtained in a previous call to `DescribeTapes`. This
|
1398
|
+
# marker indicates which page of results to retrieve.
|
1399
|
+
#
|
1400
|
+
# If not specified, the first page of results is retrieved.
|
1401
|
+
# @option params [Integer] :limit
|
1402
|
+
# Specifies that the number of virtual tapes described be limited to the
|
1403
|
+
# specified number.
|
1404
|
+
#
|
1405
|
+
# <note markdown="1">Amazon Web Services may impose its own limit, if this field is not
|
1406
|
+
# set.
|
1407
|
+
#
|
1408
|
+
# </note>
|
1409
|
+
# @return [Types::DescribeTapesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1410
|
+
#
|
1411
|
+
# * {Types::DescribeTapesOutput#tapes #Tapes} => Array<Types::Tape>
|
1412
|
+
# * {Types::DescribeTapesOutput#marker #Marker} => String
|
1413
|
+
#
|
1414
|
+
# @example Request syntax with placeholder values
|
1415
|
+
# resp = client.describe_tapes({
|
1416
|
+
# gateway_arn: "GatewayARN", # required
|
1417
|
+
# tape_arns: ["TapeARN"],
|
1418
|
+
# marker: "Marker",
|
1419
|
+
# limit: 1,
|
1420
|
+
# })
|
1421
|
+
#
|
1422
|
+
# @example Response structure
|
1423
|
+
# resp.tapes #=> Array
|
1424
|
+
# resp.tapes[0].tape_arn #=> String
|
1425
|
+
# resp.tapes[0].tape_barcode #=> String
|
1426
|
+
# resp.tapes[0].tape_size_in_bytes #=> Integer
|
1427
|
+
# resp.tapes[0].tape_status #=> String
|
1428
|
+
# resp.tapes[0].vtl_device #=> String
|
1429
|
+
# resp.tapes[0].progress #=> Float
|
1430
|
+
# resp.marker #=> String
|
1431
|
+
# @overload describe_tapes(params = {})
|
1432
|
+
# @param [Hash] params ({})
|
1433
|
+
def describe_tapes(params = {}, options = {})
|
1434
|
+
req = build_request(:describe_tapes, params)
|
1435
|
+
req.send_request(options)
|
1436
|
+
end
|
1437
|
+
|
1438
|
+
# Returns information about the upload buffer of a gateway. This
|
1439
|
+
# operation is supported for both the gateway-stored and gateway-cached
|
1440
|
+
# volume architectures.
|
1441
|
+
#
|
1442
|
+
# The response includes disk IDs that are configured as upload buffer
|
1443
|
+
# space, and it includes the amount of upload buffer space allocated and
|
1444
|
+
# used.
|
1445
|
+
# @option params [required, String] :gateway_arn
|
1446
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1447
|
+
# operation to return a list of gateways for your account and region.
|
1448
|
+
# @return [Types::DescribeUploadBufferOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1449
|
+
#
|
1450
|
+
# * {Types::DescribeUploadBufferOutput#gateway_arn #GatewayARN} => String
|
1451
|
+
# * {Types::DescribeUploadBufferOutput#disk_ids #DiskIds} => Array<String>
|
1452
|
+
# * {Types::DescribeUploadBufferOutput#upload_buffer_used_in_bytes #UploadBufferUsedInBytes} => Integer
|
1453
|
+
# * {Types::DescribeUploadBufferOutput#upload_buffer_allocated_in_bytes #UploadBufferAllocatedInBytes} => Integer
|
1454
|
+
#
|
1455
|
+
# @example Request syntax with placeholder values
|
1456
|
+
# resp = client.describe_upload_buffer({
|
1457
|
+
# gateway_arn: "GatewayARN", # required
|
1458
|
+
# })
|
1459
|
+
#
|
1460
|
+
# @example Response structure
|
1461
|
+
# resp.gateway_arn #=> String
|
1462
|
+
# resp.disk_ids #=> Array
|
1463
|
+
# resp.disk_ids[0] #=> String
|
1464
|
+
# resp.upload_buffer_used_in_bytes #=> Integer
|
1465
|
+
# resp.upload_buffer_allocated_in_bytes #=> Integer
|
1466
|
+
# @overload describe_upload_buffer(params = {})
|
1467
|
+
# @param [Hash] params ({})
|
1468
|
+
def describe_upload_buffer(params = {}, options = {})
|
1469
|
+
req = build_request(:describe_upload_buffer, params)
|
1470
|
+
req.send_request(options)
|
1471
|
+
end
|
1472
|
+
|
1473
|
+
# Returns a description of virtual tape library (VTL) devices for the
|
1474
|
+
# specified gateway. In the response, AWS Storage Gateway returns VTL
|
1475
|
+
# device information.
|
1476
|
+
#
|
1477
|
+
# The list of VTL devices must be from one gateway.
|
1478
|
+
# @option params [required, String] :gateway_arn
|
1479
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1480
|
+
# operation to return a list of gateways for your account and region.
|
1481
|
+
# @option params [Array<String>] :vtl_device_arns
|
1482
|
+
# An array of strings, where each string represents the Amazon Resource
|
1483
|
+
# Name (ARN) of a VTL device.
|
1484
|
+
#
|
1485
|
+
# <note markdown="1">All of the specified VTL devices must be from the same gateway. If no
|
1486
|
+
# VTL devices are specified, the result will contain all devices on the
|
1487
|
+
# specified gateway.
|
1488
|
+
#
|
1489
|
+
# </note>
|
1490
|
+
# @option params [String] :marker
|
1491
|
+
# An opaque string that indicates the position at which to begin
|
1492
|
+
# describing the VTL devices.
|
1493
|
+
# @option params [Integer] :limit
|
1494
|
+
# Specifies that the number of VTL devices described be limited to the
|
1495
|
+
# specified number.
|
1496
|
+
# @return [Types::DescribeVTLDevicesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1497
|
+
#
|
1498
|
+
# * {Types::DescribeVTLDevicesOutput#gateway_arn #GatewayARN} => String
|
1499
|
+
# * {Types::DescribeVTLDevicesOutput#vtl_devices #VTLDevices} => Array<Types::VTLDevice>
|
1500
|
+
# * {Types::DescribeVTLDevicesOutput#marker #Marker} => String
|
1501
|
+
#
|
1502
|
+
# @example Request syntax with placeholder values
|
1503
|
+
# resp = client.describe_vtl_devices({
|
1504
|
+
# gateway_arn: "GatewayARN", # required
|
1505
|
+
# vtl_device_arns: ["VTLDeviceARN"],
|
1506
|
+
# marker: "Marker",
|
1507
|
+
# limit: 1,
|
1508
|
+
# })
|
1509
|
+
#
|
1510
|
+
# @example Response structure
|
1511
|
+
# resp.gateway_arn #=> String
|
1512
|
+
# resp.vtl_devices #=> Array
|
1513
|
+
# resp.vtl_devices[0].vtl_device_arn #=> String
|
1514
|
+
# resp.vtl_devices[0].vtl_device_type #=> String
|
1515
|
+
# resp.vtl_devices[0].vtl_device_vendor #=> String
|
1516
|
+
# resp.vtl_devices[0].vtl_device_product_identifier #=> String
|
1517
|
+
# resp.vtl_devices[0].device_iscsi_attributes.target_arn #=> String
|
1518
|
+
# resp.vtl_devices[0].device_iscsi_attributes.network_interface_id #=> String
|
1519
|
+
# resp.vtl_devices[0].device_iscsi_attributes.network_interface_port #=> Integer
|
1520
|
+
# resp.vtl_devices[0].device_iscsi_attributes.chap_enabled #=> Boolean
|
1521
|
+
# resp.marker #=> String
|
1522
|
+
# @overload describe_vtl_devices(params = {})
|
1523
|
+
# @param [Hash] params ({})
|
1524
|
+
def describe_vtl_devices(params = {}, options = {})
|
1525
|
+
req = build_request(:describe_vtl_devices, params)
|
1526
|
+
req.send_request(options)
|
1527
|
+
end
|
1528
|
+
|
1529
|
+
# Returns information about the working storage of a gateway. This
|
1530
|
+
# operation is supported only for the gateway-stored volume
|
1531
|
+
# architecture. This operation is deprecated in cached-volumes API
|
1532
|
+
# version (20120630). Use DescribeUploadBuffer instead.
|
1533
|
+
#
|
1534
|
+
# <note markdown="1"> Working storage is also referred to as upload buffer. You can also use
|
1535
|
+
# the DescribeUploadBuffer operation to add upload buffer to a
|
1536
|
+
# stored-volume gateway.
|
1537
|
+
#
|
1538
|
+
# </note>
|
1539
|
+
#
|
1540
|
+
# The response includes disk IDs that are configured as working storage,
|
1541
|
+
# and it includes the amount of working storage allocated and used.
|
1542
|
+
# @option params [required, String] :gateway_arn
|
1543
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1544
|
+
# operation to return a list of gateways for your account and region.
|
1545
|
+
# @return [Types::DescribeWorkingStorageOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1546
|
+
#
|
1547
|
+
# * {Types::DescribeWorkingStorageOutput#gateway_arn #GatewayARN} => String
|
1548
|
+
# * {Types::DescribeWorkingStorageOutput#disk_ids #DiskIds} => Array<String>
|
1549
|
+
# * {Types::DescribeWorkingStorageOutput#working_storage_used_in_bytes #WorkingStorageUsedInBytes} => Integer
|
1550
|
+
# * {Types::DescribeWorkingStorageOutput#working_storage_allocated_in_bytes #WorkingStorageAllocatedInBytes} => Integer
|
1551
|
+
#
|
1552
|
+
# @example Request syntax with placeholder values
|
1553
|
+
# resp = client.describe_working_storage({
|
1554
|
+
# gateway_arn: "GatewayARN", # required
|
1555
|
+
# })
|
1556
|
+
#
|
1557
|
+
# @example Response structure
|
1558
|
+
# resp.gateway_arn #=> String
|
1559
|
+
# resp.disk_ids #=> Array
|
1560
|
+
# resp.disk_ids[0] #=> String
|
1561
|
+
# resp.working_storage_used_in_bytes #=> Integer
|
1562
|
+
# resp.working_storage_allocated_in_bytes #=> Integer
|
1563
|
+
# @overload describe_working_storage(params = {})
|
1564
|
+
# @param [Hash] params ({})
|
1565
|
+
def describe_working_storage(params = {}, options = {})
|
1566
|
+
req = build_request(:describe_working_storage, params)
|
1567
|
+
req.send_request(options)
|
1568
|
+
end
|
1569
|
+
|
1570
|
+
# Disables a gateway when the gateway is no longer functioning. For
|
1571
|
+
# example, if your gateway VM is damaged, you can disable the gateway so
|
1572
|
+
# you can recover virtual tapes.
|
1573
|
+
#
|
1574
|
+
# Use this operation for a gateway-VTL that is not reachable or not
|
1575
|
+
# functioning.
|
1576
|
+
#
|
1577
|
+
# Once a gateway is disabled it cannot be enabled.
|
1578
|
+
# @option params [required, String] :gateway_arn
|
1579
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1580
|
+
# operation to return a list of gateways for your account and region.
|
1581
|
+
# @return [Types::DisableGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1582
|
+
#
|
1583
|
+
# * {Types::DisableGatewayOutput#gateway_arn #GatewayARN} => String
|
1584
|
+
#
|
1585
|
+
# @example Request syntax with placeholder values
|
1586
|
+
# resp = client.disable_gateway({
|
1587
|
+
# gateway_arn: "GatewayARN", # required
|
1588
|
+
# })
|
1589
|
+
#
|
1590
|
+
# @example Response structure
|
1591
|
+
# resp.gateway_arn #=> String
|
1592
|
+
# @overload disable_gateway(params = {})
|
1593
|
+
# @param [Hash] params ({})
|
1594
|
+
def disable_gateway(params = {}, options = {})
|
1595
|
+
req = build_request(:disable_gateway, params)
|
1596
|
+
req.send_request(options)
|
1597
|
+
end
|
1598
|
+
|
1599
|
+
# Lists gateways owned by an AWS account in a region specified in the
|
1600
|
+
# request. The returned list is ordered by gateway Amazon Resource Name
|
1601
|
+
# (ARN).
|
1602
|
+
#
|
1603
|
+
# By default, the operation returns a maximum of 100 gateways. This
|
1604
|
+
# operation supports pagination that allows you to optionally reduce the
|
1605
|
+
# number of gateways returned in a response.
|
1606
|
+
#
|
1607
|
+
# If you have more gateways than are returned in a response (that is,
|
1608
|
+
# the response returns only a truncated list of your gateways), the
|
1609
|
+
# response contains a marker that you can specify in your next request
|
1610
|
+
# to fetch the next page of gateways.
|
1611
|
+
# @option params [String] :marker
|
1612
|
+
# An opaque string that indicates the position at which to begin the
|
1613
|
+
# returned list of gateways.
|
1614
|
+
# @option params [Integer] :limit
|
1615
|
+
# Specifies that the list of gateways returned be limited to the
|
1616
|
+
# specified number of items.
|
1617
|
+
# @return [Types::ListGatewaysOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1618
|
+
#
|
1619
|
+
# * {Types::ListGatewaysOutput#gateways #Gateways} => Array<Types::GatewayInfo>
|
1620
|
+
# * {Types::ListGatewaysOutput#marker #Marker} => String
|
1621
|
+
#
|
1622
|
+
# @example Request syntax with placeholder values
|
1623
|
+
# resp = client.list_gateways({
|
1624
|
+
# marker: "Marker",
|
1625
|
+
# limit: 1,
|
1626
|
+
# })
|
1627
|
+
#
|
1628
|
+
# @example Response structure
|
1629
|
+
# resp.gateways #=> Array
|
1630
|
+
# resp.gateways[0].gateway_id #=> String
|
1631
|
+
# resp.gateways[0].gateway_arn #=> String
|
1632
|
+
# resp.gateways[0].gateway_type #=> String
|
1633
|
+
# resp.gateways[0].gateway_operational_state #=> String
|
1634
|
+
# resp.gateways[0].gateway_name #=> String
|
1635
|
+
# resp.marker #=> String
|
1636
|
+
# @overload list_gateways(params = {})
|
1637
|
+
# @param [Hash] params ({})
|
1638
|
+
def list_gateways(params = {}, options = {})
|
1639
|
+
req = build_request(:list_gateways, params)
|
1640
|
+
req.send_request(options)
|
1641
|
+
end
|
1642
|
+
|
1643
|
+
# Returns a list of the gateway's local disks. To specify which gateway
|
1644
|
+
# to describe, you use the Amazon Resource Name (ARN) of the gateway in
|
1645
|
+
# the body of the request.
|
1646
|
+
#
|
1647
|
+
# The request returns a list of all disks, specifying which are
|
1648
|
+
# configured as working storage, cache storage, or stored volume or not
|
1649
|
+
# configured at all. The response includes a `DiskStatus` field. This
|
1650
|
+
# field can have a value of present (the disk is available to use),
|
1651
|
+
# missing (the disk is no longer connected to the gateway), or mismatch
|
1652
|
+
# (the disk node is occupied by a disk that has incorrect metadata or
|
1653
|
+
# the disk content is corrupted).
|
1654
|
+
# @option params [required, String] :gateway_arn
|
1655
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1656
|
+
# operation to return a list of gateways for your account and region.
|
1657
|
+
# @return [Types::ListLocalDisksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1658
|
+
#
|
1659
|
+
# * {Types::ListLocalDisksOutput#gateway_arn #GatewayARN} => String
|
1660
|
+
# * {Types::ListLocalDisksOutput#disks #Disks} => Array<Types::Disk>
|
1661
|
+
#
|
1662
|
+
# @example Request syntax with placeholder values
|
1663
|
+
# resp = client.list_local_disks({
|
1664
|
+
# gateway_arn: "GatewayARN", # required
|
1665
|
+
# })
|
1666
|
+
#
|
1667
|
+
# @example Response structure
|
1668
|
+
# resp.gateway_arn #=> String
|
1669
|
+
# resp.disks #=> Array
|
1670
|
+
# resp.disks[0].disk_id #=> String
|
1671
|
+
# resp.disks[0].disk_path #=> String
|
1672
|
+
# resp.disks[0].disk_node #=> String
|
1673
|
+
# resp.disks[0].disk_status #=> String
|
1674
|
+
# resp.disks[0].disk_size_in_bytes #=> Integer
|
1675
|
+
# resp.disks[0].disk_allocation_type #=> String
|
1676
|
+
# resp.disks[0].disk_allocation_resource #=> String
|
1677
|
+
# @overload list_local_disks(params = {})
|
1678
|
+
# @param [Hash] params ({})
|
1679
|
+
def list_local_disks(params = {}, options = {})
|
1680
|
+
req = build_request(:list_local_disks, params)
|
1681
|
+
req.send_request(options)
|
1682
|
+
end
|
1683
|
+
|
1684
|
+
# Lists the tags that have been added to the specified resource.
|
1685
|
+
# @option params [required, String] :resource_arn
|
1686
|
+
# The Amazon Resource Name (ARN) of the resource for which you want to
|
1687
|
+
# list tags.
|
1688
|
+
# @option params [String] :marker
|
1689
|
+
# An opaque string that indicates the position at which to begin
|
1690
|
+
# returning the list of tags.
|
1691
|
+
# @option params [Integer] :limit
|
1692
|
+
# Specifies that the list of tags returned be limited to the specified
|
1693
|
+
# number of items.
|
1694
|
+
# @return [Types::ListTagsForResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1695
|
+
#
|
1696
|
+
# * {Types::ListTagsForResourceOutput#resource_arn #ResourceARN} => String
|
1697
|
+
# * {Types::ListTagsForResourceOutput#marker #Marker} => String
|
1698
|
+
# * {Types::ListTagsForResourceOutput#tags #Tags} => Array<Types::Tag>
|
1699
|
+
#
|
1700
|
+
# @example Request syntax with placeholder values
|
1701
|
+
# resp = client.list_tags_for_resource({
|
1702
|
+
# resource_arn: "ResourceARN", # required
|
1703
|
+
# marker: "Marker",
|
1704
|
+
# limit: 1,
|
1705
|
+
# })
|
1706
|
+
#
|
1707
|
+
# @example Response structure
|
1708
|
+
# resp.resource_arn #=> String
|
1709
|
+
# resp.marker #=> String
|
1710
|
+
# resp.tags #=> Array
|
1711
|
+
# resp.tags[0].key #=> String
|
1712
|
+
# resp.tags[0].value #=> String
|
1713
|
+
# @overload list_tags_for_resource(params = {})
|
1714
|
+
# @param [Hash] params ({})
|
1715
|
+
def list_tags_for_resource(params = {}, options = {})
|
1716
|
+
req = build_request(:list_tags_for_resource, params)
|
1717
|
+
req.send_request(options)
|
1718
|
+
end
|
1719
|
+
|
1720
|
+
# Lists virtual tapes in your virtual tape library (VTL) and your
|
1721
|
+
# virtual tape shelf (VTS). You specify the tapes to list by specifying
|
1722
|
+
# one or more tape Amazon Resource Names (ARNs). If you don't specify a
|
1723
|
+
# tape ARN, the operation lists all virtual tapes in both your VTL and
|
1724
|
+
# VTS.
|
1725
|
+
#
|
1726
|
+
# This operation supports pagination. By default, the operation returns
|
1727
|
+
# a maximum of up to 100 tapes. You can optionally specify the `Limit`
|
1728
|
+
# parameter in the body to limit the number of tapes in the response. If
|
1729
|
+
# the number of tapes returned in the response is truncated, the
|
1730
|
+
# response includes a `Marker` element that you can use in your
|
1731
|
+
# subsequent request to retrieve the next set of tapes.
|
1732
|
+
# @option params [Array<String>] :tape_arns
|
1733
|
+
# The Amazon Resource Name (ARN) of each of the tapes you want to list.
|
1734
|
+
# If you don't specify a tape ARN, the response lists all tapes in both
|
1735
|
+
# your VTL and VTS.
|
1736
|
+
# @option params [String] :marker
|
1737
|
+
# A string that indicates the position at which to begin the returned
|
1738
|
+
# list of tapes.
|
1739
|
+
# @option params [Integer] :limit
|
1740
|
+
# An optional number limit for the tapes in the list returned by this
|
1741
|
+
# call.
|
1742
|
+
# @return [Types::ListTapesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1743
|
+
#
|
1744
|
+
# * {Types::ListTapesOutput#tape_infos #TapeInfos} => Array<Types::TapeInfo>
|
1745
|
+
# * {Types::ListTapesOutput#marker #Marker} => String
|
1746
|
+
#
|
1747
|
+
# @example Request syntax with placeholder values
|
1748
|
+
# resp = client.list_tapes({
|
1749
|
+
# tape_arns: ["TapeARN"],
|
1750
|
+
# marker: "Marker",
|
1751
|
+
# limit: 1,
|
1752
|
+
# })
|
1753
|
+
#
|
1754
|
+
# @example Response structure
|
1755
|
+
# resp.tape_infos #=> Array
|
1756
|
+
# resp.tape_infos[0].tape_arn #=> String
|
1757
|
+
# resp.tape_infos[0].tape_barcode #=> String
|
1758
|
+
# resp.tape_infos[0].tape_size_in_bytes #=> Integer
|
1759
|
+
# resp.tape_infos[0].tape_status #=> String
|
1760
|
+
# resp.tape_infos[0].gateway_arn #=> String
|
1761
|
+
# resp.marker #=> String
|
1762
|
+
# @overload list_tapes(params = {})
|
1763
|
+
# @param [Hash] params ({})
|
1764
|
+
def list_tapes(params = {}, options = {})
|
1765
|
+
req = build_request(:list_tapes, params)
|
1766
|
+
req.send_request(options)
|
1767
|
+
end
|
1768
|
+
|
1769
|
+
# Lists iSCSI initiators that are connected to a volume. You can use
|
1770
|
+
# this operation to determine whether a volume is being used or not.
|
1771
|
+
# @option params [required, String] :volume_arn
|
1772
|
+
# The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
|
1773
|
+
# operation to return a list of gateway volumes for the gateway.
|
1774
|
+
# @return [Types::ListVolumeInitiatorsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1775
|
+
#
|
1776
|
+
# * {Types::ListVolumeInitiatorsOutput#initiators #Initiators} => Array<String>
|
1777
|
+
#
|
1778
|
+
# @example Request syntax with placeholder values
|
1779
|
+
# resp = client.list_volume_initiators({
|
1780
|
+
# volume_arn: "VolumeARN", # required
|
1781
|
+
# })
|
1782
|
+
#
|
1783
|
+
# @example Response structure
|
1784
|
+
# resp.initiators #=> Array
|
1785
|
+
# resp.initiators[0] #=> String
|
1786
|
+
# @overload list_volume_initiators(params = {})
|
1787
|
+
# @param [Hash] params ({})
|
1788
|
+
def list_volume_initiators(params = {}, options = {})
|
1789
|
+
req = build_request(:list_volume_initiators, params)
|
1790
|
+
req.send_request(options)
|
1791
|
+
end
|
1792
|
+
|
1793
|
+
# Lists the recovery points for a specified gateway. This operation is
|
1794
|
+
# supported only for the gateway-cached volume architecture.
|
1795
|
+
#
|
1796
|
+
# Each gateway-cached volume has one recovery point. A volume recovery
|
1797
|
+
# point is a point in time at which all data of the volume is consistent
|
1798
|
+
# and from which you can create a snapshot. To create a snapshot from a
|
1799
|
+
# volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint
|
1800
|
+
# operation.
|
1801
|
+
# @option params [required, String] :gateway_arn
|
1802
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1803
|
+
# operation to return a list of gateways for your account and region.
|
1804
|
+
# @return [Types::ListVolumeRecoveryPointsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1805
|
+
#
|
1806
|
+
# * {Types::ListVolumeRecoveryPointsOutput#gateway_arn #GatewayARN} => String
|
1807
|
+
# * {Types::ListVolumeRecoveryPointsOutput#volume_recovery_point_infos #VolumeRecoveryPointInfos} => Array<Types::VolumeRecoveryPointInfo>
|
1808
|
+
#
|
1809
|
+
# @example Request syntax with placeholder values
|
1810
|
+
# resp = client.list_volume_recovery_points({
|
1811
|
+
# gateway_arn: "GatewayARN", # required
|
1812
|
+
# })
|
1813
|
+
#
|
1814
|
+
# @example Response structure
|
1815
|
+
# resp.gateway_arn #=> String
|
1816
|
+
# resp.volume_recovery_point_infos #=> Array
|
1817
|
+
# resp.volume_recovery_point_infos[0].volume_arn #=> String
|
1818
|
+
# resp.volume_recovery_point_infos[0].volume_size_in_bytes #=> Integer
|
1819
|
+
# resp.volume_recovery_point_infos[0].volume_usage_in_bytes #=> Integer
|
1820
|
+
# resp.volume_recovery_point_infos[0].volume_recovery_point_time #=> String
|
1821
|
+
# @overload list_volume_recovery_points(params = {})
|
1822
|
+
# @param [Hash] params ({})
|
1823
|
+
def list_volume_recovery_points(params = {}, options = {})
|
1824
|
+
req = build_request(:list_volume_recovery_points, params)
|
1825
|
+
req.send_request(options)
|
1826
|
+
end
|
1827
|
+
|
1828
|
+
# Lists the iSCSI stored volumes of a gateway. Results are sorted by
|
1829
|
+
# volume ARN. The response includes only the volume ARNs. If you want
|
1830
|
+
# additional volume information, use the DescribeStorediSCSIVolumes API.
|
1831
|
+
#
|
1832
|
+
# The operation supports pagination. By default, the operation returns a
|
1833
|
+
# maximum of up to 100 volumes. You can optionally specify the `Limit`
|
1834
|
+
# field in the body to limit the number of volumes in the response. If
|
1835
|
+
# the number of volumes returned in the response is truncated, the
|
1836
|
+
# response includes a Marker field. You can use this Marker value in
|
1837
|
+
# your subsequent request to retrieve the next set of volumes.
|
1838
|
+
# @option params [String] :gateway_arn
|
1839
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1840
|
+
# operation to return a list of gateways for your account and region.
|
1841
|
+
# @option params [String] :marker
|
1842
|
+
# A string that indicates the position at which to begin the returned
|
1843
|
+
# list of volumes. Obtain the marker from the response of a previous
|
1844
|
+
# List iSCSI Volumes request.
|
1845
|
+
# @option params [Integer] :limit
|
1846
|
+
# Specifies that the list of volumes returned be limited to the
|
1847
|
+
# specified number of items.
|
1848
|
+
# @return [Types::ListVolumesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1849
|
+
#
|
1850
|
+
# * {Types::ListVolumesOutput#gateway_arn #GatewayARN} => String
|
1851
|
+
# * {Types::ListVolumesOutput#marker #Marker} => String
|
1852
|
+
# * {Types::ListVolumesOutput#volume_infos #VolumeInfos} => Array<Types::VolumeInfo>
|
1853
|
+
#
|
1854
|
+
# @example Request syntax with placeholder values
|
1855
|
+
# resp = client.list_volumes({
|
1856
|
+
# gateway_arn: "GatewayARN",
|
1857
|
+
# marker: "Marker",
|
1858
|
+
# limit: 1,
|
1859
|
+
# })
|
1860
|
+
#
|
1861
|
+
# @example Response structure
|
1862
|
+
# resp.gateway_arn #=> String
|
1863
|
+
# resp.marker #=> String
|
1864
|
+
# resp.volume_infos #=> Array
|
1865
|
+
# resp.volume_infos[0].volume_arn #=> String
|
1866
|
+
# resp.volume_infos[0].volume_id #=> String
|
1867
|
+
# resp.volume_infos[0].gateway_arn #=> String
|
1868
|
+
# resp.volume_infos[0].gateway_id #=> String
|
1869
|
+
# resp.volume_infos[0].volume_type #=> String
|
1870
|
+
# resp.volume_infos[0].volume_size_in_bytes #=> Integer
|
1871
|
+
# @overload list_volumes(params = {})
|
1872
|
+
# @param [Hash] params ({})
|
1873
|
+
def list_volumes(params = {}, options = {})
|
1874
|
+
req = build_request(:list_volumes, params)
|
1875
|
+
req.send_request(options)
|
1876
|
+
end
|
1877
|
+
|
1878
|
+
# Removes one or more tags from the specified resource.
|
1879
|
+
# @option params [required, String] :resource_arn
|
1880
|
+
# The Amazon Resource Name (ARN) of the resource you want to remove the
|
1881
|
+
# tags from.
|
1882
|
+
# @option params [required, Array<String>] :tag_keys
|
1883
|
+
# The keys of the tags you want to remove from the specified resource. A
|
1884
|
+
# tag is composed of a key/value pair.
|
1885
|
+
# @return [Types::RemoveTagsFromResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1886
|
+
#
|
1887
|
+
# * {Types::RemoveTagsFromResourceOutput#resource_arn #ResourceARN} => String
|
1888
|
+
#
|
1889
|
+
# @example Request syntax with placeholder values
|
1890
|
+
# resp = client.remove_tags_from_resource({
|
1891
|
+
# resource_arn: "ResourceARN", # required
|
1892
|
+
# tag_keys: ["TagKey"], # required
|
1893
|
+
# })
|
1894
|
+
#
|
1895
|
+
# @example Response structure
|
1896
|
+
# resp.resource_arn #=> String
|
1897
|
+
# @overload remove_tags_from_resource(params = {})
|
1898
|
+
# @param [Hash] params ({})
|
1899
|
+
def remove_tags_from_resource(params = {}, options = {})
|
1900
|
+
req = build_request(:remove_tags_from_resource, params)
|
1901
|
+
req.send_request(options)
|
1902
|
+
end
|
1903
|
+
|
1904
|
+
# Resets all cache disks that have encountered a error and makes the
|
1905
|
+
# disks available for reconfiguration as cache storage. If your cache
|
1906
|
+
# disk encounters a error, the gateway prevents read and write
|
1907
|
+
# operations on virtual tapes in the gateway. For example, an error can
|
1908
|
+
# occur when a disk is corrupted or removed from the gateway. When a
|
1909
|
+
# cache is reset, the gateway loses its cache storage. At this point you
|
1910
|
+
# can reconfigure the disks as cache disks.
|
1911
|
+
#
|
1912
|
+
# If the cache disk you are resetting contains data that has not been
|
1913
|
+
# uploaded to Amazon S3 yet, that data can be lost. After you reset
|
1914
|
+
# cache disks, there will be no configured cache disks left in the
|
1915
|
+
# gateway, so you must configure at least one new cache disk for your
|
1916
|
+
# gateway to function properly.
|
1917
|
+
# @option params [required, String] :gateway_arn
|
1918
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
1919
|
+
# operation to return a list of gateways for your account and region.
|
1920
|
+
# @return [Types::ResetCacheOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1921
|
+
#
|
1922
|
+
# * {Types::ResetCacheOutput#gateway_arn #GatewayARN} => String
|
1923
|
+
#
|
1924
|
+
# @example Request syntax with placeholder values
|
1925
|
+
# resp = client.reset_cache({
|
1926
|
+
# gateway_arn: "GatewayARN", # required
|
1927
|
+
# })
|
1928
|
+
#
|
1929
|
+
# @example Response structure
|
1930
|
+
# resp.gateway_arn #=> String
|
1931
|
+
# @overload reset_cache(params = {})
|
1932
|
+
# @param [Hash] params ({})
|
1933
|
+
def reset_cache(params = {}, options = {})
|
1934
|
+
req = build_request(:reset_cache, params)
|
1935
|
+
req.send_request(options)
|
1936
|
+
end
|
1937
|
+
|
1938
|
+
# Retrieves an archived virtual tape from the virtual tape shelf (VTS)
|
1939
|
+
# to a gateway-VTL. Virtual tapes archived in the VTS are not associated
|
1940
|
+
# with any gateway. However after a tape is retrieved, it is associated
|
1941
|
+
# with a gateway, even though it is also listed in the VTS.
|
1942
|
+
#
|
1943
|
+
# Once a tape is successfully retrieved to a gateway, it cannot be
|
1944
|
+
# retrieved again to another gateway. You must archive the tape again
|
1945
|
+
# before you can retrieve it to another gateway.
|
1946
|
+
# @option params [required, String] :tape_arn
|
1947
|
+
# The Amazon Resource Name (ARN) of the virtual tape you want to
|
1948
|
+
# retrieve from the virtual tape shelf (VTS).
|
1949
|
+
# @option params [required, String] :gateway_arn
|
1950
|
+
# The Amazon Resource Name (ARN) of the gateway you want to retrieve the
|
1951
|
+
# virtual tape to. Use the ListGateways operation to return a list of
|
1952
|
+
# gateways for your account and region.
|
1953
|
+
#
|
1954
|
+
# You retrieve archived virtual tapes to only one gateway and the
|
1955
|
+
# gateway must be a gateway-VTL.
|
1956
|
+
# @return [Types::RetrieveTapeArchiveOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1957
|
+
#
|
1958
|
+
# * {Types::RetrieveTapeArchiveOutput#tape_arn #TapeARN} => String
|
1959
|
+
#
|
1960
|
+
# @example Request syntax with placeholder values
|
1961
|
+
# resp = client.retrieve_tape_archive({
|
1962
|
+
# tape_arn: "TapeARN", # required
|
1963
|
+
# gateway_arn: "GatewayARN", # required
|
1964
|
+
# })
|
1965
|
+
#
|
1966
|
+
# @example Response structure
|
1967
|
+
# resp.tape_arn #=> String
|
1968
|
+
# @overload retrieve_tape_archive(params = {})
|
1969
|
+
# @param [Hash] params ({})
|
1970
|
+
def retrieve_tape_archive(params = {}, options = {})
|
1971
|
+
req = build_request(:retrieve_tape_archive, params)
|
1972
|
+
req.send_request(options)
|
1973
|
+
end
|
1974
|
+
|
1975
|
+
# Retrieves the recovery point for the specified virtual tape.
|
1976
|
+
#
|
1977
|
+
# A recovery point is a point in time view of a virtual tape at which
|
1978
|
+
# all the data on the tape is consistent. If your gateway crashes,
|
1979
|
+
# virtual tapes that have recovery points can be recovered to a new
|
1980
|
+
# gateway.
|
1981
|
+
#
|
1982
|
+
# <note markdown="1">The virtual tape can be retrieved to only one gateway. The retrieved
|
1983
|
+
# tape is read-only. The virtual tape can be retrieved to only a
|
1984
|
+
# gateway-VTL. There is no charge for retrieving recovery points.
|
1985
|
+
#
|
1986
|
+
# </note>
|
1987
|
+
# @option params [required, String] :tape_arn
|
1988
|
+
# The Amazon Resource Name (ARN) of the virtual tape for which you want
|
1989
|
+
# to retrieve the recovery point.
|
1990
|
+
# @option params [required, String] :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 [Types::RetrieveTapeRecoveryPointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1994
|
+
#
|
1995
|
+
# * {Types::RetrieveTapeRecoveryPointOutput#tape_arn #TapeARN} => String
|
1996
|
+
#
|
1997
|
+
# @example Request syntax with placeholder values
|
1998
|
+
# resp = client.retrieve_tape_recovery_point({
|
1999
|
+
# tape_arn: "TapeARN", # required
|
2000
|
+
# gateway_arn: "GatewayARN", # required
|
2001
|
+
# })
|
2002
|
+
#
|
2003
|
+
# @example Response structure
|
2004
|
+
# resp.tape_arn #=> String
|
2005
|
+
# @overload retrieve_tape_recovery_point(params = {})
|
2006
|
+
# @param [Hash] params ({})
|
2007
|
+
def retrieve_tape_recovery_point(params = {}, options = {})
|
2008
|
+
req = build_request(:retrieve_tape_recovery_point, params)
|
2009
|
+
req.send_request(options)
|
2010
|
+
end
|
2011
|
+
|
2012
|
+
# Sets the password for your VM local console. When you log in to the
|
2013
|
+
# local console for the first time, you log in to the VM with the
|
2014
|
+
# default credentials. We recommend that you set a new password. You
|
2015
|
+
# don't need to know the default password to set a new password.
|
2016
|
+
# @option params [required, String] :gateway_arn
|
2017
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2018
|
+
# operation to return a list of gateways for your account and region.
|
2019
|
+
# @option params [required, String] :local_console_password
|
2020
|
+
# The password you want to set for your VM local console.
|
2021
|
+
# @return [Types::SetLocalConsolePasswordOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2022
|
+
#
|
2023
|
+
# * {Types::SetLocalConsolePasswordOutput#gateway_arn #GatewayARN} => String
|
2024
|
+
#
|
2025
|
+
# @example Request syntax with placeholder values
|
2026
|
+
# resp = client.set_local_console_password({
|
2027
|
+
# gateway_arn: "GatewayARN", # required
|
2028
|
+
# local_console_password: "LocalConsolePassword", # required
|
2029
|
+
# })
|
2030
|
+
#
|
2031
|
+
# @example Response structure
|
2032
|
+
# resp.gateway_arn #=> String
|
2033
|
+
# @overload set_local_console_password(params = {})
|
2034
|
+
# @param [Hash] params ({})
|
2035
|
+
def set_local_console_password(params = {}, options = {})
|
2036
|
+
req = build_request(:set_local_console_password, params)
|
2037
|
+
req.send_request(options)
|
2038
|
+
end
|
2039
|
+
|
2040
|
+
# Shuts down a gateway. To specify which gateway to shut down, use the
|
2041
|
+
# Amazon Resource Name (ARN) of the gateway in the body of your request.
|
2042
|
+
#
|
2043
|
+
# The operation shuts down the gateway service component running in the
|
2044
|
+
# storage gateway's virtual machine (VM) and not the VM.
|
2045
|
+
#
|
2046
|
+
# <note markdown="1">If you want to shut down the VM, it is recommended that you first shut
|
2047
|
+
# down the gateway component in the VM to avoid unpredictable
|
2048
|
+
# conditions.
|
2049
|
+
#
|
2050
|
+
# </note>
|
2051
|
+
#
|
2052
|
+
# After the gateway is shutdown, you cannot call any other API except
|
2053
|
+
# StartGateway, DescribeGatewayInformation, and ListGateways. For more
|
2054
|
+
# information, see ActivateGateway. Your applications cannot read from
|
2055
|
+
# or write to the gateway's storage volumes, and there are no snapshots
|
2056
|
+
# taken.
|
2057
|
+
#
|
2058
|
+
# <note markdown="1">When you make a shutdown request, you will get a `200 OK` success
|
2059
|
+
# response immediately. However, it might take some time for the gateway
|
2060
|
+
# to shut down. You can call the DescribeGatewayInformation API to check
|
2061
|
+
# the status. For more information, see ActivateGateway.
|
2062
|
+
#
|
2063
|
+
# </note>
|
2064
|
+
#
|
2065
|
+
# If do not intend to use the gateway again, you must delete the gateway
|
2066
|
+
# (using DeleteGateway) to no longer pay software charges associated
|
2067
|
+
# with the gateway.
|
2068
|
+
# @option params [required, String] :gateway_arn
|
2069
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2070
|
+
# operation to return a list of gateways for your account and region.
|
2071
|
+
# @return [Types::ShutdownGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2072
|
+
#
|
2073
|
+
# * {Types::ShutdownGatewayOutput#gateway_arn #GatewayARN} => String
|
2074
|
+
#
|
2075
|
+
# @example Request syntax with placeholder values
|
2076
|
+
# resp = client.shutdown_gateway({
|
2077
|
+
# gateway_arn: "GatewayARN", # required
|
2078
|
+
# })
|
2079
|
+
#
|
2080
|
+
# @example Response structure
|
2081
|
+
# resp.gateway_arn #=> String
|
2082
|
+
# @overload shutdown_gateway(params = {})
|
2083
|
+
# @param [Hash] params ({})
|
2084
|
+
def shutdown_gateway(params = {}, options = {})
|
2085
|
+
req = build_request(:shutdown_gateway, params)
|
2086
|
+
req.send_request(options)
|
2087
|
+
end
|
2088
|
+
|
2089
|
+
# Starts a gateway that you previously shut down (see ShutdownGateway).
|
2090
|
+
# After the gateway starts, you can then make other API calls, your
|
2091
|
+
# applications can read from or write to the gateway's storage volumes
|
2092
|
+
# and you will be able to take snapshot backups.
|
2093
|
+
#
|
2094
|
+
# <note markdown="1">When you make a request, you will get a 200 OK success response
|
2095
|
+
# immediately. However, it might take some time for the gateway to be
|
2096
|
+
# ready. You should call DescribeGatewayInformation and check the status
|
2097
|
+
# before making any additional API calls. For more information, see
|
2098
|
+
# ActivateGateway.
|
2099
|
+
#
|
2100
|
+
# </note>
|
2101
|
+
#
|
2102
|
+
# To specify which gateway to start, use the Amazon Resource Name (ARN)
|
2103
|
+
# of the gateway in your request.
|
2104
|
+
# @option params [required, String] :gateway_arn
|
2105
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2106
|
+
# operation to return a list of gateways for your account and region.
|
2107
|
+
# @return [Types::StartGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2108
|
+
#
|
2109
|
+
# * {Types::StartGatewayOutput#gateway_arn #GatewayARN} => String
|
2110
|
+
#
|
2111
|
+
# @example Request syntax with placeholder values
|
2112
|
+
# resp = client.start_gateway({
|
2113
|
+
# gateway_arn: "GatewayARN", # required
|
2114
|
+
# })
|
2115
|
+
#
|
2116
|
+
# @example Response structure
|
2117
|
+
# resp.gateway_arn #=> String
|
2118
|
+
# @overload start_gateway(params = {})
|
2119
|
+
# @param [Hash] params ({})
|
2120
|
+
def start_gateway(params = {}, options = {})
|
2121
|
+
req = build_request(:start_gateway, params)
|
2122
|
+
req.send_request(options)
|
2123
|
+
end
|
2124
|
+
|
2125
|
+
# Updates the bandwidth rate limits of a gateway. You can update both
|
2126
|
+
# the upload and download bandwidth rate limit or specify only one of
|
2127
|
+
# the two. If you don't set a bandwidth rate limit, the existing rate
|
2128
|
+
# limit remains.
|
2129
|
+
#
|
2130
|
+
# By default, a gateway's bandwidth rate limits are not set. If you
|
2131
|
+
# don't set any limit, the gateway does not have any limitations on its
|
2132
|
+
# bandwidth usage and could potentially use the maximum available
|
2133
|
+
# bandwidth.
|
2134
|
+
#
|
2135
|
+
# To specify which gateway to update, use the Amazon Resource Name (ARN)
|
2136
|
+
# of the gateway in your request.
|
2137
|
+
# @option params [required, String] :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
|
+
# @option params [Integer] :average_upload_rate_limit_in_bits_per_sec
|
2141
|
+
# The average upload bandwidth rate limit in bits per second.
|
2142
|
+
# @option params [Integer] :average_download_rate_limit_in_bits_per_sec
|
2143
|
+
# The average download bandwidth rate limit in bits per second.
|
2144
|
+
# @return [Types::UpdateBandwidthRateLimitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2145
|
+
#
|
2146
|
+
# * {Types::UpdateBandwidthRateLimitOutput#gateway_arn #GatewayARN} => String
|
2147
|
+
#
|
2148
|
+
# @example Request syntax with placeholder values
|
2149
|
+
# resp = client.update_bandwidth_rate_limit({
|
2150
|
+
# gateway_arn: "GatewayARN", # required
|
2151
|
+
# average_upload_rate_limit_in_bits_per_sec: 1,
|
2152
|
+
# average_download_rate_limit_in_bits_per_sec: 1,
|
2153
|
+
# })
|
2154
|
+
#
|
2155
|
+
# @example Response structure
|
2156
|
+
# resp.gateway_arn #=> String
|
2157
|
+
# @overload update_bandwidth_rate_limit(params = {})
|
2158
|
+
# @param [Hash] params ({})
|
2159
|
+
def update_bandwidth_rate_limit(params = {}, options = {})
|
2160
|
+
req = build_request(:update_bandwidth_rate_limit, params)
|
2161
|
+
req.send_request(options)
|
2162
|
+
end
|
2163
|
+
|
2164
|
+
# Updates the Challenge-Handshake Authentication Protocol (CHAP)
|
2165
|
+
# credentials for a specified iSCSI target. By default, a gateway does
|
2166
|
+
# not have CHAP enabled; however, for added security, you might use it.
|
2167
|
+
#
|
2168
|
+
# When you update CHAP credentials, all existing connections on the
|
2169
|
+
# target are closed and initiators must reconnect with the new
|
2170
|
+
# credentials.
|
2171
|
+
# @option params [required, String] :target_arn
|
2172
|
+
# The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
|
2173
|
+
# DescribeStorediSCSIVolumes operation to return the TargetARN for
|
2174
|
+
# specified VolumeARN.
|
2175
|
+
# @option params [required, String] :secret_to_authenticate_initiator
|
2176
|
+
# The secret key that the initiator (for example, the Windows client)
|
2177
|
+
# must provide to participate in mutual CHAP with the target.
|
2178
|
+
#
|
2179
|
+
# <note markdown="1">The secret key must be between 12 and 16 bytes when encoded in UTF-8.
|
2180
|
+
#
|
2181
|
+
# </note>
|
2182
|
+
# @option params [required, String] :initiator_name
|
2183
|
+
# The iSCSI initiator that connects to the target.
|
2184
|
+
# @option params [String] :secret_to_authenticate_target
|
2185
|
+
# The secret key that the target must provide to participate in mutual
|
2186
|
+
# CHAP with the initiator (e.g. Windows client).
|
2187
|
+
#
|
2188
|
+
# Byte constraints: Minimum bytes of 12. Maximum bytes of 16.
|
2189
|
+
#
|
2190
|
+
# <note markdown="1">The secret key must be between 12 and 16 bytes when encoded in UTF-8.
|
2191
|
+
#
|
2192
|
+
# </note>
|
2193
|
+
# @return [Types::UpdateChapCredentialsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2194
|
+
#
|
2195
|
+
# * {Types::UpdateChapCredentialsOutput#target_arn #TargetARN} => String
|
2196
|
+
# * {Types::UpdateChapCredentialsOutput#initiator_name #InitiatorName} => String
|
2197
|
+
#
|
2198
|
+
# @example Request syntax with placeholder values
|
2199
|
+
# resp = client.update_chap_credentials({
|
2200
|
+
# target_arn: "TargetARN", # required
|
2201
|
+
# secret_to_authenticate_initiator: "ChapSecret", # required
|
2202
|
+
# initiator_name: "IqnName", # required
|
2203
|
+
# secret_to_authenticate_target: "ChapSecret",
|
2204
|
+
# })
|
2205
|
+
#
|
2206
|
+
# @example Response structure
|
2207
|
+
# resp.target_arn #=> String
|
2208
|
+
# resp.initiator_name #=> String
|
2209
|
+
# @overload update_chap_credentials(params = {})
|
2210
|
+
# @param [Hash] params ({})
|
2211
|
+
def update_chap_credentials(params = {}, options = {})
|
2212
|
+
req = build_request(:update_chap_credentials, params)
|
2213
|
+
req.send_request(options)
|
2214
|
+
end
|
2215
|
+
|
2216
|
+
# Updates a gateway's metadata, which includes the gateway's name and
|
2217
|
+
# time zone. To specify which gateway to update, use the Amazon Resource
|
2218
|
+
# Name (ARN) of the gateway in your request.
|
2219
|
+
#
|
2220
|
+
# <note markdown="1">For Gateways activated after September 2, 2015, the gateway's ARN
|
2221
|
+
# contains the gateway ID rather than the gateway name. However,
|
2222
|
+
# changing the name of the gateway has no effect on the gateway's ARN.
|
2223
|
+
#
|
2224
|
+
# </note>
|
2225
|
+
# @option params [required, String] :gateway_arn
|
2226
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2227
|
+
# operation to return a list of gateways for your account and region.
|
2228
|
+
# @option params [String] :gateway_name
|
2229
|
+
# The name you configured for your gateway.
|
2230
|
+
# @option params [String] :gateway_timezone
|
2231
|
+
# @return [Types::UpdateGatewayInformationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2232
|
+
#
|
2233
|
+
# * {Types::UpdateGatewayInformationOutput#gateway_arn #GatewayARN} => String
|
2234
|
+
# * {Types::UpdateGatewayInformationOutput#gateway_name #GatewayName} => String
|
2235
|
+
#
|
2236
|
+
# @example Request syntax with placeholder values
|
2237
|
+
# resp = client.update_gateway_information({
|
2238
|
+
# gateway_arn: "GatewayARN", # required
|
2239
|
+
# gateway_name: "GatewayName",
|
2240
|
+
# gateway_timezone: "GatewayTimezone",
|
2241
|
+
# })
|
2242
|
+
#
|
2243
|
+
# @example Response structure
|
2244
|
+
# resp.gateway_arn #=> String
|
2245
|
+
# resp.gateway_name #=> String
|
2246
|
+
# @overload update_gateway_information(params = {})
|
2247
|
+
# @param [Hash] params ({})
|
2248
|
+
def update_gateway_information(params = {}, options = {})
|
2249
|
+
req = build_request(:update_gateway_information, params)
|
2250
|
+
req.send_request(options)
|
2251
|
+
end
|
2252
|
+
|
2253
|
+
# Updates the gateway virtual machine (VM) software. The request
|
2254
|
+
# immediately triggers the software update.
|
2255
|
+
#
|
2256
|
+
# <note markdown="1">When you make this request, you get a `200 OK` success response
|
2257
|
+
# immediately. However, it might take some time for the update to
|
2258
|
+
# complete. You can call DescribeGatewayInformation to verify the
|
2259
|
+
# gateway is in the `STATE_RUNNING` state.
|
2260
|
+
#
|
2261
|
+
# </note>
|
2262
|
+
#
|
2263
|
+
# A software update forces a system restart of your gateway. You can
|
2264
|
+
# minimize the chance of any disruption to your applications by
|
2265
|
+
# increasing your iSCSI Initiators' timeouts. For more information
|
2266
|
+
# about increasing iSCSI Initiator timeouts for Windows and Linux, see
|
2267
|
+
# [Customizing Your Windows iSCSI Settings][1] and [Customizing Your
|
2268
|
+
# Linux iSCSI Settings][2], respectively.
|
2269
|
+
#
|
2270
|
+
#
|
2271
|
+
#
|
2272
|
+
# [1]: http://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings
|
2273
|
+
# [2]: http://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings
|
2274
|
+
# @option params [required, String] :gateway_arn
|
2275
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2276
|
+
# operation to return a list of gateways for your account and region.
|
2277
|
+
# @return [Types::UpdateGatewaySoftwareNowOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2278
|
+
#
|
2279
|
+
# * {Types::UpdateGatewaySoftwareNowOutput#gateway_arn #GatewayARN} => String
|
2280
|
+
#
|
2281
|
+
# @example Request syntax with placeholder values
|
2282
|
+
# resp = client.update_gateway_software_now({
|
2283
|
+
# gateway_arn: "GatewayARN", # required
|
2284
|
+
# })
|
2285
|
+
#
|
2286
|
+
# @example Response structure
|
2287
|
+
# resp.gateway_arn #=> String
|
2288
|
+
# @overload update_gateway_software_now(params = {})
|
2289
|
+
# @param [Hash] params ({})
|
2290
|
+
def update_gateway_software_now(params = {}, options = {})
|
2291
|
+
req = build_request(:update_gateway_software_now, params)
|
2292
|
+
req.send_request(options)
|
2293
|
+
end
|
2294
|
+
|
2295
|
+
# Updates a gateway's weekly maintenance start time information,
|
2296
|
+
# including day and time of the week. The maintenance time is the time
|
2297
|
+
# in your gateway's time zone.
|
2298
|
+
# @option params [required, String] :gateway_arn
|
2299
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
|
2300
|
+
# operation to return a list of gateways for your account and region.
|
2301
|
+
# @option params [required, Integer] :hour_of_day
|
2302
|
+
# The hour component of the maintenance start time represented as *hh*,
|
2303
|
+
# where *hh* is the hour (00 to 23). The hour of the day is in the time
|
2304
|
+
# zone of the gateway.
|
2305
|
+
# @option params [required, Integer] :minute_of_hour
|
2306
|
+
# The minute component of the maintenance start time represented as
|
2307
|
+
# *mm*, where *mm* is the minute (00 to 59). The minute of the hour is
|
2308
|
+
# in the time zone of the gateway.
|
2309
|
+
# @option params [required, Integer] :day_of_week
|
2310
|
+
# The maintenance start time day of the week.
|
2311
|
+
# @return [Types::UpdateMaintenanceStartTimeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2312
|
+
#
|
2313
|
+
# * {Types::UpdateMaintenanceStartTimeOutput#gateway_arn #GatewayARN} => String
|
2314
|
+
#
|
2315
|
+
# @example Request syntax with placeholder values
|
2316
|
+
# resp = client.update_maintenance_start_time({
|
2317
|
+
# gateway_arn: "GatewayARN", # required
|
2318
|
+
# hour_of_day: 1, # required
|
2319
|
+
# minute_of_hour: 1, # required
|
2320
|
+
# day_of_week: 1, # required
|
2321
|
+
# })
|
2322
|
+
#
|
2323
|
+
# @example Response structure
|
2324
|
+
# resp.gateway_arn #=> String
|
2325
|
+
# @overload update_maintenance_start_time(params = {})
|
2326
|
+
# @param [Hash] params ({})
|
2327
|
+
def update_maintenance_start_time(params = {}, options = {})
|
2328
|
+
req = build_request(:update_maintenance_start_time, params)
|
2329
|
+
req.send_request(options)
|
2330
|
+
end
|
2331
|
+
|
2332
|
+
# Updates a snapshot schedule configured for a gateway volume.
|
2333
|
+
#
|
2334
|
+
# The default snapshot schedule for volume is once every 24 hours,
|
2335
|
+
# starting at the creation time of the volume. You can use this API to
|
2336
|
+
# change the snapshot schedule configured for the volume.
|
2337
|
+
#
|
2338
|
+
# In the request you must identify the gateway volume whose snapshot
|
2339
|
+
# schedule you want to update, and the schedule information, including
|
2340
|
+
# when you want the snapshot to begin on a day and the frequency (in
|
2341
|
+
# hours) of snapshots.
|
2342
|
+
# @option params [required, String] :volume_arn
|
2343
|
+
# The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
|
2344
|
+
# operation to return a list of gateway volumes.
|
2345
|
+
# @option params [required, Integer] :start_at
|
2346
|
+
# The hour of the day at which the snapshot schedule begins represented
|
2347
|
+
# as *hh*, where *hh* is the hour (0 to 23). The hour of the day is in
|
2348
|
+
# the time zone of the gateway.
|
2349
|
+
# @option params [required, Integer] :recurrence_in_hours
|
2350
|
+
# Frequency of snapshots. Specify the number of hours between snapshots.
|
2351
|
+
# @option params [String] :description
|
2352
|
+
# Optional description of the snapshot that overwrites the existing
|
2353
|
+
# description.
|
2354
|
+
# @return [Types::UpdateSnapshotScheduleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2355
|
+
#
|
2356
|
+
# * {Types::UpdateSnapshotScheduleOutput#volume_arn #VolumeARN} => String
|
2357
|
+
#
|
2358
|
+
# @example Request syntax with placeholder values
|
2359
|
+
# resp = client.update_snapshot_schedule({
|
2360
|
+
# volume_arn: "VolumeARN", # required
|
2361
|
+
# start_at: 1, # required
|
2362
|
+
# recurrence_in_hours: 1, # required
|
2363
|
+
# description: "Description",
|
2364
|
+
# })
|
2365
|
+
#
|
2366
|
+
# @example Response structure
|
2367
|
+
# resp.volume_arn #=> String
|
2368
|
+
# @overload update_snapshot_schedule(params = {})
|
2369
|
+
# @param [Hash] params ({})
|
2370
|
+
def update_snapshot_schedule(params = {}, options = {})
|
2371
|
+
req = build_request(:update_snapshot_schedule, params)
|
2372
|
+
req.send_request(options)
|
2373
|
+
end
|
2374
|
+
|
2375
|
+
# Updates the type of medium changer in a gateway-VTL. When you activate
|
2376
|
+
# a gateway-VTL, you select a medium changer type for the gateway-VTL.
|
2377
|
+
# This operation enables you to select a different type of medium
|
2378
|
+
# changer after a gateway-VTL is activated.
|
2379
|
+
# @option params [required, String] :vtl_device_arn
|
2380
|
+
# The Amazon Resource Name (ARN) of the medium changer you want to
|
2381
|
+
# select.
|
2382
|
+
# @option params [required, String] :device_type
|
2383
|
+
# The type of medium changer you want to select.
|
2384
|
+
#
|
2385
|
+
# Valid Values: "STK-L700", "AWS-Gateway-VTL"
|
2386
|
+
# @return [Types::UpdateVTLDeviceTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2387
|
+
#
|
2388
|
+
# * {Types::UpdateVTLDeviceTypeOutput#vtl_device_arn #VTLDeviceARN} => String
|
2389
|
+
#
|
2390
|
+
# @example Request syntax with placeholder values
|
2391
|
+
# resp = client.update_vtl_device_type({
|
2392
|
+
# vtl_device_arn: "VTLDeviceARN", # required
|
2393
|
+
# device_type: "DeviceType", # required
|
2394
|
+
# })
|
2395
|
+
#
|
2396
|
+
# @example Response structure
|
2397
|
+
# resp.vtl_device_arn #=> String
|
2398
|
+
# @overload update_vtl_device_type(params = {})
|
2399
|
+
# @param [Hash] params ({})
|
2400
|
+
def update_vtl_device_type(params = {}, options = {})
|
2401
|
+
req = build_request(:update_vtl_device_type, params)
|
2402
|
+
req.send_request(options)
|
2403
|
+
end
|
2404
|
+
|
2405
|
+
# @!endgroup
|
2406
|
+
|
2407
|
+
# @param params ({})
|
2408
|
+
# @api private
|
2409
|
+
def build_request(operation_name, params = {})
|
2410
|
+
handlers = @handlers.for(operation_name)
|
2411
|
+
context = Seahorse::Client::RequestContext.new(
|
2412
|
+
operation_name: operation_name,
|
2413
|
+
operation: config.api.operation(operation_name),
|
2414
|
+
client: self,
|
2415
|
+
params: params,
|
2416
|
+
config: config)
|
2417
|
+
context[:gem_name] = 'aws-sdk-storagegateway'
|
2418
|
+
context[:gem_version] = '1.0.0.rc1'
|
2419
|
+
Seahorse::Client::Request.new(handlers, context)
|
2420
|
+
end
|
2421
|
+
|
2422
|
+
# @api private
|
2423
|
+
# @deprecated
|
2424
|
+
def waiter_names
|
2425
|
+
[]
|
2426
|
+
end
|
2427
|
+
|
2428
|
+
class << self
|
2429
|
+
|
2430
|
+
# @api private
|
2431
|
+
attr_reader :identifier
|
2432
|
+
|
2433
|
+
# @api private
|
2434
|
+
def errors_module
|
2435
|
+
Errors
|
2436
|
+
end
|
2437
|
+
|
2438
|
+
end
|
2439
|
+
end
|
2440
|
+
end
|
2441
|
+
end
|