aws-sdk-snowball 1.0.0.rc1 → 1.0.0.rc2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-snowball.rb +1 -1
- data/lib/aws-sdk-snowball/client.rb +394 -35
- data/lib/aws-sdk-snowball/client_api.rb +188 -5
- data/lib/aws-sdk-snowball/types.rb +621 -34
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1ef1d6308e89b2ff278920529638e830291302c3
|
4
|
+
data.tar.gz: d038a98c1c9498d11cbeec7c27bcd01107a15198
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cd47b466224e24f92845f6628ef12d33851253d2246d4df9cecdbf25db763a9215317d079f40a6187de01fa9109afcdbaa4580feed52ceae82d08e36c5a9bfbf
|
7
|
+
data.tar.gz: 8db5be0c3cc9d9a8d0f527b320db591de8282383f912dbe0d7576559c361ec37ce4d42353a1615fe09a2bc968334471480db8683ea8ed9a95d7c30398ce67f32
|
data/lib/aws-sdk-snowball.rb
CHANGED
@@ -139,12 +139,31 @@ module Aws
|
|
139
139
|
|
140
140
|
# @!group API Operations
|
141
141
|
|
142
|
-
# Cancels
|
143
|
-
#
|
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
|
160
|
+
|
161
|
+
# Cancels the specified job. You can only cancel a job before its
|
162
|
+
# `JobState` value changes to `PreparingAppliance`. Requesting the
|
144
163
|
# `ListJobs` or `DescribeJob` action will return a job's `JobState` as
|
145
164
|
# part of the response element data returned.
|
146
165
|
# @option params [required, String] :job_id
|
147
|
-
# The 39
|
166
|
+
# The 39-character job ID for the job that you want to cancel, for
|
148
167
|
# example `JID123e4567-e89b-12d3-a456-426655440000`.
|
149
168
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
150
169
|
#
|
@@ -198,13 +217,120 @@ module Aws
|
|
198
217
|
req.send_request(options)
|
199
218
|
end
|
200
219
|
|
201
|
-
# Creates
|
202
|
-
#
|
203
|
-
#
|
204
|
-
#
|
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.
|
205
224
|
# @option params [required, String] :job_type
|
206
|
-
#
|
225
|
+
# The type of job for this cluster. Currently, the only job type
|
226
|
+
# supported for clusters is `LOCAL_USE`.
|
207
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.>
|
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
|
324
|
+
|
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
|
208
334
|
# Defines the Amazon S3 buckets associated with this job.
|
209
335
|
#
|
210
336
|
# With `IMPORT` jobs, you specify the bucket or buckets that your
|
@@ -219,7 +345,7 @@ module Aws
|
|
219
345
|
# @option params [String] :description
|
220
346
|
# Defines an optional description of this specific job, for example
|
221
347
|
# `Important Photos 2016-08-11`.
|
222
|
-
# @option params [
|
348
|
+
# @option params [String] :address_id
|
223
349
|
# The ID for the address that you want the Snowball shipped to.
|
224
350
|
# @option params [String] :kms_key_arn
|
225
351
|
# The `KmsKeyARN` that you want to associate with this job. `KmsKeyARN`s
|
@@ -229,7 +355,7 @@ module Aws
|
|
229
355
|
#
|
230
356
|
#
|
231
357
|
# [1]: http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html
|
232
|
-
# @option params [
|
358
|
+
# @option params [String] :role_arn
|
233
359
|
# The `RoleARN` that you want to associate with this job. `RoleArn`s are
|
234
360
|
# created using the [CreateRole][1] AWS Identity and Access Management
|
235
361
|
# (IAM) API action.
|
@@ -241,11 +367,11 @@ module Aws
|
|
241
367
|
# If your job is being created in one of the US regions, you have the
|
242
368
|
# option of specifying what size Snowball you'd like for this job. In
|
243
369
|
# all other regions, Snowballs come with 80 TB in storage capacity.
|
244
|
-
# @option params [
|
245
|
-
# The shipping speed for this job.
|
246
|
-
#
|
247
|
-
#
|
248
|
-
#
|
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:
|
249
375
|
#
|
250
376
|
# * In Australia, you have access to express shipping. Typically,
|
251
377
|
# Snowballs shipped express are delivered in about a day.
|
@@ -261,14 +387,21 @@ module Aws
|
|
261
387
|
# @option params [Types::Notification] :notification
|
262
388
|
# Defines the Amazon Simple Notification Service (Amazon SNS)
|
263
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`.
|
264
397
|
# @return [Types::CreateJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
265
398
|
#
|
266
399
|
# * {Types::CreateJobResult#job_id #JobId} => String
|
267
400
|
#
|
268
401
|
# @example Request syntax with placeholder values
|
269
402
|
# resp = client.create_job({
|
270
|
-
# job_type: "IMPORT", #
|
271
|
-
# resources: {
|
403
|
+
# job_type: "IMPORT", # accepts IMPORT, EXPORT, LOCAL_USE
|
404
|
+
# resources: {
|
272
405
|
# s3_resources: [
|
273
406
|
# {
|
274
407
|
# bucket_arn: "ResourceARN",
|
@@ -278,18 +411,30 @@ module Aws
|
|
278
411
|
# },
|
279
412
|
# },
|
280
413
|
# ],
|
414
|
+
# lambda_resources: [
|
415
|
+
# {
|
416
|
+
# lambda_arn: "ResourceARN",
|
417
|
+
# event_triggers: [
|
418
|
+
# {
|
419
|
+
# event_resource_arn: "ResourceARN",
|
420
|
+
# },
|
421
|
+
# ],
|
422
|
+
# },
|
423
|
+
# ],
|
281
424
|
# },
|
282
425
|
# description: "String",
|
283
|
-
# address_id: "AddressId",
|
426
|
+
# address_id: "AddressId",
|
284
427
|
# kms_key_arn: "KmsKeyARN",
|
285
|
-
# role_arn: "RoleARN",
|
286
|
-
# snowball_capacity_preference: "T50", # accepts T50, T80, NoPreference
|
287
|
-
# shipping_option: "SECOND_DAY", #
|
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
|
288
431
|
# notification: {
|
289
432
|
# sns_topic_arn: "SnsTopicARN",
|
290
433
|
# job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
|
291
434
|
# notify_all: false,
|
292
435
|
# },
|
436
|
+
# cluster_id: "ClusterId",
|
437
|
+
# snowball_type: "STANDARD", # accepts STANDARD, EDGE
|
293
438
|
# })
|
294
439
|
#
|
295
440
|
# @example Response structure
|
@@ -379,8 +524,51 @@ module Aws
|
|
379
524
|
req.send_request(options)
|
380
525
|
end
|
381
526
|
|
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
|
569
|
+
|
382
570
|
# Returns information about a specific job including shipping
|
383
|
-
# information, job status, and other important metadata.
|
571
|
+
# information, job status, and other important metadata. .
|
384
572
|
# @option params [required, String] :job_id
|
385
573
|
# The automatically generated ID for a job, for example
|
386
574
|
# `JID123e4567-e89b-12d3-a456-426655440000`.
|
@@ -397,12 +585,17 @@ module Aws
|
|
397
585
|
# @example Response structure
|
398
586
|
# resp.job_metadata.job_id #=> String
|
399
587
|
# resp.job_metadata.job_state #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
|
400
|
-
# resp.job_metadata.job_type #=> String, one of "IMPORT", "EXPORT"
|
588
|
+
# resp.job_metadata.job_type #=> String, one of "IMPORT", "EXPORT", "LOCAL_USE"
|
589
|
+
# resp.job_metadata.snowball_type #=> String, one of "STANDARD", "EDGE"
|
401
590
|
# resp.job_metadata.creation_date #=> Time
|
402
591
|
# resp.job_metadata.resources.s3_resources #=> Array
|
403
592
|
# resp.job_metadata.resources.s3_resources[0].bucket_arn #=> String
|
404
593
|
# resp.job_metadata.resources.s3_resources[0].key_range.begin_marker #=> String
|
405
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
|
406
599
|
# resp.job_metadata.description #=> String
|
407
600
|
# resp.job_metadata.kms_key_arn #=> String
|
408
601
|
# resp.job_metadata.role_arn #=> String
|
@@ -412,7 +605,7 @@ module Aws
|
|
412
605
|
# resp.job_metadata.shipping_details.inbound_shipment.tracking_number #=> String
|
413
606
|
# resp.job_metadata.shipping_details.outbound_shipment.status #=> String
|
414
607
|
# resp.job_metadata.shipping_details.outbound_shipment.tracking_number #=> String
|
415
|
-
# resp.job_metadata.snowball_capacity_preference #=> String, one of "T50", "T80", "NoPreference"
|
608
|
+
# resp.job_metadata.snowball_capacity_preference #=> String, one of "T50", "T80", "T100", "NoPreference"
|
416
609
|
# resp.job_metadata.notification.sns_topic_arn #=> String
|
417
610
|
# resp.job_metadata.notification.job_states_to_notify #=> Array
|
418
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"
|
@@ -424,15 +617,21 @@ module Aws
|
|
424
617
|
# resp.job_metadata.job_log_info.job_completion_report_uri #=> String
|
425
618
|
# resp.job_metadata.job_log_info.job_success_log_uri #=> String
|
426
619
|
# resp.job_metadata.job_log_info.job_failure_log_uri #=> String
|
620
|
+
# resp.job_metadata.cluster_id #=> String
|
427
621
|
# resp.sub_job_metadata #=> Array
|
428
622
|
# resp.sub_job_metadata[0].job_id #=> String
|
429
623
|
# resp.sub_job_metadata[0].job_state #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
|
430
|
-
# resp.sub_job_metadata[0].job_type #=> String, one of "IMPORT", "EXPORT"
|
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"
|
431
626
|
# resp.sub_job_metadata[0].creation_date #=> Time
|
432
627
|
# resp.sub_job_metadata[0].resources.s3_resources #=> Array
|
433
628
|
# resp.sub_job_metadata[0].resources.s3_resources[0].bucket_arn #=> String
|
434
629
|
# resp.sub_job_metadata[0].resources.s3_resources[0].key_range.begin_marker #=> String
|
435
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
|
436
635
|
# resp.sub_job_metadata[0].description #=> String
|
437
636
|
# resp.sub_job_metadata[0].kms_key_arn #=> String
|
438
637
|
# resp.sub_job_metadata[0].role_arn #=> String
|
@@ -442,7 +641,7 @@ module Aws
|
|
442
641
|
# resp.sub_job_metadata[0].shipping_details.inbound_shipment.tracking_number #=> String
|
443
642
|
# resp.sub_job_metadata[0].shipping_details.outbound_shipment.status #=> String
|
444
643
|
# resp.sub_job_metadata[0].shipping_details.outbound_shipment.tracking_number #=> String
|
445
|
-
# resp.sub_job_metadata[0].snowball_capacity_preference #=> String, one of "T50", "T80", "NoPreference"
|
644
|
+
# resp.sub_job_metadata[0].snowball_capacity_preference #=> String, one of "T50", "T80", "T100", "NoPreference"
|
446
645
|
# resp.sub_job_metadata[0].notification.sns_topic_arn #=> String
|
447
646
|
# resp.sub_job_metadata[0].notification.job_states_to_notify #=> Array
|
448
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"
|
@@ -454,6 +653,7 @@ module Aws
|
|
454
653
|
# resp.sub_job_metadata[0].job_log_info.job_completion_report_uri #=> String
|
455
654
|
# resp.sub_job_metadata[0].job_log_info.job_success_log_uri #=> String
|
456
655
|
# resp.sub_job_metadata[0].job_log_info.job_failure_log_uri #=> String
|
656
|
+
# resp.sub_job_metadata[0].cluster_id #=> String
|
457
657
|
# @overload describe_job(params = {})
|
458
658
|
# @param [Hash] params ({})
|
459
659
|
def describe_job(params = {}, options = {})
|
@@ -478,8 +678,8 @@ module Aws
|
|
478
678
|
# job. Saving these separately helps prevent unauthorized parties from
|
479
679
|
# gaining access to the Snowball associated with that job.
|
480
680
|
#
|
481
|
-
#
|
482
|
-
#
|
681
|
+
# The credentials of a given job, including its manifest file and unlock
|
682
|
+
# code, expire 90 days after the job is created.
|
483
683
|
# @option params [required, String] :job_id
|
484
684
|
# The ID for a job that you want to get the manifest file for, for
|
485
685
|
# example `JID123e4567-e89b-12d3-a456-426655440000`.
|
@@ -538,9 +738,9 @@ module Aws
|
|
538
738
|
# Returns information about the Snowball service limit for your account,
|
539
739
|
# and also the number of Snowballs your account has in use.
|
540
740
|
#
|
541
|
-
#
|
542
|
-
#
|
543
|
-
#
|
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.
|
544
744
|
# @return [Types::GetSnowballUsageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
545
745
|
#
|
546
746
|
# * {Types::GetSnowballUsageResult#snowball_limit #SnowballLimit} => Integer
|
@@ -559,6 +759,81 @@ module Aws
|
|
559
759
|
req.send_request(options)
|
560
760
|
end
|
561
761
|
|
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<Types::JobListEntry>
|
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
|
802
|
+
|
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<Types::ClusterListEntry>
|
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
|
836
|
+
|
562
837
|
# Returns an array of `JobListEntry` objects of the specified length.
|
563
838
|
# Each `JobListEntry` object contains a job's state, a job's ID, and a
|
564
839
|
# value that indicates whether the job is a job part, in the case of
|
@@ -587,6 +862,10 @@ module Aws
|
|
587
862
|
# resp.job_list_entries[0].job_id #=> String
|
588
863
|
# resp.job_list_entries[0].job_state #=> String, one of "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending"
|
589
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
|
590
869
|
# resp.next_token #=> String
|
591
870
|
# @overload list_jobs(params = {})
|
592
871
|
# @param [Hash] params ({})
|
@@ -595,6 +874,77 @@ module Aws
|
|
595
874
|
req.send_request(options)
|
596
875
|
end
|
597
876
|
|
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
|
947
|
+
|
598
948
|
# While a job's `JobState` value is `New`, you can update some of the
|
599
949
|
# information associated with a job. Once the job changes to a different
|
600
950
|
# job state, usually within 60 minutes of the job being created, this
|
@@ -625,8 +975,7 @@ module Aws
|
|
625
975
|
# The updated description of this job's JobMetadata object.
|
626
976
|
# @option params [String] :snowball_capacity_preference
|
627
977
|
# The updated `SnowballCapacityPreference` of this job's JobMetadata
|
628
|
-
# object.
|
629
|
-
# regions.
|
978
|
+
# object. The 50 TB Snowballs are only available in the US regions.
|
630
979
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
631
980
|
#
|
632
981
|
# @example Request syntax with placeholder values
|
@@ -648,11 +997,21 @@ module Aws
|
|
648
997
|
# },
|
649
998
|
# },
|
650
999
|
# ],
|
1000
|
+
# lambda_resources: [
|
1001
|
+
# {
|
1002
|
+
# lambda_arn: "ResourceARN",
|
1003
|
+
# event_triggers: [
|
1004
|
+
# {
|
1005
|
+
# event_resource_arn: "ResourceARN",
|
1006
|
+
# },
|
1007
|
+
# ],
|
1008
|
+
# },
|
1009
|
+
# ],
|
651
1010
|
# },
|
652
1011
|
# address_id: "AddressId",
|
653
1012
|
# shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
|
654
1013
|
# description: "String",
|
655
|
-
# snowball_capacity_preference: "T50", # accepts T50, T80, NoPreference
|
1014
|
+
# snowball_capacity_preference: "T50", # accepts T50, T80, T100, NoPreference
|
656
1015
|
# })
|
657
1016
|
# @overload update_job(params = {})
|
658
1017
|
# @param [Hash] params ({})
|
@@ -674,7 +1033,7 @@ module Aws
|
|
674
1033
|
params: params,
|
675
1034
|
config: config)
|
676
1035
|
context[:gem_name] = 'aws-sdk-snowball'
|
677
|
-
context[:gem_version] = '1.0.0.
|
1036
|
+
context[:gem_version] = '1.0.0.rc2'
|
678
1037
|
Seahorse::Client::Request.new(handlers, context)
|
679
1038
|
end
|
680
1039
|
|