aws-sdk-snowball 1.0.0.rc2 → 1.0.0.rc3

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 1ef1d6308e89b2ff278920529638e830291302c3
4
- data.tar.gz: d038a98c1c9498d11cbeec7c27bcd01107a15198
3
+ metadata.gz: 159b8c44cc35a70ca43dafb75a3396edef063c38
4
+ data.tar.gz: dd3420357504e5c9943fae401a0248f68f4a93b4
5
5
  SHA512:
6
- metadata.gz: cd47b466224e24f92845f6628ef12d33851253d2246d4df9cecdbf25db763a9215317d079f40a6187de01fa9109afcdbaa4580feed52ceae82d08e36c5a9bfbf
7
- data.tar.gz: 8db5be0c3cc9d9a8d0f527b320db591de8282383f912dbe0d7576559c361ec37ce4d42353a1615fe09a2bc968334471480db8683ea8ed9a95d7c30398ce67f32
6
+ metadata.gz: b12a3cbb199e1430f758a85962a12eaa4a0cb9c1d99a55a6becb8ab4c5d859e7da53b01099b7f789a5b74826746f64b7b9eaaec0736c05be18621641c7a9a347
7
+ data.tar.gz: d42d45a436bdda57c6eda6bd1839e041a01906d3b679de954ac8cbe977dd32e0301051c44384b762321f8e31596d454f3647c1f0c24f73ad033f845e966ef81f
@@ -1,6 +1,6 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-snowball/customizations'
42
42
  # @service
43
43
  module Aws::Snowball
44
44
 
45
- GEM_VERSION = '1.0.0.rc2'
45
+ GEM_VERSION = '1.0.0.rc3'
46
46
 
47
47
  end
@@ -1,6 +1,6 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
@@ -18,1042 +18,1203 @@ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
18
  require 'aws-sdk-core/plugins/response_paging.rb'
19
19
  require 'aws-sdk-core/plugins/stub_responses.rb'
20
20
  require 'aws-sdk-core/plugins/idempotency_token.rb'
21
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
21
22
  require 'aws-sdk-core/plugins/signature_v4.rb'
22
23
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
23
24
 
24
25
  Aws::Plugins::GlobalConfiguration.add_identifier(:snowball)
25
26
 
26
- module Aws
27
- module Snowball
28
- class Client < Seahorse::Client::Base
27
+ module Aws::Snowball
28
+ class Client < Seahorse::Client::Base
29
29
 
30
- include Aws::ClientStubs
30
+ include Aws::ClientStubs
31
31
 
32
- @identifier = :snowball
32
+ @identifier = :snowball
33
33
 
34
- set_api(ClientApi::API)
34
+ set_api(ClientApi::API)
35
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)
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::JsonvalueConverter)
50
+ add_plugin(Aws::Plugins::SignatureV4)
51
+ add_plugin(Aws::Plugins::Protocols::JsonRpc)
51
52
 
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
53
+ # @option options [required, Aws::CredentialProvider] :credentials
54
+ # Your AWS credentials. This can be an instance of any one of the
55
+ # following classes:
56
+ #
57
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
58
+ # credentials.
59
+ #
60
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
61
+ # from an EC2 IMDS on an EC2 instance.
62
+ #
63
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
64
+ # shared file, such as `~/.aws/config`.
65
+ #
66
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
67
+ #
68
+ # When `:credentials` are not configured directly, the following
69
+ # locations will be searched for credentials:
70
+ #
71
+ # * `Aws.config[:credentials]`
72
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
73
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
74
+ # * `~/.aws/credentials`
75
+ # * `~/.aws/config`
76
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
77
+ # very aggressive. Construct and pass an instance of
78
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
79
+ # timeouts.
80
+ #
81
+ # @option options [required, String] :region
82
+ # The AWS region to connect to. The configured `:region` is
83
+ # used to determine the service `:endpoint`. When not passed,
84
+ # a default `:region` is search for in the following locations:
85
+ #
86
+ # * `Aws.config[:region]`
87
+ # * `ENV['AWS_REGION']`
88
+ # * `ENV['AMAZON_REGION']`
89
+ # * `ENV['AWS_DEFAULT_REGION']`
90
+ # * `~/.aws/credentials`
91
+ # * `~/.aws/config`
92
+ #
93
+ # @option options [String] :access_key_id
94
+ #
95
+ # @option options [Boolean] :convert_params (true)
96
+ # When `true`, an attempt is made to coerce request parameters into
97
+ # the required types.
98
+ #
99
+ # @option options [String] :endpoint
100
+ # The client endpoint is normally constructed from the `:region`
101
+ # option. You should only configure an `:endpoint` when connecting
102
+ # to test endpoints. This should be avalid HTTP(S) URI.
103
+ #
104
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
105
+ # The log formatter.
106
+ #
107
+ # @option options [Symbol] :log_level (:info)
108
+ # The log level to send messages to the `:logger` at.
109
+ #
110
+ # @option options [Logger] :logger
111
+ # The Logger instance to send log messages to. If this option
112
+ # is not set, logging will be disabled.
113
+ #
114
+ # @option options [String] :profile ("default")
115
+ # Used when loading credentials from the shared credentials file
116
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
117
+ #
118
+ # @option options [Integer] :retry_limit (3)
119
+ # The maximum number of times to retry failed requests. Only
120
+ # ~ 500 level server errors and certain ~ 400 level client errors
121
+ # are retried. Generally, these are throttling errors, data
122
+ # checksum errors, networking errors, timeout errors and auth
123
+ # errors from expired credentials.
124
+ #
125
+ # @option options [String] :secret_access_key
126
+ #
127
+ # @option options [String] :session_token
128
+ #
129
+ # @option options [Boolean] :simple_json (false)
130
+ # Disables request parameter conversion, validation, and formatting.
131
+ # Also disable response data type conversions. This option is useful
132
+ # when you want to ensure the highest level of performance by
133
+ # avoiding overhead of walking request parameters and response data
134
+ # structures.
135
+ #
136
+ # When `:simple_json` is enabled, the request parameters hash must
137
+ # be formatted exactly as the DynamoDB API expects.
138
+ #
139
+ # @option options [Boolean] :stub_responses (false)
140
+ # Causes the client to return stubbed responses. By default
141
+ # fake responses are generated and returned. You can specify
142
+ # the response data to return or errors to raise by calling
143
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
144
+ #
145
+ # ** Please note ** When response stubbing is enabled, no HTTP
146
+ # requests are made, and retries are disabled.
147
+ #
148
+ # @option options [Boolean] :validate_params (true)
149
+ # When `true`, request parameters are validated before
150
+ # sending the request.
151
+ #
152
+ def initialize(*args)
153
+ super
154
+ end
141
155
 
142
- # Cancels a cluster job. You can only cancel a cluster job while it's
143
- # in the `AwaitingQuorum` status. You'll have at least an hour after
144
- # creating a cluster job to cancel it.
145
- # @option params [required, String] :cluster_id
146
- # The 39-character ID for the cluster that you want to cancel, for
147
- # example `CID123e4567-e89b-12d3-a456-426655440000`.
148
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
149
- #
150
- # @example Request syntax with placeholder values
151
- # resp = client.cancel_cluster({
152
- # cluster_id: "ClusterId", # required
153
- # })
154
- # @overload cancel_cluster(params = {})
155
- # @param [Hash] params ({})
156
- def cancel_cluster(params = {}, options = {})
157
- req = build_request(:cancel_cluster, params)
158
- req.send_request(options)
159
- end
156
+ # @!group API Operations
160
157
 
161
- # Cancels the specified job. You can only cancel a job before its
162
- # `JobState` value changes to `PreparingAppliance`. Requesting the
163
- # `ListJobs` or `DescribeJob` action will return a job's `JobState` as
164
- # part of the response element data returned.
165
- # @option params [required, String] :job_id
166
- # The 39-character job ID for the job that you want to cancel, for
167
- # example `JID123e4567-e89b-12d3-a456-426655440000`.
168
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
169
- #
170
- # @example Request syntax with placeholder values
171
- # resp = client.cancel_job({
172
- # job_id: "JobId", # required
173
- # })
174
- # @overload cancel_job(params = {})
175
- # @param [Hash] params ({})
176
- def cancel_job(params = {}, options = {})
177
- req = build_request(:cancel_job, params)
178
- req.send_request(options)
179
- end
158
+ # Cancels a cluster job. You can only cancel a cluster job while it's
159
+ # in the `AwaitingQuorum` status. You'll have at least an hour after
160
+ # creating a cluster job to cancel it.
161
+ #
162
+ # @option params [required, String] :cluster_id
163
+ # The 39-character ID for the cluster that you want to cancel, for
164
+ # example `CID123e4567-e89b-12d3-a456-426655440000`.
165
+ #
166
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
167
+ #
168
+ # @example Request syntax with placeholder values
169
+ #
170
+ # resp = client.cancel_cluster({
171
+ # cluster_id: "ClusterId", # required
172
+ # })
173
+ #
174
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelCluster AWS API Documentation
175
+ #
176
+ # @overload cancel_cluster(params = {})
177
+ # @param [Hash] params ({})
178
+ def cancel_cluster(params = {}, options = {})
179
+ req = build_request(:cancel_cluster, params)
180
+ req.send_request(options)
181
+ end
180
182
 
181
- # Creates an address for a Snowball to be shipped to.
182
- #
183
- # Addresses are validated at the time of creation. The address you
184
- # provide must be located within the serviceable area of your region. If
185
- # the address is invalid or unsupported, then an exception is thrown.
186
- # @option params [required, Types::Address] :address
187
- # The address that you want the Snowball shipped to.
188
- # @return [Types::CreateAddressResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
189
- #
190
- # * {Types::CreateAddressResult#address_id #AddressId} => String
191
- #
192
- # @example Request syntax with placeholder values
193
- # resp = client.create_address({
194
- # address: { # required
195
- # address_id: "AddressId",
196
- # name: "String",
197
- # company: "String",
198
- # street_1: "String",
199
- # street_2: "String",
200
- # street_3: "String",
201
- # city: "String",
202
- # state_or_province: "String",
203
- # prefecture_or_district: "String",
204
- # landmark: "String",
205
- # country: "String",
206
- # postal_code: "String",
207
- # phone_number: "String",
208
- # },
209
- # })
210
- #
211
- # @example Response structure
212
- # resp.address_id #=> String
213
- # @overload create_address(params = {})
214
- # @param [Hash] params ({})
215
- def create_address(params = {}, options = {})
216
- req = build_request(:create_address, params)
217
- req.send_request(options)
218
- end
183
+ # Cancels the specified job. You can only cancel a job before its
184
+ # `JobState` value changes to `PreparingAppliance`. Requesting the
185
+ # `ListJobs` or `DescribeJob` action will return a job's `JobState` as
186
+ # part of the response element data returned.
187
+ #
188
+ # @option params [required, String] :job_id
189
+ # The 39-character job ID for the job that you want to cancel, for
190
+ # example `JID123e4567-e89b-12d3-a456-426655440000`.
191
+ #
192
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
193
+ #
194
+ # @example Request syntax with placeholder values
195
+ #
196
+ # resp = client.cancel_job({
197
+ # job_id: "JobId", # required
198
+ # })
199
+ #
200
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelJob AWS API Documentation
201
+ #
202
+ # @overload cancel_job(params = {})
203
+ # @param [Hash] params ({})
204
+ def cancel_job(params = {}, options = {})
205
+ req = build_request(:cancel_job, params)
206
+ req.send_request(options)
207
+ end
219
208
 
220
- # Creates an empty cluster. Each cluster supports five nodes. You use
221
- # the CreateJob action separately to create the jobs for each of these
222
- # nodes. The cluster does not ship until these five node jobs have been
223
- # created.
224
- # @option params [required, String] :job_type
225
- # The type of job for this cluster. Currently, the only job type
226
- # supported for clusters is `LOCAL_USE`.
227
- # @option params [required, Types::JobResource] :resources
228
- # The resources associated with the cluster job. These resources include
229
- # Amazon S3 buckets and optional AWS Lambda functions written in the
230
- # Python language.
231
- # @option params [String] :description
232
- # An optional description of this specific cluster, for example
233
- # `Environmental Data Cluster-01`.
234
- # @option params [required, String] :address_id
235
- # The ID for the address that you want the cluster shipped to.&gt;
236
- # @option params [String] :kms_key_arn
237
- # The `KmsKeyARN` value that you want to associate with this cluster.
238
- # `KmsKeyARN` values are created by using the [CreateKey][1] API action
239
- # in AWS Key Management Service (AWS KMS).
240
- #
241
- #
242
- #
243
- # [1]: http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html
244
- # @option params [required, String] :role_arn
245
- # The `RoleARN` that you want to associate with this cluster. `RoleArn`
246
- # values are created by using the [CreateRole][1] API action in AWS
247
- # Identity and Access Management (IAM).
248
- #
249
- #
250
- #
251
- # [1]: http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
252
- # @option params [String] :snowball_type
253
- # The type of AWS Snowball appliance to use for this cluster. Currently,
254
- # the only supported appliance type for cluster jobs is `EDGE`.
255
- # @option params [required, String] :shipping_option
256
- # The shipping speed for each node in this cluster. This speed doesn't
257
- # dictate how soon you'll get each Snowball Edge appliance, rather it
258
- # represents how quickly each appliance moves to its destination while
259
- # in transit. Regional shipping speeds are as follows:
260
- #
261
- # * In Australia, you have access to express shipping. Typically,
262
- # appliances shipped express are delivered in about a day.
263
- #
264
- # * In the European Union (EU), you have access to express shipping.
265
- # Typically, Snowball Edges shipped express are delivered in about a
266
- # day. In addition, most countries in the EU have access to standard
267
- # shipping, which typically takes less than a week, one way.
268
- #
269
- # * In India, Snowball Edges are delivered in one to seven days.
270
- #
271
- # * In the US, you have access to one-day shipping and two-day shipping.
272
- # @option params [Types::Notification] :notification
273
- # The Amazon Simple Notification Service (Amazon SNS) notification
274
- # settings for this cluster.
275
- # @return [Types::CreateClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
276
- #
277
- # * {Types::CreateClusterResult#cluster_id #ClusterId} => String
278
- #
279
- # @example Request syntax with placeholder values
280
- # resp = client.create_cluster({
281
- # job_type: "IMPORT", # required, accepts IMPORT, EXPORT, LOCAL_USE
282
- # resources: { # required
283
- # s3_resources: [
284
- # {
285
- # bucket_arn: "ResourceARN",
286
- # key_range: {
287
- # begin_marker: "String",
288
- # end_marker: "String",
289
- # },
290
- # },
291
- # ],
292
- # lambda_resources: [
293
- # {
294
- # lambda_arn: "ResourceARN",
295
- # event_triggers: [
296
- # {
297
- # event_resource_arn: "ResourceARN",
298
- # },
299
- # ],
300
- # },
301
- # ],
302
- # },
303
- # description: "String",
304
- # address_id: "AddressId", # required
305
- # kms_key_arn: "KmsKeyARN",
306
- # role_arn: "RoleARN", # required
307
- # snowball_type: "STANDARD", # accepts STANDARD, EDGE
308
- # shipping_option: "SECOND_DAY", # required, accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
309
- # notification: {
310
- # sns_topic_arn: "SnsTopicARN",
311
- # job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
312
- # notify_all: false,
313
- # },
314
- # })
315
- #
316
- # @example Response structure
317
- # resp.cluster_id #=> String
318
- # @overload create_cluster(params = {})
319
- # @param [Hash] params ({})
320
- def create_cluster(params = {}, options = {})
321
- req = build_request(:create_cluster, params)
322
- req.send_request(options)
323
- end
209
+ # Creates an address for a Snowball to be shipped to.
210
+ #
211
+ # Addresses are validated at the time of creation. The address you
212
+ # provide must be located within the serviceable area of your region. If
213
+ # the address is invalid or unsupported, then an exception is thrown.
214
+ #
215
+ # @option params [required, Types::Address] :address
216
+ # The address that you want the Snowball shipped to.
217
+ #
218
+ # @return [Types::CreateAddressResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
219
+ #
220
+ # * {Types::CreateAddressResult#address_id #address_id} => String
221
+ #
222
+ # @example Request syntax with placeholder values
223
+ #
224
+ # resp = client.create_address({
225
+ # address: { # required
226
+ # address_id: "AddressId",
227
+ # name: "String",
228
+ # company: "String",
229
+ # street_1: "String",
230
+ # street_2: "String",
231
+ # street_3: "String",
232
+ # city: "String",
233
+ # state_or_province: "String",
234
+ # prefecture_or_district: "String",
235
+ # landmark: "String",
236
+ # country: "String",
237
+ # postal_code: "String",
238
+ # phone_number: "String",
239
+ # },
240
+ # })
241
+ #
242
+ # @example Response structure
243
+ #
244
+ # resp.address_id #=> String
245
+ #
246
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateAddress AWS API Documentation
247
+ #
248
+ # @overload create_address(params = {})
249
+ # @param [Hash] params ({})
250
+ def create_address(params = {}, options = {})
251
+ req = build_request(:create_address, params)
252
+ req.send_request(options)
253
+ end
324
254
 
325
- # Creates a job to import or export data between Amazon S3 and your
326
- # on-premises data center. Your AWS account must have the right trust
327
- # policies and permissions in place to create a job for Snowball. If
328
- # you're creating a job for a node in a cluster, you only need to
329
- # provide the `clusterId` value; the other job attributes are inherited
330
- # from the cluster. .
331
- # @option params [String] :job_type
332
- # Defines the type of job that you're creating.
333
- # @option params [Types::JobResource] :resources
334
- # Defines the Amazon S3 buckets associated with this job.
335
- #
336
- # With `IMPORT` jobs, you specify the bucket or buckets that your
337
- # transferred data will be imported into.
338
- #
339
- # With `EXPORT` jobs, you specify the bucket or buckets that your
340
- # transferred data will be exported from. Optionally, you can also
341
- # specify a `KeyRange` value. If you choose to export a range, you
342
- # define the length of the range by providing either an inclusive
343
- # `BeginMarker` value, an inclusive `EndMarker` value, or both. Ranges
344
- # are UTF-8 binary sorted.
345
- # @option params [String] :description
346
- # Defines an optional description of this specific job, for example
347
- # `Important Photos 2016-08-11`.
348
- # @option params [String] :address_id
349
- # The ID for the address that you want the Snowball shipped to.
350
- # @option params [String] :kms_key_arn
351
- # The `KmsKeyARN` that you want to associate with this job. `KmsKeyARN`s
352
- # are created using the [CreateKey][1] AWS Key Management Service (KMS)
353
- # API action.
354
- #
355
- #
356
- #
357
- # [1]: http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html
358
- # @option params [String] :role_arn
359
- # The `RoleARN` that you want to associate with this job. `RoleArn`s are
360
- # created using the [CreateRole][1] AWS Identity and Access Management
361
- # (IAM) API action.
362
- #
363
- #
364
- #
365
- # [1]: http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
366
- # @option params [String] :snowball_capacity_preference
367
- # If your job is being created in one of the US regions, you have the
368
- # option of specifying what size Snowball you'd like for this job. In
369
- # all other regions, Snowballs come with 80 TB in storage capacity.
370
- # @option params [String] :shipping_option
371
- # The shipping speed for this job. This speed doesn't dictate how soon
372
- # you'll get the Snowball, rather it represents how quickly the
373
- # Snowball moves to its destination while in transit. Regional shipping
374
- # speeds are as follows:
375
- #
376
- # * In Australia, you have access to express shipping. Typically,
377
- # Snowballs shipped express are delivered in about a day.
378
- #
379
- # * In the European Union (EU), you have access to express shipping.
380
- # Typically, Snowballs shipped express are delivered in about a day.
381
- # In addition, most countries in the EU have access to standard
382
- # shipping, which typically takes less than a week, one way.
383
- #
384
- # * In India, Snowballs are delivered in one to seven days.
385
- #
386
- # * In the US, you have access to one-day shipping and two-day shipping.
387
- # @option params [Types::Notification] :notification
388
- # Defines the Amazon Simple Notification Service (Amazon SNS)
389
- # notification settings for this job.
390
- # @option params [String] :cluster_id
391
- # The ID of a cluster. If you're creating a job for a node in a
392
- # cluster, you need to provide only this `clusterId` value. The other
393
- # job attributes are inherited from the cluster.
394
- # @option params [String] :snowball_type
395
- # The type of AWS Snowball appliance to use for this job. Currently, the
396
- # only supported appliance type for cluster jobs is `EDGE`.
397
- # @return [Types::CreateJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
398
- #
399
- # * {Types::CreateJobResult#job_id #JobId} => String
400
- #
401
- # @example Request syntax with placeholder values
402
- # resp = client.create_job({
403
- # job_type: "IMPORT", # accepts IMPORT, EXPORT, LOCAL_USE
404
- # resources: {
405
- # s3_resources: [
406
- # {
407
- # bucket_arn: "ResourceARN",
408
- # key_range: {
409
- # begin_marker: "String",
410
- # end_marker: "String",
411
- # },
412
- # },
413
- # ],
414
- # lambda_resources: [
415
- # {
416
- # lambda_arn: "ResourceARN",
417
- # event_triggers: [
418
- # {
419
- # event_resource_arn: "ResourceARN",
420
- # },
421
- # ],
422
- # },
423
- # ],
424
- # },
425
- # description: "String",
426
- # address_id: "AddressId",
427
- # kms_key_arn: "KmsKeyARN",
428
- # role_arn: "RoleARN",
429
- # snowball_capacity_preference: "T50", # accepts T50, T80, T100, NoPreference
430
- # shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
431
- # notification: {
432
- # sns_topic_arn: "SnsTopicARN",
433
- # job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
434
- # notify_all: false,
435
- # },
436
- # cluster_id: "ClusterId",
437
- # snowball_type: "STANDARD", # accepts STANDARD, EDGE
438
- # })
439
- #
440
- # @example Response structure
441
- # resp.job_id #=> String
442
- # @overload create_job(params = {})
443
- # @param [Hash] params ({})
444
- def create_job(params = {}, options = {})
445
- req = build_request(:create_job, params)
446
- req.send_request(options)
447
- end
255
+ # Creates an empty cluster. Each cluster supports five nodes. You use
256
+ # the CreateJob action separately to create the jobs for each of these
257
+ # nodes. The cluster does not ship until these five node jobs have been
258
+ # created.
259
+ #
260
+ # @option params [required, String] :job_type
261
+ # The type of job for this cluster. Currently, the only job type
262
+ # supported for clusters is `LOCAL_USE`.
263
+ #
264
+ # @option params [required, Types::JobResource] :resources
265
+ # The resources associated with the cluster job. These resources include
266
+ # Amazon S3 buckets and optional AWS Lambda functions written in the
267
+ # Python language.
268
+ #
269
+ # @option params [String] :description
270
+ # An optional description of this specific cluster, for example
271
+ # `Environmental Data Cluster-01`.
272
+ #
273
+ # @option params [required, String] :address_id
274
+ # The ID for the address that you want the cluster shipped to.&gt;
275
+ #
276
+ # @option params [String] :kms_key_arn
277
+ # The `KmsKeyARN` value that you want to associate with this cluster.
278
+ # `KmsKeyARN` values are created by using the [CreateKey][1] API action
279
+ # in AWS Key Management Service (AWS KMS).
280
+ #
281
+ #
282
+ #
283
+ # [1]: http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html
284
+ #
285
+ # @option params [required, String] :role_arn
286
+ # The `RoleARN` that you want to associate with this cluster. `RoleArn`
287
+ # values are created by using the [CreateRole][1] API action in AWS
288
+ # Identity and Access Management (IAM).
289
+ #
290
+ #
291
+ #
292
+ # [1]: http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
293
+ #
294
+ # @option params [String] :snowball_type
295
+ # The type of AWS Snowball appliance to use for this cluster. Currently,
296
+ # the only supported appliance type for cluster jobs is `EDGE`.
297
+ #
298
+ # @option params [required, String] :shipping_option
299
+ # The shipping speed for each node in this cluster. This speed doesn't
300
+ # dictate how soon you'll get each Snowball Edge appliance, rather it
301
+ # represents how quickly each appliance moves to its destination while
302
+ # in transit. Regional shipping speeds are as follows:
303
+ #
304
+ # * In Australia, you have access to express shipping. Typically,
305
+ # appliances shipped express are delivered in about a day.
306
+ #
307
+ # * In the European Union (EU), you have access to express shipping.
308
+ # Typically, Snowball Edges shipped express are delivered in about a
309
+ # day. In addition, most countries in the EU have access to standard
310
+ # shipping, which typically takes less than a week, one way.
311
+ #
312
+ # * In India, Snowball Edges are delivered in one to seven days.
313
+ #
314
+ # * In the US, you have access to one-day shipping and two-day shipping.
315
+ #
316
+ # @option params [Types::Notification] :notification
317
+ # The Amazon Simple Notification Service (Amazon SNS) notification
318
+ # settings for this cluster.
319
+ #
320
+ # @return [Types::CreateClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
321
+ #
322
+ # * {Types::CreateClusterResult#cluster_id #cluster_id} => String
323
+ #
324
+ # @example Request syntax with placeholder values
325
+ #
326
+ # resp = client.create_cluster({
327
+ # job_type: "IMPORT", # required, accepts IMPORT, EXPORT, LOCAL_USE
328
+ # resources: { # required
329
+ # s3_resources: [
330
+ # {
331
+ # bucket_arn: "ResourceARN",
332
+ # key_range: {
333
+ # begin_marker: "String",
334
+ # end_marker: "String",
335
+ # },
336
+ # },
337
+ # ],
338
+ # lambda_resources: [
339
+ # {
340
+ # lambda_arn: "ResourceARN",
341
+ # event_triggers: [
342
+ # {
343
+ # event_resource_arn: "ResourceARN",
344
+ # },
345
+ # ],
346
+ # },
347
+ # ],
348
+ # },
349
+ # description: "String",
350
+ # address_id: "AddressId", # required
351
+ # kms_key_arn: "KmsKeyARN",
352
+ # role_arn: "RoleARN", # required
353
+ # snowball_type: "STANDARD", # accepts STANDARD, EDGE
354
+ # shipping_option: "SECOND_DAY", # required, accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
355
+ # notification: {
356
+ # sns_topic_arn: "SnsTopicARN",
357
+ # job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
358
+ # notify_all: false,
359
+ # },
360
+ # })
361
+ #
362
+ # @example Response structure
363
+ #
364
+ # resp.cluster_id #=> String
365
+ #
366
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateCluster AWS API Documentation
367
+ #
368
+ # @overload create_cluster(params = {})
369
+ # @param [Hash] params ({})
370
+ def create_cluster(params = {}, options = {})
371
+ req = build_request(:create_cluster, params)
372
+ req.send_request(options)
373
+ end
448
374
 
449
- # Takes an `AddressId` and returns specific details about that address
450
- # in the form of an `Address` object.
451
- # @option params [required, String] :address_id
452
- # The automatically generated ID for a specific address.
453
- # @return [Types::DescribeAddressResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
454
- #
455
- # * {Types::DescribeAddressResult#address #Address} => Types::Address
456
- #
457
- # @example Request syntax with placeholder values
458
- # resp = client.describe_address({
459
- # address_id: "AddressId", # required
460
- # })
461
- #
462
- # @example Response structure
463
- # resp.address.address_id #=> String
464
- # resp.address.name #=> String
465
- # resp.address.company #=> String
466
- # resp.address.street_1 #=> String
467
- # resp.address.street_2 #=> String
468
- # resp.address.street_3 #=> String
469
- # resp.address.city #=> String
470
- # resp.address.state_or_province #=> String
471
- # resp.address.prefecture_or_district #=> String
472
- # resp.address.landmark #=> String
473
- # resp.address.country #=> String
474
- # resp.address.postal_code #=> String
475
- # resp.address.phone_number #=> String
476
- # @overload describe_address(params = {})
477
- # @param [Hash] params ({})
478
- def describe_address(params = {}, options = {})
479
- req = build_request(:describe_address, params)
480
- req.send_request(options)
481
- end
375
+ # Creates a job to import or export data between Amazon S3 and your
376
+ # on-premises data center. Your AWS account must have the right trust
377
+ # policies and permissions in place to create a job for Snowball. If
378
+ # you're creating a job for a node in a cluster, you only need to
379
+ # provide the `clusterId` value; the other job attributes are inherited
380
+ # from the cluster. .
381
+ #
382
+ # @option params [String] :job_type
383
+ # Defines the type of job that you're creating.
384
+ #
385
+ # @option params [Types::JobResource] :resources
386
+ # Defines the Amazon S3 buckets associated with this job.
387
+ #
388
+ # With `IMPORT` jobs, you specify the bucket or buckets that your
389
+ # transferred data will be imported into.
390
+ #
391
+ # With `EXPORT` jobs, you specify the bucket or buckets that your
392
+ # transferred data will be exported from. Optionally, you can also
393
+ # specify a `KeyRange` value. If you choose to export a range, you
394
+ # define the length of the range by providing either an inclusive
395
+ # `BeginMarker` value, an inclusive `EndMarker` value, or both. Ranges
396
+ # are UTF-8 binary sorted.
397
+ #
398
+ # @option params [String] :description
399
+ # Defines an optional description of this specific job, for example
400
+ # `Important Photos 2016-08-11`.
401
+ #
402
+ # @option params [String] :address_id
403
+ # The ID for the address that you want the Snowball shipped to.
404
+ #
405
+ # @option params [String] :kms_key_arn
406
+ # The `KmsKeyARN` that you want to associate with this job. `KmsKeyARN`s
407
+ # are created using the [CreateKey][1] AWS Key Management Service (KMS)
408
+ # API action.
409
+ #
410
+ #
411
+ #
412
+ # [1]: http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html
413
+ #
414
+ # @option params [String] :role_arn
415
+ # The `RoleARN` that you want to associate with this job. `RoleArn`s are
416
+ # created using the [CreateRole][1] AWS Identity and Access Management
417
+ # (IAM) API action.
418
+ #
419
+ #
420
+ #
421
+ # [1]: http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
422
+ #
423
+ # @option params [String] :snowball_capacity_preference
424
+ # If your job is being created in one of the US regions, you have the
425
+ # option of specifying what size Snowball you'd like for this job. In
426
+ # all other regions, Snowballs come with 80 TB in storage capacity.
427
+ #
428
+ # @option params [String] :shipping_option
429
+ # The shipping speed for this job. This speed doesn't dictate how soon
430
+ # you'll get the Snowball, rather it represents how quickly the
431
+ # Snowball moves to its destination while in transit. Regional shipping
432
+ # speeds are as follows:
433
+ #
434
+ # * In Australia, you have access to express shipping. Typically,
435
+ # Snowballs shipped express are delivered in about a day.
436
+ #
437
+ # * In the European Union (EU), you have access to express shipping.
438
+ # Typically, Snowballs shipped express are delivered in about a day.
439
+ # In addition, most countries in the EU have access to standard
440
+ # shipping, which typically takes less than a week, one way.
441
+ #
442
+ # * In India, Snowballs are delivered in one to seven days.
443
+ #
444
+ # * In the US, you have access to one-day shipping and two-day shipping.
445
+ #
446
+ # @option params [Types::Notification] :notification
447
+ # Defines the Amazon Simple Notification Service (Amazon SNS)
448
+ # notification settings for this job.
449
+ #
450
+ # @option params [String] :cluster_id
451
+ # The ID of a cluster. If you're creating a job for a node in a
452
+ # cluster, you need to provide only this `clusterId` value. The other
453
+ # job attributes are inherited from the cluster.
454
+ #
455
+ # @option params [String] :snowball_type
456
+ # The type of AWS Snowball appliance to use for this job. Currently, the
457
+ # only supported appliance type for cluster jobs is `EDGE`.
458
+ #
459
+ # @return [Types::CreateJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
460
+ #
461
+ # * {Types::CreateJobResult#job_id #job_id} => String
462
+ #
463
+ # @example Request syntax with placeholder values
464
+ #
465
+ # resp = client.create_job({
466
+ # job_type: "IMPORT", # accepts IMPORT, EXPORT, LOCAL_USE
467
+ # resources: {
468
+ # s3_resources: [
469
+ # {
470
+ # bucket_arn: "ResourceARN",
471
+ # key_range: {
472
+ # begin_marker: "String",
473
+ # end_marker: "String",
474
+ # },
475
+ # },
476
+ # ],
477
+ # lambda_resources: [
478
+ # {
479
+ # lambda_arn: "ResourceARN",
480
+ # event_triggers: [
481
+ # {
482
+ # event_resource_arn: "ResourceARN",
483
+ # },
484
+ # ],
485
+ # },
486
+ # ],
487
+ # },
488
+ # description: "String",
489
+ # address_id: "AddressId",
490
+ # kms_key_arn: "KmsKeyARN",
491
+ # role_arn: "RoleARN",
492
+ # snowball_capacity_preference: "T50", # accepts T50, T80, T100, NoPreference
493
+ # shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
494
+ # notification: {
495
+ # sns_topic_arn: "SnsTopicARN",
496
+ # job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
497
+ # notify_all: false,
498
+ # },
499
+ # cluster_id: "ClusterId",
500
+ # snowball_type: "STANDARD", # accepts STANDARD, EDGE
501
+ # })
502
+ #
503
+ # @example Response structure
504
+ #
505
+ # resp.job_id #=> String
506
+ #
507
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateJob AWS API Documentation
508
+ #
509
+ # @overload create_job(params = {})
510
+ # @param [Hash] params ({})
511
+ def create_job(params = {}, options = {})
512
+ req = build_request(:create_job, params)
513
+ req.send_request(options)
514
+ end
482
515
 
483
- # Returns a specified number of `ADDRESS` objects. Calling this API in
484
- # one of the US regions will return addresses from the list of all
485
- # addresses associated with this account in all US regions.
486
- # @option params [Integer] :max_results
487
- # The number of `ADDRESS` objects to return.
488
- # @option params [String] :next_token
489
- # HTTP requests are stateless. To identify what object comes "next" in
490
- # the list of `ADDRESS` objects, you have the option of specifying a
491
- # value for `NextToken` as the starting point for your list of returned
492
- # addresses.
493
- # @return [Types::DescribeAddressesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
494
- #
495
- # * {Types::DescribeAddressesResult#addresses #Addresses} => Array&lt;Types::Address&gt;
496
- # * {Types::DescribeAddressesResult#next_token #NextToken} => String
497
- #
498
- # @example Request syntax with placeholder values
499
- # resp = client.describe_addresses({
500
- # max_results: 1,
501
- # next_token: "String",
502
- # })
503
- #
504
- # @example Response structure
505
- # resp.addresses #=> Array
506
- # resp.addresses[0].address_id #=> String
507
- # resp.addresses[0].name #=> String
508
- # resp.addresses[0].company #=> String
509
- # resp.addresses[0].street_1 #=> String
510
- # resp.addresses[0].street_2 #=> String
511
- # resp.addresses[0].street_3 #=> String
512
- # resp.addresses[0].city #=> String
513
- # resp.addresses[0].state_or_province #=> String
514
- # resp.addresses[0].prefecture_or_district #=> String
515
- # resp.addresses[0].landmark #=> String
516
- # resp.addresses[0].country #=> String
517
- # resp.addresses[0].postal_code #=> String
518
- # resp.addresses[0].phone_number #=> String
519
- # resp.next_token #=> String
520
- # @overload describe_addresses(params = {})
521
- # @param [Hash] params ({})
522
- def describe_addresses(params = {}, options = {})
523
- req = build_request(:describe_addresses, params)
524
- req.send_request(options)
525
- end
516
+ # Takes an `AddressId` and returns specific details about that address
517
+ # in the form of an `Address` object.
518
+ #
519
+ # @option params [required, String] :address_id
520
+ # The automatically generated ID for a specific address.
521
+ #
522
+ # @return [Types::DescribeAddressResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
523
+ #
524
+ # * {Types::DescribeAddressResult#address #address} => Types::Address
525
+ #
526
+ # @example Request syntax with placeholder values
527
+ #
528
+ # resp = client.describe_address({
529
+ # address_id: "AddressId", # required
530
+ # })
531
+ #
532
+ # @example Response structure
533
+ #
534
+ # resp.address.address_id #=> String
535
+ # resp.address.name #=> String
536
+ # resp.address.company #=> String
537
+ # resp.address.street_1 #=> String
538
+ # resp.address.street_2 #=> String
539
+ # resp.address.street_3 #=> String
540
+ # resp.address.city #=> String
541
+ # resp.address.state_or_province #=> String
542
+ # resp.address.prefecture_or_district #=> String
543
+ # resp.address.landmark #=> String
544
+ # resp.address.country #=> String
545
+ # resp.address.postal_code #=> String
546
+ # resp.address.phone_number #=> String
547
+ #
548
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddress AWS API Documentation
549
+ #
550
+ # @overload describe_address(params = {})
551
+ # @param [Hash] params ({})
552
+ def describe_address(params = {}, options = {})
553
+ req = build_request(:describe_address, params)
554
+ req.send_request(options)
555
+ end
526
556
 
527
- # Returns information about a specific cluster including shipping
528
- # information, cluster status, and other important metadata.
529
- # @option params [required, String] :cluster_id
530
- # The automatically generated ID for a cluster.
531
- # @return [Types::DescribeClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
532
- #
533
- # * {Types::DescribeClusterResult#cluster_metadata #ClusterMetadata} => Types::ClusterMetadata
534
- #
535
- # @example Request syntax with placeholder values
536
- # resp = client.describe_cluster({
537
- # cluster_id: "ClusterId", # required
538
- # })
539
- #
540
- # @example Response structure
541
- # resp.cluster_metadata.cluster_id #=> String
542
- # resp.cluster_metadata.description #=> String
543
- # resp.cluster_metadata.kms_key_arn #=> String
544
- # resp.cluster_metadata.role_arn #=> String
545
- # resp.cluster_metadata.cluster_state #=> String, one of "AwaitingQuorum", "Pending", "InUse", "Complete", "Cancelled"
546
- # resp.cluster_metadata.job_type #=> String, one of "IMPORT", "EXPORT", "LOCAL_USE"
547
- # resp.cluster_metadata.snowball_type #=> String, one of "STANDARD", "EDGE"
548
- # resp.cluster_metadata.creation_date #=> Time
549
- # resp.cluster_metadata.resources.s3_resources #=> Array
550
- # resp.cluster_metadata.resources.s3_resources[0].bucket_arn #=> String
551
- # resp.cluster_metadata.resources.s3_resources[0].key_range.begin_marker #=> String
552
- # resp.cluster_metadata.resources.s3_resources[0].key_range.end_marker #=> String
553
- # resp.cluster_metadata.resources.lambda_resources #=> Array
554
- # resp.cluster_metadata.resources.lambda_resources[0].lambda_arn #=> String
555
- # resp.cluster_metadata.resources.lambda_resources[0].event_triggers #=> Array
556
- # resp.cluster_metadata.resources.lambda_resources[0].event_triggers[0].event_resource_arn #=> String
557
- # resp.cluster_metadata.address_id #=> String
558
- # resp.cluster_metadata.shipping_option #=> String, one of "SECOND_DAY", "NEXT_DAY", "EXPRESS", "STANDARD"
559
- # resp.cluster_metadata.notification.sns_topic_arn #=> String
560
- # resp.cluster_metadata.notification.job_states_to_notify #=> Array
561
- # resp.cluster_metadata.notification.job_states_to_notify[0] #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
562
- # resp.cluster_metadata.notification.notify_all #=> Boolean
563
- # @overload describe_cluster(params = {})
564
- # @param [Hash] params ({})
565
- def describe_cluster(params = {}, options = {})
566
- req = build_request(:describe_cluster, params)
567
- req.send_request(options)
568
- end
557
+ # Returns a specified number of `ADDRESS` objects. Calling this API in
558
+ # one of the US regions will return addresses from the list of all
559
+ # addresses associated with this account in all US regions.
560
+ #
561
+ # @option params [Integer] :max_results
562
+ # The number of `ADDRESS` objects to return.
563
+ #
564
+ # @option params [String] :next_token
565
+ # HTTP requests are stateless. To identify what object comes "next" in
566
+ # the list of `ADDRESS` objects, you have the option of specifying a
567
+ # value for `NextToken` as the starting point for your list of returned
568
+ # addresses.
569
+ #
570
+ # @return [Types::DescribeAddressesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
571
+ #
572
+ # * {Types::DescribeAddressesResult#addresses #addresses} => Array&lt;Types::Address&gt;
573
+ # * {Types::DescribeAddressesResult#next_token #next_token} => String
574
+ #
575
+ # @example Request syntax with placeholder values
576
+ #
577
+ # resp = client.describe_addresses({
578
+ # max_results: 1,
579
+ # next_token: "String",
580
+ # })
581
+ #
582
+ # @example Response structure
583
+ #
584
+ # resp.addresses #=> Array
585
+ # resp.addresses[0].address_id #=> String
586
+ # resp.addresses[0].name #=> String
587
+ # resp.addresses[0].company #=> String
588
+ # resp.addresses[0].street_1 #=> String
589
+ # resp.addresses[0].street_2 #=> String
590
+ # resp.addresses[0].street_3 #=> String
591
+ # resp.addresses[0].city #=> String
592
+ # resp.addresses[0].state_or_province #=> String
593
+ # resp.addresses[0].prefecture_or_district #=> String
594
+ # resp.addresses[0].landmark #=> String
595
+ # resp.addresses[0].country #=> String
596
+ # resp.addresses[0].postal_code #=> String
597
+ # resp.addresses[0].phone_number #=> String
598
+ # resp.next_token #=> String
599
+ #
600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddresses AWS API Documentation
601
+ #
602
+ # @overload describe_addresses(params = {})
603
+ # @param [Hash] params ({})
604
+ def describe_addresses(params = {}, options = {})
605
+ req = build_request(:describe_addresses, params)
606
+ req.send_request(options)
607
+ end
569
608
 
570
- # Returns information about a specific job including shipping
571
- # information, job status, and other important metadata. .
572
- # @option params [required, String] :job_id
573
- # The automatically generated ID for a job, for example
574
- # `JID123e4567-e89b-12d3-a456-426655440000`.
575
- # @return [Types::DescribeJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
576
- #
577
- # * {Types::DescribeJobResult#job_metadata #JobMetadata} => Types::JobMetadata
578
- # * {Types::DescribeJobResult#sub_job_metadata #SubJobMetadata} => Array&lt;Types::JobMetadata&gt;
579
- #
580
- # @example Request syntax with placeholder values
581
- # resp = client.describe_job({
582
- # job_id: "JobId", # required
583
- # })
584
- #
585
- # @example Response structure
586
- # resp.job_metadata.job_id #=> String
587
- # resp.job_metadata.job_state #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
588
- # resp.job_metadata.job_type #=> String, one of "IMPORT", "EXPORT", "LOCAL_USE"
589
- # resp.job_metadata.snowball_type #=> String, one of "STANDARD", "EDGE"
590
- # resp.job_metadata.creation_date #=> Time
591
- # resp.job_metadata.resources.s3_resources #=> Array
592
- # resp.job_metadata.resources.s3_resources[0].bucket_arn #=> String
593
- # resp.job_metadata.resources.s3_resources[0].key_range.begin_marker #=> String
594
- # resp.job_metadata.resources.s3_resources[0].key_range.end_marker #=> String
595
- # resp.job_metadata.resources.lambda_resources #=> Array
596
- # resp.job_metadata.resources.lambda_resources[0].lambda_arn #=> String
597
- # resp.job_metadata.resources.lambda_resources[0].event_triggers #=> Array
598
- # resp.job_metadata.resources.lambda_resources[0].event_triggers[0].event_resource_arn #=> String
599
- # resp.job_metadata.description #=> String
600
- # resp.job_metadata.kms_key_arn #=> String
601
- # resp.job_metadata.role_arn #=> String
602
- # resp.job_metadata.address_id #=> String
603
- # resp.job_metadata.shipping_details.shipping_option #=> String, one of "SECOND_DAY", "NEXT_DAY", "EXPRESS", "STANDARD"
604
- # resp.job_metadata.shipping_details.inbound_shipment.status #=> String
605
- # resp.job_metadata.shipping_details.inbound_shipment.tracking_number #=> String
606
- # resp.job_metadata.shipping_details.outbound_shipment.status #=> String
607
- # resp.job_metadata.shipping_details.outbound_shipment.tracking_number #=> String
608
- # resp.job_metadata.snowball_capacity_preference #=> String, one of "T50", "T80", "T100", "NoPreference"
609
- # resp.job_metadata.notification.sns_topic_arn #=> String
610
- # resp.job_metadata.notification.job_states_to_notify #=> Array
611
- # resp.job_metadata.notification.job_states_to_notify[0] #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
612
- # resp.job_metadata.notification.notify_all #=> Boolean
613
- # resp.job_metadata.data_transfer_progress.bytes_transferred #=> Integer
614
- # resp.job_metadata.data_transfer_progress.objects_transferred #=> Integer
615
- # resp.job_metadata.data_transfer_progress.total_bytes #=> Integer
616
- # resp.job_metadata.data_transfer_progress.total_objects #=> Integer
617
- # resp.job_metadata.job_log_info.job_completion_report_uri #=> String
618
- # resp.job_metadata.job_log_info.job_success_log_uri #=> String
619
- # resp.job_metadata.job_log_info.job_failure_log_uri #=> String
620
- # resp.job_metadata.cluster_id #=> String
621
- # resp.sub_job_metadata #=> Array
622
- # resp.sub_job_metadata[0].job_id #=> String
623
- # resp.sub_job_metadata[0].job_state #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
624
- # resp.sub_job_metadata[0].job_type #=> String, one of "IMPORT", "EXPORT", "LOCAL_USE"
625
- # resp.sub_job_metadata[0].snowball_type #=> String, one of "STANDARD", "EDGE"
626
- # resp.sub_job_metadata[0].creation_date #=> Time
627
- # resp.sub_job_metadata[0].resources.s3_resources #=> Array
628
- # resp.sub_job_metadata[0].resources.s3_resources[0].bucket_arn #=> String
629
- # resp.sub_job_metadata[0].resources.s3_resources[0].key_range.begin_marker #=> String
630
- # resp.sub_job_metadata[0].resources.s3_resources[0].key_range.end_marker #=> String
631
- # resp.sub_job_metadata[0].resources.lambda_resources #=> Array
632
- # resp.sub_job_metadata[0].resources.lambda_resources[0].lambda_arn #=> String
633
- # resp.sub_job_metadata[0].resources.lambda_resources[0].event_triggers #=> Array
634
- # resp.sub_job_metadata[0].resources.lambda_resources[0].event_triggers[0].event_resource_arn #=> String
635
- # resp.sub_job_metadata[0].description #=> String
636
- # resp.sub_job_metadata[0].kms_key_arn #=> String
637
- # resp.sub_job_metadata[0].role_arn #=> String
638
- # resp.sub_job_metadata[0].address_id #=> String
639
- # resp.sub_job_metadata[0].shipping_details.shipping_option #=> String, one of "SECOND_DAY", "NEXT_DAY", "EXPRESS", "STANDARD"
640
- # resp.sub_job_metadata[0].shipping_details.inbound_shipment.status #=> String
641
- # resp.sub_job_metadata[0].shipping_details.inbound_shipment.tracking_number #=> String
642
- # resp.sub_job_metadata[0].shipping_details.outbound_shipment.status #=> String
643
- # resp.sub_job_metadata[0].shipping_details.outbound_shipment.tracking_number #=> String
644
- # resp.sub_job_metadata[0].snowball_capacity_preference #=> String, one of "T50", "T80", "T100", "NoPreference"
645
- # resp.sub_job_metadata[0].notification.sns_topic_arn #=> String
646
- # resp.sub_job_metadata[0].notification.job_states_to_notify #=> Array
647
- # resp.sub_job_metadata[0].notification.job_states_to_notify[0] #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
648
- # resp.sub_job_metadata[0].notification.notify_all #=> Boolean
649
- # resp.sub_job_metadata[0].data_transfer_progress.bytes_transferred #=> Integer
650
- # resp.sub_job_metadata[0].data_transfer_progress.objects_transferred #=> Integer
651
- # resp.sub_job_metadata[0].data_transfer_progress.total_bytes #=> Integer
652
- # resp.sub_job_metadata[0].data_transfer_progress.total_objects #=> Integer
653
- # resp.sub_job_metadata[0].job_log_info.job_completion_report_uri #=> String
654
- # resp.sub_job_metadata[0].job_log_info.job_success_log_uri #=> String
655
- # resp.sub_job_metadata[0].job_log_info.job_failure_log_uri #=> String
656
- # resp.sub_job_metadata[0].cluster_id #=> String
657
- # @overload describe_job(params = {})
658
- # @param [Hash] params ({})
659
- def describe_job(params = {}, options = {})
660
- req = build_request(:describe_job, params)
661
- req.send_request(options)
662
- end
609
+ # Returns information about a specific cluster including shipping
610
+ # information, cluster status, and other important metadata.
611
+ #
612
+ # @option params [required, String] :cluster_id
613
+ # The automatically generated ID for a cluster.
614
+ #
615
+ # @return [Types::DescribeClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
616
+ #
617
+ # * {Types::DescribeClusterResult#cluster_metadata #cluster_metadata} => Types::ClusterMetadata
618
+ #
619
+ # @example Request syntax with placeholder values
620
+ #
621
+ # resp = client.describe_cluster({
622
+ # cluster_id: "ClusterId", # required
623
+ # })
624
+ #
625
+ # @example Response structure
626
+ #
627
+ # resp.cluster_metadata.cluster_id #=> String
628
+ # resp.cluster_metadata.description #=> String
629
+ # resp.cluster_metadata.kms_key_arn #=> String
630
+ # resp.cluster_metadata.role_arn #=> String
631
+ # resp.cluster_metadata.cluster_state #=> String, one of "AwaitingQuorum", "Pending", "InUse", "Complete", "Cancelled"
632
+ # resp.cluster_metadata.job_type #=> String, one of "IMPORT", "EXPORT", "LOCAL_USE"
633
+ # resp.cluster_metadata.snowball_type #=> String, one of "STANDARD", "EDGE"
634
+ # resp.cluster_metadata.creation_date #=> Time
635
+ # resp.cluster_metadata.resources.s3_resources #=> Array
636
+ # resp.cluster_metadata.resources.s3_resources[0].bucket_arn #=> String
637
+ # resp.cluster_metadata.resources.s3_resources[0].key_range.begin_marker #=> String
638
+ # resp.cluster_metadata.resources.s3_resources[0].key_range.end_marker #=> String
639
+ # resp.cluster_metadata.resources.lambda_resources #=> Array
640
+ # resp.cluster_metadata.resources.lambda_resources[0].lambda_arn #=> String
641
+ # resp.cluster_metadata.resources.lambda_resources[0].event_triggers #=> Array
642
+ # resp.cluster_metadata.resources.lambda_resources[0].event_triggers[0].event_resource_arn #=> String
643
+ # resp.cluster_metadata.address_id #=> String
644
+ # resp.cluster_metadata.shipping_option #=> String, one of "SECOND_DAY", "NEXT_DAY", "EXPRESS", "STANDARD"
645
+ # resp.cluster_metadata.notification.sns_topic_arn #=> String
646
+ # resp.cluster_metadata.notification.job_states_to_notify #=> Array
647
+ # resp.cluster_metadata.notification.job_states_to_notify[0] #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
648
+ # resp.cluster_metadata.notification.notify_all #=> Boolean
649
+ #
650
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeCluster AWS API Documentation
651
+ #
652
+ # @overload describe_cluster(params = {})
653
+ # @param [Hash] params ({})
654
+ def describe_cluster(params = {}, options = {})
655
+ req = build_request(:describe_cluster, params)
656
+ req.send_request(options)
657
+ end
663
658
 
664
- # Returns a link to an Amazon S3 presigned URL for the manifest file
665
- # associated with the specified `JobId` value. You can access the
666
- # manifest file for up to 60 minutes after this request has been made.
667
- # To access the manifest file after 60 minutes have passed, you'll have
668
- # to make another call to the `GetJobManifest` action.
669
- #
670
- # The manifest is an encrypted file that you can download after your job
671
- # enters the `WithCustomer` status. The manifest is decrypted by using
672
- # the `UnlockCode` code value, when you pass both values to the Snowball
673
- # through the Snowball client when the client is started for the first
674
- # time.
675
- #
676
- # As a best practice, we recommend that you don't save a copy of an
677
- # `UnlockCode` value in the same location as the manifest file for that
678
- # job. Saving these separately helps prevent unauthorized parties from
679
- # gaining access to the Snowball associated with that job.
680
- #
681
- # The credentials of a given job, including its manifest file and unlock
682
- # code, expire 90 days after the job is created.
683
- # @option params [required, String] :job_id
684
- # The ID for a job that you want to get the manifest file for, for
685
- # example `JID123e4567-e89b-12d3-a456-426655440000`.
686
- # @return [Types::GetJobManifestResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
687
- #
688
- # * {Types::GetJobManifestResult#manifest_uri #ManifestURI} => String
689
- #
690
- # @example Request syntax with placeholder values
691
- # resp = client.get_job_manifest({
692
- # job_id: "JobId", # required
693
- # })
694
- #
695
- # @example Response structure
696
- # resp.manifest_uri #=> String
697
- # @overload get_job_manifest(params = {})
698
- # @param [Hash] params ({})
699
- def get_job_manifest(params = {}, options = {})
700
- req = build_request(:get_job_manifest, params)
701
- req.send_request(options)
702
- end
659
+ # Returns information about a specific job including shipping
660
+ # information, job status, and other important metadata. .
661
+ #
662
+ # @option params [required, String] :job_id
663
+ # The automatically generated ID for a job, for example
664
+ # `JID123e4567-e89b-12d3-a456-426655440000`.
665
+ #
666
+ # @return [Types::DescribeJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
667
+ #
668
+ # * {Types::DescribeJobResult#job_metadata #job_metadata} => Types::JobMetadata
669
+ # * {Types::DescribeJobResult#sub_job_metadata #sub_job_metadata} => Array&lt;Types::JobMetadata&gt;
670
+ #
671
+ # @example Request syntax with placeholder values
672
+ #
673
+ # resp = client.describe_job({
674
+ # job_id: "JobId", # required
675
+ # })
676
+ #
677
+ # @example Response structure
678
+ #
679
+ # resp.job_metadata.job_id #=> String
680
+ # resp.job_metadata.job_state #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
681
+ # resp.job_metadata.job_type #=> String, one of "IMPORT", "EXPORT", "LOCAL_USE"
682
+ # resp.job_metadata.snowball_type #=> String, one of "STANDARD", "EDGE"
683
+ # resp.job_metadata.creation_date #=> Time
684
+ # resp.job_metadata.resources.s3_resources #=> Array
685
+ # resp.job_metadata.resources.s3_resources[0].bucket_arn #=> String
686
+ # resp.job_metadata.resources.s3_resources[0].key_range.begin_marker #=> String
687
+ # resp.job_metadata.resources.s3_resources[0].key_range.end_marker #=> String
688
+ # resp.job_metadata.resources.lambda_resources #=> Array
689
+ # resp.job_metadata.resources.lambda_resources[0].lambda_arn #=> String
690
+ # resp.job_metadata.resources.lambda_resources[0].event_triggers #=> Array
691
+ # resp.job_metadata.resources.lambda_resources[0].event_triggers[0].event_resource_arn #=> String
692
+ # resp.job_metadata.description #=> String
693
+ # resp.job_metadata.kms_key_arn #=> String
694
+ # resp.job_metadata.role_arn #=> String
695
+ # resp.job_metadata.address_id #=> String
696
+ # resp.job_metadata.shipping_details.shipping_option #=> String, one of "SECOND_DAY", "NEXT_DAY", "EXPRESS", "STANDARD"
697
+ # resp.job_metadata.shipping_details.inbound_shipment.status #=> String
698
+ # resp.job_metadata.shipping_details.inbound_shipment.tracking_number #=> String
699
+ # resp.job_metadata.shipping_details.outbound_shipment.status #=> String
700
+ # resp.job_metadata.shipping_details.outbound_shipment.tracking_number #=> String
701
+ # resp.job_metadata.snowball_capacity_preference #=> String, one of "T50", "T80", "T100", "NoPreference"
702
+ # resp.job_metadata.notification.sns_topic_arn #=> String
703
+ # resp.job_metadata.notification.job_states_to_notify #=> Array
704
+ # resp.job_metadata.notification.job_states_to_notify[0] #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
705
+ # resp.job_metadata.notification.notify_all #=> Boolean
706
+ # resp.job_metadata.data_transfer_progress.bytes_transferred #=> Integer
707
+ # resp.job_metadata.data_transfer_progress.objects_transferred #=> Integer
708
+ # resp.job_metadata.data_transfer_progress.total_bytes #=> Integer
709
+ # resp.job_metadata.data_transfer_progress.total_objects #=> Integer
710
+ # resp.job_metadata.job_log_info.job_completion_report_uri #=> String
711
+ # resp.job_metadata.job_log_info.job_success_log_uri #=> String
712
+ # resp.job_metadata.job_log_info.job_failure_log_uri #=> String
713
+ # resp.job_metadata.cluster_id #=> String
714
+ # resp.sub_job_metadata #=> Array
715
+ # resp.sub_job_metadata[0].job_id #=> String
716
+ # resp.sub_job_metadata[0].job_state #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
717
+ # resp.sub_job_metadata[0].job_type #=> String, one of "IMPORT", "EXPORT", "LOCAL_USE"
718
+ # resp.sub_job_metadata[0].snowball_type #=> String, one of "STANDARD", "EDGE"
719
+ # resp.sub_job_metadata[0].creation_date #=> Time
720
+ # resp.sub_job_metadata[0].resources.s3_resources #=> Array
721
+ # resp.sub_job_metadata[0].resources.s3_resources[0].bucket_arn #=> String
722
+ # resp.sub_job_metadata[0].resources.s3_resources[0].key_range.begin_marker #=> String
723
+ # resp.sub_job_metadata[0].resources.s3_resources[0].key_range.end_marker #=> String
724
+ # resp.sub_job_metadata[0].resources.lambda_resources #=> Array
725
+ # resp.sub_job_metadata[0].resources.lambda_resources[0].lambda_arn #=> String
726
+ # resp.sub_job_metadata[0].resources.lambda_resources[0].event_triggers #=> Array
727
+ # resp.sub_job_metadata[0].resources.lambda_resources[0].event_triggers[0].event_resource_arn #=> String
728
+ # resp.sub_job_metadata[0].description #=> String
729
+ # resp.sub_job_metadata[0].kms_key_arn #=> String
730
+ # resp.sub_job_metadata[0].role_arn #=> String
731
+ # resp.sub_job_metadata[0].address_id #=> String
732
+ # resp.sub_job_metadata[0].shipping_details.shipping_option #=> String, one of "SECOND_DAY", "NEXT_DAY", "EXPRESS", "STANDARD"
733
+ # resp.sub_job_metadata[0].shipping_details.inbound_shipment.status #=> String
734
+ # resp.sub_job_metadata[0].shipping_details.inbound_shipment.tracking_number #=> String
735
+ # resp.sub_job_metadata[0].shipping_details.outbound_shipment.status #=> String
736
+ # resp.sub_job_metadata[0].shipping_details.outbound_shipment.tracking_number #=> String
737
+ # resp.sub_job_metadata[0].snowball_capacity_preference #=> String, one of "T50", "T80", "T100", "NoPreference"
738
+ # resp.sub_job_metadata[0].notification.sns_topic_arn #=> String
739
+ # resp.sub_job_metadata[0].notification.job_states_to_notify #=> Array
740
+ # resp.sub_job_metadata[0].notification.job_states_to_notify[0] #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
741
+ # resp.sub_job_metadata[0].notification.notify_all #=> Boolean
742
+ # resp.sub_job_metadata[0].data_transfer_progress.bytes_transferred #=> Integer
743
+ # resp.sub_job_metadata[0].data_transfer_progress.objects_transferred #=> Integer
744
+ # resp.sub_job_metadata[0].data_transfer_progress.total_bytes #=> Integer
745
+ # resp.sub_job_metadata[0].data_transfer_progress.total_objects #=> Integer
746
+ # resp.sub_job_metadata[0].job_log_info.job_completion_report_uri #=> String
747
+ # resp.sub_job_metadata[0].job_log_info.job_success_log_uri #=> String
748
+ # resp.sub_job_metadata[0].job_log_info.job_failure_log_uri #=> String
749
+ # resp.sub_job_metadata[0].cluster_id #=> String
750
+ #
751
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeJob AWS API Documentation
752
+ #
753
+ # @overload describe_job(params = {})
754
+ # @param [Hash] params ({})
755
+ def describe_job(params = {}, options = {})
756
+ req = build_request(:describe_job, params)
757
+ req.send_request(options)
758
+ end
703
759
 
704
- # Returns the `UnlockCode` code value for the specified job. A
705
- # particular `UnlockCode` value can be accessed for up to 90 days after
706
- # the associated job has been created.
707
- #
708
- # The `UnlockCode` value is a 29-character code with 25 alphanumeric
709
- # characters and 4 hyphens. This code is used to decrypt the manifest
710
- # file when it is passed along with the manifest to the Snowball through
711
- # the Snowball client when the client is started for the first time.
712
- #
713
- # As a best practice, we recommend that you don't save a copy of the
714
- # `UnlockCode` in the same location as the manifest file for that job.
715
- # Saving these separately helps prevent unauthorized parties from
716
- # gaining access to the Snowball associated with that job.
717
- # @option params [required, String] :job_id
718
- # The ID for the job that you want to get the `UnlockCode` value for,
719
- # for example `JID123e4567-e89b-12d3-a456-426655440000`.
720
- # @return [Types::GetJobUnlockCodeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
721
- #
722
- # * {Types::GetJobUnlockCodeResult#unlock_code #UnlockCode} => String
723
- #
724
- # @example Request syntax with placeholder values
725
- # resp = client.get_job_unlock_code({
726
- # job_id: "JobId", # required
727
- # })
728
- #
729
- # @example Response structure
730
- # resp.unlock_code #=> String
731
- # @overload get_job_unlock_code(params = {})
732
- # @param [Hash] params ({})
733
- def get_job_unlock_code(params = {}, options = {})
734
- req = build_request(:get_job_unlock_code, params)
735
- req.send_request(options)
736
- end
760
+ # Returns a link to an Amazon S3 presigned URL for the manifest file
761
+ # associated with the specified `JobId` value. You can access the
762
+ # manifest file for up to 60 minutes after this request has been made.
763
+ # To access the manifest file after 60 minutes have passed, you'll have
764
+ # to make another call to the `GetJobManifest` action.
765
+ #
766
+ # The manifest is an encrypted file that you can download after your job
767
+ # enters the `WithCustomer` status. The manifest is decrypted by using
768
+ # the `UnlockCode` code value, when you pass both values to the Snowball
769
+ # through the Snowball client when the client is started for the first
770
+ # time.
771
+ #
772
+ # As a best practice, we recommend that you don't save a copy of an
773
+ # `UnlockCode` value in the same location as the manifest file for that
774
+ # job. Saving these separately helps prevent unauthorized parties from
775
+ # gaining access to the Snowball associated with that job.
776
+ #
777
+ # The credentials of a given job, including its manifest file and unlock
778
+ # code, expire 90 days after the job is created.
779
+ #
780
+ # @option params [required, String] :job_id
781
+ # The ID for a job that you want to get the manifest file for, for
782
+ # example `JID123e4567-e89b-12d3-a456-426655440000`.
783
+ #
784
+ # @return [Types::GetJobManifestResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
785
+ #
786
+ # * {Types::GetJobManifestResult#manifest_uri #manifest_uri} => String
787
+ #
788
+ # @example Request syntax with placeholder values
789
+ #
790
+ # resp = client.get_job_manifest({
791
+ # job_id: "JobId", # required
792
+ # })
793
+ #
794
+ # @example Response structure
795
+ #
796
+ # resp.manifest_uri #=> String
797
+ #
798
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobManifest AWS API Documentation
799
+ #
800
+ # @overload get_job_manifest(params = {})
801
+ # @param [Hash] params ({})
802
+ def get_job_manifest(params = {}, options = {})
803
+ req = build_request(:get_job_manifest, params)
804
+ req.send_request(options)
805
+ end
737
806
 
738
- # Returns information about the Snowball service limit for your account,
739
- # and also the number of Snowballs your account has in use.
740
- #
741
- # The default service limit for the number of Snowballs that you can
742
- # have at one time is 1. If you want to increase your service limit,
743
- # contact AWS Support.
744
- # @return [Types::GetSnowballUsageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
745
- #
746
- # * {Types::GetSnowballUsageResult#snowball_limit #SnowballLimit} => Integer
747
- # * {Types::GetSnowballUsageResult#snowballs_in_use #SnowballsInUse} => Integer
748
- #
749
- # @example Request syntax with placeholder values
750
- # resp = client.get_snowball_usage()
751
- #
752
- # @example Response structure
753
- # resp.snowball_limit #=> Integer
754
- # resp.snowballs_in_use #=> Integer
755
- # @overload get_snowball_usage(params = {})
756
- # @param [Hash] params ({})
757
- def get_snowball_usage(params = {}, options = {})
758
- req = build_request(:get_snowball_usage, params)
759
- req.send_request(options)
760
- end
807
+ # Returns the `UnlockCode` code value for the specified job. A
808
+ # particular `UnlockCode` value can be accessed for up to 90 days after
809
+ # the associated job has been created.
810
+ #
811
+ # The `UnlockCode` value is a 29-character code with 25 alphanumeric
812
+ # characters and 4 hyphens. This code is used to decrypt the manifest
813
+ # file when it is passed along with the manifest to the Snowball through
814
+ # the Snowball client when the client is started for the first time.
815
+ #
816
+ # As a best practice, we recommend that you don't save a copy of the
817
+ # `UnlockCode` in the same location as the manifest file for that job.
818
+ # Saving these separately helps prevent unauthorized parties from
819
+ # gaining access to the Snowball associated with that job.
820
+ #
821
+ # @option params [required, String] :job_id
822
+ # The ID for the job that you want to get the `UnlockCode` value for,
823
+ # for example `JID123e4567-e89b-12d3-a456-426655440000`.
824
+ #
825
+ # @return [Types::GetJobUnlockCodeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
826
+ #
827
+ # * {Types::GetJobUnlockCodeResult#unlock_code #unlock_code} => String
828
+ #
829
+ # @example Request syntax with placeholder values
830
+ #
831
+ # resp = client.get_job_unlock_code({
832
+ # job_id: "JobId", # required
833
+ # })
834
+ #
835
+ # @example Response structure
836
+ #
837
+ # resp.unlock_code #=> String
838
+ #
839
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobUnlockCode AWS API Documentation
840
+ #
841
+ # @overload get_job_unlock_code(params = {})
842
+ # @param [Hash] params ({})
843
+ def get_job_unlock_code(params = {}, options = {})
844
+ req = build_request(:get_job_unlock_code, params)
845
+ req.send_request(options)
846
+ end
761
847
 
762
- # Returns an array of `JobListEntry` objects of the specified length.
763
- # Each `JobListEntry` object is for a job in the specified cluster and
764
- # contains a job's state, a job's ID, and other information.
765
- # @option params [required, String] :cluster_id
766
- # The 39-character ID for the cluster that you want to list, for example
767
- # `CID123e4567-e89b-12d3-a456-426655440000`.
768
- # @option params [Integer] :max_results
769
- # The number of `JobListEntry` objects to return.
770
- # @option params [String] :next_token
771
- # HTTP requests are stateless. To identify what object comes "next" in
772
- # the list of `JobListEntry` objects, you have the option of specifying
773
- # `NextToken` as the starting point for your returned list.
774
- # @return [Types::ListClusterJobsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
775
- #
776
- # * {Types::ListClusterJobsResult#job_list_entries #JobListEntries} => Array&lt;Types::JobListEntry&gt;
777
- # * {Types::ListClusterJobsResult#next_token #NextToken} => String
778
- #
779
- # @example Request syntax with placeholder values
780
- # resp = client.list_cluster_jobs({
781
- # cluster_id: "ClusterId", # required
782
- # max_results: 1,
783
- # next_token: "String",
784
- # })
785
- #
786
- # @example Response structure
787
- # resp.job_list_entries #=> Array
788
- # resp.job_list_entries[0].job_id #=> String
789
- # resp.job_list_entries[0].job_state #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
790
- # resp.job_list_entries[0].is_master #=> Boolean
791
- # resp.job_list_entries[0].job_type #=> String, one of "IMPORT", "EXPORT", "LOCAL_USE"
792
- # resp.job_list_entries[0].snowball_type #=> String, one of "STANDARD", "EDGE"
793
- # resp.job_list_entries[0].creation_date #=> Time
794
- # resp.job_list_entries[0].description #=> String
795
- # resp.next_token #=> String
796
- # @overload list_cluster_jobs(params = {})
797
- # @param [Hash] params ({})
798
- def list_cluster_jobs(params = {}, options = {})
799
- req = build_request(:list_cluster_jobs, params)
800
- req.send_request(options)
801
- end
848
+ # Returns information about the Snowball service limit for your account,
849
+ # and also the number of Snowballs your account has in use.
850
+ #
851
+ # The default service limit for the number of Snowballs that you can
852
+ # have at one time is 1. If you want to increase your service limit,
853
+ # contact AWS Support.
854
+ #
855
+ # @return [Types::GetSnowballUsageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
856
+ #
857
+ # * {Types::GetSnowballUsageResult#snowball_limit #snowball_limit} => Integer
858
+ # * {Types::GetSnowballUsageResult#snowballs_in_use #snowballs_in_use} => Integer
859
+ #
860
+ # @example Response structure
861
+ #
862
+ # resp.snowball_limit #=> Integer
863
+ # resp.snowballs_in_use #=> Integer
864
+ #
865
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetSnowballUsage AWS API Documentation
866
+ #
867
+ # @overload get_snowball_usage(params = {})
868
+ # @param [Hash] params ({})
869
+ def get_snowball_usage(params = {}, options = {})
870
+ req = build_request(:get_snowball_usage, params)
871
+ req.send_request(options)
872
+ end
802
873
 
803
- # Returns an array of `ClusterListEntry` objects of the specified
804
- # length. Each `ClusterListEntry` object contains a cluster's state, a
805
- # cluster's ID, and other important status information.
806
- # @option params [Integer] :max_results
807
- # The number of `ClusterListEntry` objects to return.
808
- # @option params [String] :next_token
809
- # HTTP requests are stateless. To identify what object comes "next" in
810
- # the list of `ClusterListEntry` objects, you have the option of
811
- # specifying `NextToken` as the starting point for your returned list.
812
- # @return [Types::ListClustersResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
813
- #
814
- # * {Types::ListClustersResult#cluster_list_entries #ClusterListEntries} => Array&lt;Types::ClusterListEntry&gt;
815
- # * {Types::ListClustersResult#next_token #NextToken} => String
816
- #
817
- # @example Request syntax with placeholder values
818
- # resp = client.list_clusters({
819
- # max_results: 1,
820
- # next_token: "String",
821
- # })
822
- #
823
- # @example Response structure
824
- # resp.cluster_list_entries #=> Array
825
- # resp.cluster_list_entries[0].cluster_id #=> String
826
- # resp.cluster_list_entries[0].cluster_state #=> String, one of "AwaitingQuorum", "Pending", "InUse", "Complete", "Cancelled"
827
- # resp.cluster_list_entries[0].creation_date #=> Time
828
- # resp.cluster_list_entries[0].description #=> String
829
- # resp.next_token #=> String
830
- # @overload list_clusters(params = {})
831
- # @param [Hash] params ({})
832
- def list_clusters(params = {}, options = {})
833
- req = build_request(:list_clusters, params)
834
- req.send_request(options)
835
- end
874
+ # Returns an array of `JobListEntry` objects of the specified length.
875
+ # Each `JobListEntry` object is for a job in the specified cluster and
876
+ # contains a job's state, a job's ID, and other information.
877
+ #
878
+ # @option params [required, String] :cluster_id
879
+ # The 39-character ID for the cluster that you want to list, for example
880
+ # `CID123e4567-e89b-12d3-a456-426655440000`.
881
+ #
882
+ # @option params [Integer] :max_results
883
+ # The number of `JobListEntry` objects to return.
884
+ #
885
+ # @option params [String] :next_token
886
+ # HTTP requests are stateless. To identify what object comes "next" in
887
+ # the list of `JobListEntry` objects, you have the option of specifying
888
+ # `NextToken` as the starting point for your returned list.
889
+ #
890
+ # @return [Types::ListClusterJobsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
891
+ #
892
+ # * {Types::ListClusterJobsResult#job_list_entries #job_list_entries} => Array&lt;Types::JobListEntry&gt;
893
+ # * {Types::ListClusterJobsResult#next_token #next_token} => String
894
+ #
895
+ # @example Request syntax with placeholder values
896
+ #
897
+ # resp = client.list_cluster_jobs({
898
+ # cluster_id: "ClusterId", # required
899
+ # max_results: 1,
900
+ # next_token: "String",
901
+ # })
902
+ #
903
+ # @example Response structure
904
+ #
905
+ # resp.job_list_entries #=> Array
906
+ # resp.job_list_entries[0].job_id #=> String
907
+ # resp.job_list_entries[0].job_state #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
908
+ # resp.job_list_entries[0].is_master #=> Boolean
909
+ # resp.job_list_entries[0].job_type #=> String, one of "IMPORT", "EXPORT", "LOCAL_USE"
910
+ # resp.job_list_entries[0].snowball_type #=> String, one of "STANDARD", "EDGE"
911
+ # resp.job_list_entries[0].creation_date #=> Time
912
+ # resp.job_list_entries[0].description #=> String
913
+ # resp.next_token #=> String
914
+ #
915
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClusterJobs AWS API Documentation
916
+ #
917
+ # @overload list_cluster_jobs(params = {})
918
+ # @param [Hash] params ({})
919
+ def list_cluster_jobs(params = {}, options = {})
920
+ req = build_request(:list_cluster_jobs, params)
921
+ req.send_request(options)
922
+ end
836
923
 
837
- # Returns an array of `JobListEntry` objects of the specified length.
838
- # Each `JobListEntry` object contains a job's state, a job's ID, and a
839
- # value that indicates whether the job is a job part, in the case of
840
- # export jobs. Calling this API action in one of the US regions will
841
- # return jobs from the list of all jobs associated with this account in
842
- # all US regions.
843
- # @option params [Integer] :max_results
844
- # The number of `JobListEntry` objects to return.
845
- # @option params [String] :next_token
846
- # HTTP requests are stateless. To identify what object comes "next" in
847
- # the list of `JobListEntry` objects, you have the option of specifying
848
- # `NextToken` as the starting point for your returned list.
849
- # @return [Types::ListJobsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
850
- #
851
- # * {Types::ListJobsResult#job_list_entries #JobListEntries} => Array&lt;Types::JobListEntry&gt;
852
- # * {Types::ListJobsResult#next_token #NextToken} => String
853
- #
854
- # @example Request syntax with placeholder values
855
- # resp = client.list_jobs({
856
- # max_results: 1,
857
- # next_token: "String",
858
- # })
859
- #
860
- # @example Response structure
861
- # resp.job_list_entries #=> Array
862
- # resp.job_list_entries[0].job_id #=> String
863
- # resp.job_list_entries[0].job_state #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
864
- # resp.job_list_entries[0].is_master #=> Boolean
865
- # resp.job_list_entries[0].job_type #=> String, one of "IMPORT", "EXPORT", "LOCAL_USE"
866
- # resp.job_list_entries[0].snowball_type #=> String, one of "STANDARD", "EDGE"
867
- # resp.job_list_entries[0].creation_date #=> Time
868
- # resp.job_list_entries[0].description #=> String
869
- # resp.next_token #=> String
870
- # @overload list_jobs(params = {})
871
- # @param [Hash] params ({})
872
- def list_jobs(params = {}, options = {})
873
- req = build_request(:list_jobs, params)
874
- req.send_request(options)
875
- end
924
+ # Returns an array of `ClusterListEntry` objects of the specified
925
+ # length. Each `ClusterListEntry` object contains a cluster's state, a
926
+ # cluster's ID, and other important status information.
927
+ #
928
+ # @option params [Integer] :max_results
929
+ # The number of `ClusterListEntry` objects to return.
930
+ #
931
+ # @option params [String] :next_token
932
+ # HTTP requests are stateless. To identify what object comes "next" in
933
+ # the list of `ClusterListEntry` objects, you have the option of
934
+ # specifying `NextToken` as the starting point for your returned list.
935
+ #
936
+ # @return [Types::ListClustersResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
937
+ #
938
+ # * {Types::ListClustersResult#cluster_list_entries #cluster_list_entries} => Array&lt;Types::ClusterListEntry&gt;
939
+ # * {Types::ListClustersResult#next_token #next_token} => String
940
+ #
941
+ # @example Request syntax with placeholder values
942
+ #
943
+ # resp = client.list_clusters({
944
+ # max_results: 1,
945
+ # next_token: "String",
946
+ # })
947
+ #
948
+ # @example Response structure
949
+ #
950
+ # resp.cluster_list_entries #=> Array
951
+ # resp.cluster_list_entries[0].cluster_id #=> String
952
+ # resp.cluster_list_entries[0].cluster_state #=> String, one of "AwaitingQuorum", "Pending", "InUse", "Complete", "Cancelled"
953
+ # resp.cluster_list_entries[0].creation_date #=> Time
954
+ # resp.cluster_list_entries[0].description #=> String
955
+ # resp.next_token #=> String
956
+ #
957
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClusters AWS API Documentation
958
+ #
959
+ # @overload list_clusters(params = {})
960
+ # @param [Hash] params ({})
961
+ def list_clusters(params = {}, options = {})
962
+ req = build_request(:list_clusters, params)
963
+ req.send_request(options)
964
+ end
876
965
 
877
- # While a cluster's `ClusterState` value is in the `AwaitingQuorum`
878
- # state, you can update some of the information associated with a
879
- # cluster. Once the cluster changes to a different job state, usually 60
880
- # minutes after the cluster being created, this action is no longer
881
- # available.
882
- # @option params [required, String] :cluster_id
883
- # The cluster ID of the cluster that you want to update, for example
884
- # `CID123e4567-e89b-12d3-a456-426655440000`.
885
- # @option params [String] :role_arn
886
- # The new role Amazon Resource Name (ARN) that you want to associate
887
- # with this cluster. To create a role ARN, use the [CreateRole][1] API
888
- # action in AWS Identity and Access Management (IAM).
889
- #
890
- #
891
- #
892
- # [1]: http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
893
- # @option params [String] :description
894
- # The updated description of this cluster.
895
- # @option params [Types::JobResource] :resources
896
- # The updated arrays of JobResource objects that can include updated
897
- # S3Resource objects or LambdaResource objects.
898
- # @option params [String] :address_id
899
- # The ID of the updated Address object.
900
- # @option params [String] :shipping_option
901
- # The updated shipping option value of this cluster's ShippingDetails
902
- # object.
903
- # @option params [Types::Notification] :notification
904
- # The new or updated Notification object.
905
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
906
- #
907
- # @example Request syntax with placeholder values
908
- # resp = client.update_cluster({
909
- # cluster_id: "ClusterId", # required
910
- # role_arn: "RoleARN",
911
- # description: "String",
912
- # resources: {
913
- # s3_resources: [
914
- # {
915
- # bucket_arn: "ResourceARN",
916
- # key_range: {
917
- # begin_marker: "String",
918
- # end_marker: "String",
919
- # },
920
- # },
921
- # ],
922
- # lambda_resources: [
923
- # {
924
- # lambda_arn: "ResourceARN",
925
- # event_triggers: [
926
- # {
927
- # event_resource_arn: "ResourceARN",
928
- # },
929
- # ],
930
- # },
931
- # ],
932
- # },
933
- # address_id: "AddressId",
934
- # shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
935
- # notification: {
936
- # sns_topic_arn: "SnsTopicARN",
937
- # job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
938
- # notify_all: false,
939
- # },
940
- # })
941
- # @overload update_cluster(params = {})
942
- # @param [Hash] params ({})
943
- def update_cluster(params = {}, options = {})
944
- req = build_request(:update_cluster, params)
945
- req.send_request(options)
946
- end
966
+ # Returns an array of `JobListEntry` objects of the specified length.
967
+ # Each `JobListEntry` object contains a job's state, a job's ID, and a
968
+ # value that indicates whether the job is a job part, in the case of
969
+ # export jobs. Calling this API action in one of the US regions will
970
+ # return jobs from the list of all jobs associated with this account in
971
+ # all US regions.
972
+ #
973
+ # @option params [Integer] :max_results
974
+ # The number of `JobListEntry` objects to return.
975
+ #
976
+ # @option params [String] :next_token
977
+ # HTTP requests are stateless. To identify what object comes "next" in
978
+ # the list of `JobListEntry` objects, you have the option of specifying
979
+ # `NextToken` as the starting point for your returned list.
980
+ #
981
+ # @return [Types::ListJobsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
982
+ #
983
+ # * {Types::ListJobsResult#job_list_entries #job_list_entries} => Array&lt;Types::JobListEntry&gt;
984
+ # * {Types::ListJobsResult#next_token #next_token} => String
985
+ #
986
+ # @example Request syntax with placeholder values
987
+ #
988
+ # resp = client.list_jobs({
989
+ # max_results: 1,
990
+ # next_token: "String",
991
+ # })
992
+ #
993
+ # @example Response structure
994
+ #
995
+ # resp.job_list_entries #=> Array
996
+ # resp.job_list_entries[0].job_id #=> String
997
+ # resp.job_list_entries[0].job_state #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
998
+ # resp.job_list_entries[0].is_master #=> Boolean
999
+ # resp.job_list_entries[0].job_type #=> String, one of "IMPORT", "EXPORT", "LOCAL_USE"
1000
+ # resp.job_list_entries[0].snowball_type #=> String, one of "STANDARD", "EDGE"
1001
+ # resp.job_list_entries[0].creation_date #=> Time
1002
+ # resp.job_list_entries[0].description #=> String
1003
+ # resp.next_token #=> String
1004
+ #
1005
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListJobs AWS API Documentation
1006
+ #
1007
+ # @overload list_jobs(params = {})
1008
+ # @param [Hash] params ({})
1009
+ def list_jobs(params = {}, options = {})
1010
+ req = build_request(:list_jobs, params)
1011
+ req.send_request(options)
1012
+ end
947
1013
 
948
- # While a job's `JobState` value is `New`, you can update some of the
949
- # information associated with a job. Once the job changes to a different
950
- # job state, usually within 60 minutes of the job being created, this
951
- # action is no longer available.
952
- # @option params [required, String] :job_id
953
- # The job ID of the job that you want to update, for example
954
- # `JID123e4567-e89b-12d3-a456-426655440000`.
955
- # @option params [String] :role_arn
956
- # The new role Amazon Resource Name (ARN) that you want to associate
957
- # with this job. To create a role ARN, use the [CreateRole][1] AWS
958
- # Identity and Access Management (IAM) API action.
959
- #
960
- #
961
- #
962
- # [1]: http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
963
- # @option params [Types::Notification] :notification
964
- # The new or updated Notification object.
965
- # @option params [Types::JobResource] :resources
966
- # The updated S3Resource object (for a single Amazon S3 bucket or key
967
- # range), or the updated JobResource object (for multiple buckets or key
968
- # ranges).
969
- # @option params [String] :address_id
970
- # The ID of the updated Address object.
971
- # @option params [String] :shipping_option
972
- # The updated shipping option value of this job's ShippingDetails
973
- # object.
974
- # @option params [String] :description
975
- # The updated description of this job's JobMetadata object.
976
- # @option params [String] :snowball_capacity_preference
977
- # The updated `SnowballCapacityPreference` of this job's JobMetadata
978
- # object. The 50 TB Snowballs are only available in the US regions.
979
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
980
- #
981
- # @example Request syntax with placeholder values
982
- # resp = client.update_job({
983
- # job_id: "JobId", # required
984
- # role_arn: "RoleARN",
985
- # notification: {
986
- # sns_topic_arn: "SnsTopicARN",
987
- # job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
988
- # notify_all: false,
989
- # },
990
- # resources: {
991
- # s3_resources: [
992
- # {
993
- # bucket_arn: "ResourceARN",
994
- # key_range: {
995
- # begin_marker: "String",
996
- # end_marker: "String",
997
- # },
998
- # },
999
- # ],
1000
- # lambda_resources: [
1001
- # {
1002
- # lambda_arn: "ResourceARN",
1003
- # event_triggers: [
1004
- # {
1005
- # event_resource_arn: "ResourceARN",
1006
- # },
1007
- # ],
1008
- # },
1009
- # ],
1010
- # },
1011
- # address_id: "AddressId",
1012
- # shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
1013
- # description: "String",
1014
- # snowball_capacity_preference: "T50", # accepts T50, T80, T100, NoPreference
1015
- # })
1016
- # @overload update_job(params = {})
1017
- # @param [Hash] params ({})
1018
- def update_job(params = {}, options = {})
1019
- req = build_request(:update_job, params)
1020
- req.send_request(options)
1021
- end
1014
+ # While a cluster's `ClusterState` value is in the `AwaitingQuorum`
1015
+ # state, you can update some of the information associated with a
1016
+ # cluster. Once the cluster changes to a different job state, usually 60
1017
+ # minutes after the cluster being created, this action is no longer
1018
+ # available.
1019
+ #
1020
+ # @option params [required, String] :cluster_id
1021
+ # The cluster ID of the cluster that you want to update, for example
1022
+ # `CID123e4567-e89b-12d3-a456-426655440000`.
1023
+ #
1024
+ # @option params [String] :role_arn
1025
+ # The new role Amazon Resource Name (ARN) that you want to associate
1026
+ # with this cluster. To create a role ARN, use the [CreateRole][1] API
1027
+ # action in AWS Identity and Access Management (IAM).
1028
+ #
1029
+ #
1030
+ #
1031
+ # [1]: http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
1032
+ #
1033
+ # @option params [String] :description
1034
+ # The updated description of this cluster.
1035
+ #
1036
+ # @option params [Types::JobResource] :resources
1037
+ # The updated arrays of JobResource objects that can include updated
1038
+ # S3Resource objects or LambdaResource objects.
1039
+ #
1040
+ # @option params [String] :address_id
1041
+ # The ID of the updated Address object.
1042
+ #
1043
+ # @option params [String] :shipping_option
1044
+ # The updated shipping option value of this cluster's ShippingDetails
1045
+ # object.
1046
+ #
1047
+ # @option params [Types::Notification] :notification
1048
+ # The new or updated Notification object.
1049
+ #
1050
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1051
+ #
1052
+ # @example Request syntax with placeholder values
1053
+ #
1054
+ # resp = client.update_cluster({
1055
+ # cluster_id: "ClusterId", # required
1056
+ # role_arn: "RoleARN",
1057
+ # description: "String",
1058
+ # resources: {
1059
+ # s3_resources: [
1060
+ # {
1061
+ # bucket_arn: "ResourceARN",
1062
+ # key_range: {
1063
+ # begin_marker: "String",
1064
+ # end_marker: "String",
1065
+ # },
1066
+ # },
1067
+ # ],
1068
+ # lambda_resources: [
1069
+ # {
1070
+ # lambda_arn: "ResourceARN",
1071
+ # event_triggers: [
1072
+ # {
1073
+ # event_resource_arn: "ResourceARN",
1074
+ # },
1075
+ # ],
1076
+ # },
1077
+ # ],
1078
+ # },
1079
+ # address_id: "AddressId",
1080
+ # shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
1081
+ # notification: {
1082
+ # sns_topic_arn: "SnsTopicARN",
1083
+ # job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
1084
+ # notify_all: false,
1085
+ # },
1086
+ # })
1087
+ #
1088
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateCluster AWS API Documentation
1089
+ #
1090
+ # @overload update_cluster(params = {})
1091
+ # @param [Hash] params ({})
1092
+ def update_cluster(params = {}, options = {})
1093
+ req = build_request(:update_cluster, params)
1094
+ req.send_request(options)
1095
+ end
1022
1096
 
1023
- # @!endgroup
1097
+ # While a job's `JobState` value is `New`, you can update some of the
1098
+ # information associated with a job. Once the job changes to a different
1099
+ # job state, usually within 60 minutes of the job being created, this
1100
+ # action is no longer available.
1101
+ #
1102
+ # @option params [required, String] :job_id
1103
+ # The job ID of the job that you want to update, for example
1104
+ # `JID123e4567-e89b-12d3-a456-426655440000`.
1105
+ #
1106
+ # @option params [String] :role_arn
1107
+ # The new role Amazon Resource Name (ARN) that you want to associate
1108
+ # with this job. To create a role ARN, use the [CreateRole][1] AWS
1109
+ # Identity and Access Management (IAM) API action.
1110
+ #
1111
+ #
1112
+ #
1113
+ # [1]: http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
1114
+ #
1115
+ # @option params [Types::Notification] :notification
1116
+ # The new or updated Notification object.
1117
+ #
1118
+ # @option params [Types::JobResource] :resources
1119
+ # The updated S3Resource object (for a single Amazon S3 bucket or key
1120
+ # range), or the updated JobResource object (for multiple buckets or key
1121
+ # ranges).
1122
+ #
1123
+ # @option params [String] :address_id
1124
+ # The ID of the updated Address object.
1125
+ #
1126
+ # @option params [String] :shipping_option
1127
+ # The updated shipping option value of this job's ShippingDetails
1128
+ # object.
1129
+ #
1130
+ # @option params [String] :description
1131
+ # The updated description of this job's JobMetadata object.
1132
+ #
1133
+ # @option params [String] :snowball_capacity_preference
1134
+ # The updated `SnowballCapacityPreference` of this job's JobMetadata
1135
+ # object. The 50 TB Snowballs are only available in the US regions.
1136
+ #
1137
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1138
+ #
1139
+ # @example Request syntax with placeholder values
1140
+ #
1141
+ # resp = client.update_job({
1142
+ # job_id: "JobId", # required
1143
+ # role_arn: "RoleARN",
1144
+ # notification: {
1145
+ # sns_topic_arn: "SnsTopicARN",
1146
+ # job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
1147
+ # notify_all: false,
1148
+ # },
1149
+ # resources: {
1150
+ # s3_resources: [
1151
+ # {
1152
+ # bucket_arn: "ResourceARN",
1153
+ # key_range: {
1154
+ # begin_marker: "String",
1155
+ # end_marker: "String",
1156
+ # },
1157
+ # },
1158
+ # ],
1159
+ # lambda_resources: [
1160
+ # {
1161
+ # lambda_arn: "ResourceARN",
1162
+ # event_triggers: [
1163
+ # {
1164
+ # event_resource_arn: "ResourceARN",
1165
+ # },
1166
+ # ],
1167
+ # },
1168
+ # ],
1169
+ # },
1170
+ # address_id: "AddressId",
1171
+ # shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
1172
+ # description: "String",
1173
+ # snowball_capacity_preference: "T50", # accepts T50, T80, T100, NoPreference
1174
+ # })
1175
+ #
1176
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateJob AWS API Documentation
1177
+ #
1178
+ # @overload update_job(params = {})
1179
+ # @param [Hash] params ({})
1180
+ def update_job(params = {}, options = {})
1181
+ req = build_request(:update_job, params)
1182
+ req.send_request(options)
1183
+ end
1024
1184
 
1025
- # @param params ({})
1026
- # @api private
1027
- def build_request(operation_name, params = {})
1028
- handlers = @handlers.for(operation_name)
1029
- context = Seahorse::Client::RequestContext.new(
1030
- operation_name: operation_name,
1031
- operation: config.api.operation(operation_name),
1032
- client: self,
1033
- params: params,
1034
- config: config)
1035
- context[:gem_name] = 'aws-sdk-snowball'
1036
- context[:gem_version] = '1.0.0.rc2'
1037
- Seahorse::Client::Request.new(handlers, context)
1038
- end
1185
+ # @!endgroup
1039
1186
 
1040
- # @api private
1041
- # @deprecated
1042
- def waiter_names
1043
- []
1044
- end
1187
+ # @param params ({})
1188
+ # @api private
1189
+ def build_request(operation_name, params = {})
1190
+ handlers = @handlers.for(operation_name)
1191
+ context = Seahorse::Client::RequestContext.new(
1192
+ operation_name: operation_name,
1193
+ operation: config.api.operation(operation_name),
1194
+ client: self,
1195
+ params: params,
1196
+ config: config)
1197
+ context[:gem_name] = 'aws-sdk-snowball'
1198
+ context[:gem_version] = '1.0.0.rc3'
1199
+ Seahorse::Client::Request.new(handlers, context)
1200
+ end
1045
1201
 
1046
- class << self
1202
+ # @api private
1203
+ # @deprecated
1204
+ def waiter_names
1205
+ []
1206
+ end
1047
1207
 
1048
- # @api private
1049
- attr_reader :identifier
1208
+ class << self
1050
1209
 
1051
- # @api private
1052
- def errors_module
1053
- Errors
1054
- end
1210
+ # @api private
1211
+ attr_reader :identifier
1055
1212
 
1213
+ # @api private
1214
+ def errors_module
1215
+ Errors
1056
1216
  end
1217
+
1057
1218
  end
1058
1219
  end
1059
1220
  end