aws-sdk-snowball 1.31.0 → 1.36.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-snowball.rb +3 -2
- data/lib/aws-sdk-snowball/client.rb +168 -50
- data/lib/aws-sdk-snowball/client_api.rb +71 -0
- data/lib/aws-sdk-snowball/errors.rb +37 -0
- data/lib/aws-sdk-snowball/types.rb +245 -95
- metadata +4 -4
@@ -28,6 +28,7 @@ module Aws::Snowball
|
|
28
28
|
#
|
29
29
|
# ## Error Classes
|
30
30
|
# * {ClusterLimitExceededException}
|
31
|
+
# * {ConflictException}
|
31
32
|
# * {Ec2RequestFailedException}
|
32
33
|
# * {InvalidAddressException}
|
33
34
|
# * {InvalidInputCombinationException}
|
@@ -35,6 +36,7 @@ module Aws::Snowball
|
|
35
36
|
# * {InvalidNextTokenException}
|
36
37
|
# * {InvalidResourceException}
|
37
38
|
# * {KMSRequestFailedException}
|
39
|
+
# * {ReturnShippingLabelAlreadyExistsException}
|
38
40
|
# * {UnsupportedAddressException}
|
39
41
|
#
|
40
42
|
# Additionally, error classes are dynamically generated for service errors based on the error code
|
@@ -58,6 +60,26 @@ module Aws::Snowball
|
|
58
60
|
end
|
59
61
|
end
|
60
62
|
|
63
|
+
class ConflictException < ServiceError
|
64
|
+
|
65
|
+
# @param [Seahorse::Client::RequestContext] context
|
66
|
+
# @param [String] message
|
67
|
+
# @param [Aws::Snowball::Types::ConflictException] data
|
68
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
69
|
+
super(context, message, data)
|
70
|
+
end
|
71
|
+
|
72
|
+
# @return [String]
|
73
|
+
def conflict_resource
|
74
|
+
@data[:conflict_resource]
|
75
|
+
end
|
76
|
+
|
77
|
+
# @return [String]
|
78
|
+
def message
|
79
|
+
@message || @data[:message]
|
80
|
+
end
|
81
|
+
end
|
82
|
+
|
61
83
|
class Ec2RequestFailedException < ServiceError
|
62
84
|
|
63
85
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -168,6 +190,21 @@ module Aws::Snowball
|
|
168
190
|
end
|
169
191
|
end
|
170
192
|
|
193
|
+
class ReturnShippingLabelAlreadyExistsException < ServiceError
|
194
|
+
|
195
|
+
# @param [Seahorse::Client::RequestContext] context
|
196
|
+
# @param [String] message
|
197
|
+
# @param [Aws::Snowball::Types::ReturnShippingLabelAlreadyExistsException] data
|
198
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
199
|
+
super(context, message, data)
|
200
|
+
end
|
201
|
+
|
202
|
+
# @return [String]
|
203
|
+
def message
|
204
|
+
@message || @data[:message]
|
205
|
+
end
|
206
|
+
end
|
207
|
+
|
171
208
|
class UnsupportedAddressException < ServiceError
|
172
209
|
|
173
210
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -10,7 +10,7 @@
|
|
10
10
|
module Aws::Snowball
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# The address that you want the
|
13
|
+
# The address that you want the Snow device(s) associated with a
|
14
14
|
# specific job to be shipped to. Addresses are validated at the time of
|
15
15
|
# creation. The address you provide must be located within the
|
16
16
|
# serviceable area of your region. Although no individual elements of
|
@@ -42,34 +42,34 @@ module Aws::Snowball
|
|
42
42
|
# @return [String]
|
43
43
|
#
|
44
44
|
# @!attribute [rw] name
|
45
|
-
# The name of a person to receive a
|
45
|
+
# The name of a person to receive a Snow device at an address.
|
46
46
|
# @return [String]
|
47
47
|
#
|
48
48
|
# @!attribute [rw] company
|
49
|
-
# The name of the company to receive a
|
49
|
+
# The name of the company to receive a Snow device at an address.
|
50
50
|
# @return [String]
|
51
51
|
#
|
52
52
|
# @!attribute [rw] street_1
|
53
|
-
# The first line in a street address that a
|
53
|
+
# The first line in a street address that a Snow device is to be
|
54
54
|
# delivered to.
|
55
55
|
# @return [String]
|
56
56
|
#
|
57
57
|
# @!attribute [rw] street_2
|
58
|
-
# The second line in a street address that a
|
58
|
+
# The second line in a street address that a Snow device is to be
|
59
59
|
# delivered to.
|
60
60
|
# @return [String]
|
61
61
|
#
|
62
62
|
# @!attribute [rw] street_3
|
63
|
-
# The third line in a street address that a
|
63
|
+
# The third line in a street address that a Snow device is to be
|
64
64
|
# delivered to.
|
65
65
|
# @return [String]
|
66
66
|
#
|
67
67
|
# @!attribute [rw] city
|
68
|
-
# The city in an address that a
|
68
|
+
# The city in an address that a Snow device is to be delivered to.
|
69
69
|
# @return [String]
|
70
70
|
#
|
71
71
|
# @!attribute [rw] state_or_province
|
72
|
-
# The state or province in an address that a
|
72
|
+
# The state or province in an address that a Snow device is to be
|
73
73
|
# delivered to.
|
74
74
|
# @return [String]
|
75
75
|
#
|
@@ -82,16 +82,17 @@ module Aws::Snowball
|
|
82
82
|
# @return [String]
|
83
83
|
#
|
84
84
|
# @!attribute [rw] country
|
85
|
-
# The country in an address that a
|
85
|
+
# The country in an address that a Snow device is to be delivered to.
|
86
86
|
# @return [String]
|
87
87
|
#
|
88
88
|
# @!attribute [rw] postal_code
|
89
|
-
# The postal code in an address that a
|
89
|
+
# The postal code in an address that a Snow device is to be delivered
|
90
|
+
# to.
|
90
91
|
# @return [String]
|
91
92
|
#
|
92
93
|
# @!attribute [rw] phone_number
|
93
|
-
# The phone number associated with an address that a
|
94
|
-
# delivered to.
|
94
|
+
# The phone number associated with an address that a Snow device is to
|
95
|
+
# be delivered to.
|
95
96
|
# @return [String]
|
96
97
|
#
|
97
98
|
# @!attribute [rw] is_restricted
|
@@ -257,9 +258,9 @@ module Aws::Snowball
|
|
257
258
|
# @return [String]
|
258
259
|
#
|
259
260
|
# @!attribute [rw] snowball_type
|
260
|
-
# The type of AWS
|
261
|
+
# The type of AWS Snow device to use for this cluster.
|
261
262
|
#
|
262
|
-
# <note markdown="1"> For cluster jobs, AWS
|
263
|
+
# <note markdown="1"> For cluster jobs, AWS Snow Family currently supports only the `EDGE`
|
263
264
|
# device type.
|
264
265
|
#
|
265
266
|
# </note>
|
@@ -280,20 +281,19 @@ module Aws::Snowball
|
|
280
281
|
#
|
281
282
|
# @!attribute [rw] shipping_option
|
282
283
|
# The shipping speed for each node in this cluster. This speed
|
283
|
-
# doesn't dictate how soon you'll get each
|
284
|
-
#
|
285
|
-
#
|
286
|
-
# follows:
|
284
|
+
# doesn't dictate how soon you'll get each device, rather it
|
285
|
+
# represents how quickly each device moves to its destination while in
|
286
|
+
# transit. Regional shipping speeds are as follows:
|
287
287
|
#
|
288
288
|
# * In Australia, you have access to express shipping. Typically,
|
289
289
|
# devices shipped express are delivered in about a day.
|
290
290
|
#
|
291
291
|
# * In the European Union (EU), you have access to express shipping.
|
292
|
-
# Typically,
|
292
|
+
# Typically, Snow devices shipped express are delivered in about a
|
293
293
|
# day. In addition, most countries in the EU have access to standard
|
294
294
|
# shipping, which typically takes less than a week, one way.
|
295
295
|
#
|
296
|
-
# * In India,
|
296
|
+
# * In India, Snow devices are delivered in one to seven days.
|
297
297
|
#
|
298
298
|
# * In the US, you have access to one-day shipping and two-day
|
299
299
|
# shipping.
|
@@ -336,12 +336,12 @@ module Aws::Snowball
|
|
336
336
|
end
|
337
337
|
|
338
338
|
# A JSON-formatted object that describes a compatible Amazon Machine
|
339
|
-
# Image (AMI), including the ID and name for a
|
340
|
-
#
|
341
|
-
#
|
339
|
+
# Image (AMI), including the ID and name for a Snow device AMI. This AMI
|
340
|
+
# is compatible with the device's physical hardware requirements, and
|
341
|
+
# it should be able to be run in an SBE1 instance on the device.
|
342
342
|
#
|
343
343
|
# @!attribute [rw] ami_id
|
344
|
-
# The unique identifier for an individual
|
344
|
+
# The unique identifier for an individual Snow device AMI.
|
345
345
|
# @return [String]
|
346
346
|
#
|
347
347
|
# @!attribute [rw] name
|
@@ -357,6 +357,24 @@ module Aws::Snowball
|
|
357
357
|
include Aws::Structure
|
358
358
|
end
|
359
359
|
|
360
|
+
# You get this exception when you call `CreateReturnShippingLabel` more
|
361
|
+
# than once when other requests are not completed.
|
362
|
+
#
|
363
|
+
# @!attribute [rw] conflict_resource
|
364
|
+
# @return [String]
|
365
|
+
#
|
366
|
+
# @!attribute [rw] message
|
367
|
+
# @return [String]
|
368
|
+
#
|
369
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ConflictException AWS API Documentation
|
370
|
+
#
|
371
|
+
class ConflictException < Struct.new(
|
372
|
+
:conflict_resource,
|
373
|
+
:message)
|
374
|
+
SENSITIVE = []
|
375
|
+
include Aws::Structure
|
376
|
+
end
|
377
|
+
|
360
378
|
# @note When making an API call, you may pass CreateAddressRequest
|
361
379
|
# data as a hash:
|
362
380
|
#
|
@@ -380,7 +398,7 @@ module Aws::Snowball
|
|
380
398
|
# }
|
381
399
|
#
|
382
400
|
# @!attribute [rw] address
|
383
|
-
# The address that you want the
|
401
|
+
# The address that you want the Snow device shipped to.
|
384
402
|
# @return [Types::Address]
|
385
403
|
#
|
386
404
|
# @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateAddressRequest AWS API Documentation
|
@@ -394,7 +412,7 @@ module Aws::Snowball
|
|
394
412
|
# @!attribute [rw] address_id
|
395
413
|
# The automatically generated ID for a specific address. You'll use
|
396
414
|
# this ID when you create a job to specify which address you want the
|
397
|
-
#
|
415
|
+
# Snow device for that job shipped to.
|
398
416
|
# @return [String]
|
399
417
|
#
|
400
418
|
# @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateAddressResult AWS API Documentation
|
@@ -497,9 +515,9 @@ module Aws::Snowball
|
|
497
515
|
# @return [String]
|
498
516
|
#
|
499
517
|
# @!attribute [rw] snowball_type
|
500
|
-
# The type of AWS
|
518
|
+
# The type of AWS Snow Family device to use for this cluster.
|
501
519
|
#
|
502
|
-
# <note markdown="1"> For cluster jobs, AWS
|
520
|
+
# <note markdown="1"> For cluster jobs, AWS Snow Family currently supports only the `EDGE`
|
503
521
|
# device type.
|
504
522
|
#
|
505
523
|
# </note>
|
@@ -512,15 +530,15 @@ module Aws::Snowball
|
|
512
530
|
# destination while in transit. Regional shipping speeds are as
|
513
531
|
# follows:
|
514
532
|
#
|
515
|
-
# * In Australia, you have access to express shipping. Typically,
|
516
|
-
#
|
533
|
+
# * In Australia, you have access to express shipping. Typically, Snow
|
534
|
+
# devices shipped express are delivered in about a day.
|
517
535
|
#
|
518
536
|
# * In the European Union (EU), you have access to express shipping.
|
519
|
-
# Typically,
|
520
|
-
# In addition, most countries in the EU have access to standard
|
537
|
+
# Typically, Snow devices shipped express are delivered in about a
|
538
|
+
# day. In addition, most countries in the EU have access to standard
|
521
539
|
# shipping, which typically takes less than a week, one way.
|
522
540
|
#
|
523
|
-
# * In India,
|
541
|
+
# * In India, Snow device are delivered in one to seven days.
|
524
542
|
#
|
525
543
|
# * In the United States of America (US), you have access to one-day
|
526
544
|
# shipping and two-day shipping.
|
@@ -530,11 +548,11 @@ module Aws::Snowball
|
|
530
548
|
# devices shipped express are delivered in about a day.
|
531
549
|
#
|
532
550
|
# * In the European Union (EU), you have access to express shipping.
|
533
|
-
# Typically,
|
551
|
+
# Typically, Snow devices shipped express are delivered in about a
|
534
552
|
# day. In addition, most countries in the EU have access to standard
|
535
553
|
# shipping, which typically takes less than a week, one way.
|
536
554
|
#
|
537
|
-
# * In India,
|
555
|
+
# * In India, Snow device are delivered in one to seven days.
|
538
556
|
#
|
539
557
|
# * In the US, you have access to one-day shipping and two-day
|
540
558
|
# shipping.
|
@@ -668,7 +686,7 @@ module Aws::Snowball
|
|
668
686
|
# @return [String]
|
669
687
|
#
|
670
688
|
# @!attribute [rw] address_id
|
671
|
-
# The ID for the address that you want the
|
689
|
+
# The ID for the address that you want the Snow device shipped to.
|
672
690
|
# @return [String]
|
673
691
|
#
|
674
692
|
# @!attribute [rw] kms_key_arn
|
@@ -693,25 +711,25 @@ module Aws::Snowball
|
|
693
711
|
#
|
694
712
|
# @!attribute [rw] snowball_capacity_preference
|
695
713
|
# If your job is being created in one of the US regions, you have the
|
696
|
-
# option of specifying what size
|
697
|
-
# all other regions, Snowballs come with 80 TB in storage capacity.
|
714
|
+
# option of specifying what size Snow device you'd like for this job.
|
715
|
+
# In all other regions, Snowballs come with 80 TB in storage capacity.
|
698
716
|
# @return [String]
|
699
717
|
#
|
700
718
|
# @!attribute [rw] shipping_option
|
701
719
|
# The shipping speed for this job. This speed doesn't dictate how
|
702
|
-
# soon you'll get the
|
703
|
-
#
|
720
|
+
# soon you'll get the Snow device, rather it represents how quickly
|
721
|
+
# the Snow device moves to its destination while in transit. Regional
|
704
722
|
# shipping speeds are as follows:
|
705
723
|
#
|
706
|
-
# * In Australia, you have access to express shipping. Typically,
|
707
|
-
#
|
724
|
+
# * In Australia, you have access to express shipping. Typically, Snow
|
725
|
+
# devices shipped express are delivered in about a day.
|
708
726
|
#
|
709
727
|
# * In the European Union (EU), you have access to express shipping.
|
710
|
-
# Typically,
|
711
|
-
# In addition, most countries in the EU have access to standard
|
728
|
+
# Typically, Snow devices shipped express are delivered in about a
|
729
|
+
# day. In addition, most countries in the EU have access to standard
|
712
730
|
# shipping, which typically takes less than a week, one way.
|
713
731
|
#
|
714
|
-
# * In India,
|
732
|
+
# * In India, Snow devices are delivered in one to seven days.
|
715
733
|
#
|
716
734
|
# * In the US, you have access to one-day shipping and two-day
|
717
735
|
# shipping.
|
@@ -729,15 +747,15 @@ module Aws::Snowball
|
|
729
747
|
# @return [String]
|
730
748
|
#
|
731
749
|
# @!attribute [rw] snowball_type
|
732
|
-
# The type of AWS
|
750
|
+
# The type of AWS Snow Family device to use for this job.
|
733
751
|
#
|
734
|
-
# <note markdown="1"> For cluster jobs, AWS
|
752
|
+
# <note markdown="1"> For cluster jobs, AWS Snow Family currently supports only the `EDGE`
|
735
753
|
# device type.
|
736
754
|
#
|
737
755
|
# </note>
|
738
756
|
#
|
739
|
-
# The type of AWS
|
740
|
-
#
|
757
|
+
# The type of AWS Snow device to use for this job. Currently, the only
|
758
|
+
# supported device type for cluster jobs is `EDGE`.
|
741
759
|
#
|
742
760
|
# For more information, see [Snowball Edge Device Options][1] in the
|
743
761
|
# Snowball Edge Developer Guide.
|
@@ -794,26 +812,69 @@ module Aws::Snowball
|
|
794
812
|
include Aws::Structure
|
795
813
|
end
|
796
814
|
|
797
|
-
#
|
798
|
-
#
|
815
|
+
# @note When making an API call, you may pass CreateReturnShippingLabelRequest
|
816
|
+
# data as a hash:
|
817
|
+
#
|
818
|
+
# {
|
819
|
+
# job_id: "JobId", # required
|
820
|
+
# shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
|
821
|
+
# }
|
822
|
+
#
|
823
|
+
# @!attribute [rw] job_id
|
824
|
+
# The ID for a job that you want to create the return shipping label
|
825
|
+
# for. For example `JID123e4567-e89b-12d3-a456-426655440000`.
|
826
|
+
# @return [String]
|
827
|
+
#
|
828
|
+
# @!attribute [rw] shipping_option
|
829
|
+
# The shipping speed for a particular job. This speed doesn't dictate
|
830
|
+
# how soon the device is returned to AWS. This speed represents how
|
831
|
+
# quickly it moves to its destination while in transit. Regional
|
832
|
+
# shipping speeds are as follows:
|
833
|
+
# @return [String]
|
834
|
+
#
|
835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateReturnShippingLabelRequest AWS API Documentation
|
836
|
+
#
|
837
|
+
class CreateReturnShippingLabelRequest < Struct.new(
|
838
|
+
:job_id,
|
839
|
+
:shipping_option)
|
840
|
+
SENSITIVE = []
|
841
|
+
include Aws::Structure
|
842
|
+
end
|
843
|
+
|
844
|
+
# @!attribute [rw] status
|
845
|
+
# The status information of the task on a Snow device that is being
|
846
|
+
# returned to AWS.
|
847
|
+
# @return [String]
|
848
|
+
#
|
849
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateReturnShippingLabelResult AWS API Documentation
|
850
|
+
#
|
851
|
+
class CreateReturnShippingLabelResult < Struct.new(
|
852
|
+
:status)
|
853
|
+
SENSITIVE = []
|
854
|
+
include Aws::Structure
|
855
|
+
end
|
856
|
+
|
857
|
+
# Defines the real-time status of a Snow device's data transfer while
|
858
|
+
# the device is at AWS. This data is only available while a job has a
|
799
859
|
# `JobState` value of `InProgress`, for both import and export jobs.
|
800
860
|
#
|
801
861
|
# @!attribute [rw] bytes_transferred
|
802
|
-
# The number of bytes transferred between a
|
862
|
+
# The number of bytes transferred between a Snow device and Amazon S3.
|
803
863
|
# @return [Integer]
|
804
864
|
#
|
805
865
|
# @!attribute [rw] objects_transferred
|
806
|
-
# The number of objects transferred between a
|
866
|
+
# The number of objects transferred between a Snow device and Amazon
|
867
|
+
# S3.
|
807
868
|
# @return [Integer]
|
808
869
|
#
|
809
870
|
# @!attribute [rw] total_bytes
|
810
|
-
# The total bytes of data for a transfer between a
|
811
|
-
# S3. This value is set to 0 (zero) until all the keys that
|
812
|
-
# transferred have been listed.
|
871
|
+
# The total bytes of data for a transfer between a Snow device and
|
872
|
+
# Amazon S3. This value is set to 0 (zero) until all the keys that
|
873
|
+
# will be transferred have been listed.
|
813
874
|
# @return [Integer]
|
814
875
|
#
|
815
876
|
# @!attribute [rw] total_objects
|
816
|
-
# The total number of objects for a transfer between a
|
877
|
+
# The total number of objects for a transfer between a Snow device and
|
817
878
|
# Amazon S3. This value is set to 0 (zero) until all the keys that
|
818
879
|
# will be transferred have been listed.
|
819
880
|
# @return [Integer]
|
@@ -849,8 +910,8 @@ module Aws::Snowball
|
|
849
910
|
end
|
850
911
|
|
851
912
|
# @!attribute [rw] address
|
852
|
-
# The address that you want the
|
853
|
-
#
|
913
|
+
# The address that you want the Snow device(s) associated with a
|
914
|
+
# specific job to be shipped to.
|
854
915
|
# @return [Types::Address]
|
855
916
|
#
|
856
917
|
# @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddressResult AWS API Documentation
|
@@ -890,7 +951,8 @@ module Aws::Snowball
|
|
890
951
|
end
|
891
952
|
|
892
953
|
# @!attribute [rw] addresses
|
893
|
-
# The
|
954
|
+
# The Snow device shipping addresses that were created for this
|
955
|
+
# account.
|
894
956
|
# @return [Array<Types::Address>]
|
895
957
|
#
|
896
958
|
# @!attribute [rw] next_token
|
@@ -980,6 +1042,44 @@ module Aws::Snowball
|
|
980
1042
|
include Aws::Structure
|
981
1043
|
end
|
982
1044
|
|
1045
|
+
# @note When making an API call, you may pass DescribeReturnShippingLabelRequest
|
1046
|
+
# data as a hash:
|
1047
|
+
#
|
1048
|
+
# {
|
1049
|
+
# job_id: "JobId",
|
1050
|
+
# }
|
1051
|
+
#
|
1052
|
+
# @!attribute [rw] job_id
|
1053
|
+
# The automatically generated ID for a job, for example
|
1054
|
+
# `JID123e4567-e89b-12d3-a456-426655440000`.
|
1055
|
+
# @return [String]
|
1056
|
+
#
|
1057
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeReturnShippingLabelRequest AWS API Documentation
|
1058
|
+
#
|
1059
|
+
class DescribeReturnShippingLabelRequest < Struct.new(
|
1060
|
+
:job_id)
|
1061
|
+
SENSITIVE = []
|
1062
|
+
include Aws::Structure
|
1063
|
+
end
|
1064
|
+
|
1065
|
+
# @!attribute [rw] status
|
1066
|
+
# The status information of the task on a Snow device that is being
|
1067
|
+
# returned to AWS.
|
1068
|
+
# @return [String]
|
1069
|
+
#
|
1070
|
+
# @!attribute [rw] expiration_date
|
1071
|
+
# The expiration date of the current return shipping label.
|
1072
|
+
# @return [Time]
|
1073
|
+
#
|
1074
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeReturnShippingLabelResult AWS API Documentation
|
1075
|
+
#
|
1076
|
+
class DescribeReturnShippingLabelResult < Struct.new(
|
1077
|
+
:status,
|
1078
|
+
:expiration_date)
|
1079
|
+
SENSITIVE = []
|
1080
|
+
include Aws::Structure
|
1081
|
+
end
|
1082
|
+
|
983
1083
|
# The container for `SnowconeDeviceConfiguration`.
|
984
1084
|
#
|
985
1085
|
# @note When making an API call, you may pass DeviceConfiguration
|
@@ -1007,7 +1107,7 @@ module Aws::Snowball
|
|
1007
1107
|
end
|
1008
1108
|
|
1009
1109
|
# A JSON-formatted object that contains the IDs for an Amazon Machine
|
1010
|
-
# Image (AMI), including the Amazon EC2 AMI ID and the
|
1110
|
+
# Image (AMI), including the Amazon EC2 AMI ID and the Snow device AMI
|
1011
1111
|
# ID. Each AMI has these two IDs to simplify identifying the AMI in both
|
1012
1112
|
# the AWS Cloud and on the device.
|
1013
1113
|
#
|
@@ -1024,7 +1124,7 @@ module Aws::Snowball
|
|
1024
1124
|
# @return [String]
|
1025
1125
|
#
|
1026
1126
|
# @!attribute [rw] snowball_ami_id
|
1027
|
-
# The ID of the AMI on the
|
1127
|
+
# The ID of the AMI on the Snow device.
|
1028
1128
|
# @return [String]
|
1029
1129
|
#
|
1030
1130
|
# @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/Ec2AmiResource AWS API Documentation
|
@@ -1145,12 +1245,12 @@ module Aws::Snowball
|
|
1145
1245
|
class GetSnowballUsageRequest < Aws::EmptyStructure; end
|
1146
1246
|
|
1147
1247
|
# @!attribute [rw] snowball_limit
|
1148
|
-
# The service limit for number of
|
1149
|
-
# once. The default service limit is 1 (one).
|
1248
|
+
# The service limit for number of Snow devices this account can have
|
1249
|
+
# at once. The default service limit is 1 (one).
|
1150
1250
|
# @return [Integer]
|
1151
1251
|
#
|
1152
1252
|
# @!attribute [rw] snowballs_in_use
|
1153
|
-
# The number of
|
1253
|
+
# The number of Snow devices that this account is currently using.
|
1154
1254
|
# @return [Integer]
|
1155
1255
|
#
|
1156
1256
|
# @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetSnowballUsageResult AWS API Documentation
|
@@ -1311,13 +1411,13 @@ module Aws::Snowball
|
|
1311
1411
|
# @return [String]
|
1312
1412
|
#
|
1313
1413
|
# @!attribute [rw] is_master
|
1314
|
-
# A value that indicates that this job is a
|
1315
|
-
# represents a successful request to create an export job.
|
1316
|
-
# aren't associated with any Snowballs. Instead, each
|
1414
|
+
# A value that indicates that this job is a main job. A main job
|
1415
|
+
# represents a successful request to create an export job. Main jobs
|
1416
|
+
# aren't associated with any Snowballs. Instead, each main job will
|
1317
1417
|
# have at least one job part, and each job part is associated with a
|
1318
1418
|
# Snowball. It might take some time before the job parts associated
|
1319
|
-
# with a particular
|
1320
|
-
# after the
|
1419
|
+
# with a particular main job are listed, because they are created
|
1420
|
+
# after the main job is created.
|
1321
1421
|
# @return [Boolean]
|
1322
1422
|
#
|
1323
1423
|
# @!attribute [rw] job_type
|
@@ -1351,18 +1451,19 @@ module Aws::Snowball
|
|
1351
1451
|
include Aws::Structure
|
1352
1452
|
end
|
1353
1453
|
|
1354
|
-
# Contains job logs. Whenever
|
1355
|
-
# export data out of Amazon S3, you'll have the option of
|
1356
|
-
# PDF job report. Job logs are returned as a part of the
|
1357
|
-
# of the `DescribeJob` action in the `JobMetadata` data
|
1358
|
-
# logs can be accessed for up to 60 minutes after this
|
1359
|
-
# made. To access any of the job logs after 60 minutes
|
1360
|
-
# you'll have to make another call to the `DescribeJob`
|
1454
|
+
# Contains job logs. Whenever a Snow device is used to import data into
|
1455
|
+
# or export data out of Amazon S3, you'll have the option of
|
1456
|
+
# downloading a PDF job report. Job logs are returned as a part of the
|
1457
|
+
# response syntax of the `DescribeJob` action in the `JobMetadata` data
|
1458
|
+
# type. The job logs can be accessed for up to 60 minutes after this
|
1459
|
+
# request has been made. To access any of the job logs after 60 minutes
|
1460
|
+
# have passed, you'll have to make another call to the `DescribeJob`
|
1461
|
+
# action.
|
1361
1462
|
#
|
1362
1463
|
# For import jobs, the PDF job report becomes available at the end of
|
1363
1464
|
# the import process. For export jobs, your job report typically becomes
|
1364
|
-
# available while the
|
1365
|
-
# you.
|
1465
|
+
# available while the Snow device for your job part is being delivered
|
1466
|
+
# to you.
|
1366
1467
|
#
|
1367
1468
|
# The job report provides you insight into the state of your Amazon S3
|
1368
1469
|
# data transfer. The report includes details about your job or job part
|
@@ -1456,7 +1557,7 @@ module Aws::Snowball
|
|
1456
1557
|
# @return [String]
|
1457
1558
|
#
|
1458
1559
|
# @!attribute [rw] address_id
|
1459
|
-
# The ID for the address that you want the
|
1560
|
+
# The ID for the address that you want the Snow device shipped to.
|
1460
1561
|
# @return [String]
|
1461
1562
|
#
|
1462
1563
|
# @!attribute [rw] shipping_details
|
@@ -1465,7 +1566,7 @@ module Aws::Snowball
|
|
1465
1566
|
# @return [Types::ShippingDetails]
|
1466
1567
|
#
|
1467
1568
|
# @!attribute [rw] snowball_capacity_preference
|
1468
|
-
# The
|
1569
|
+
# The Snow device capacity preference for this job, specified at job
|
1469
1570
|
# creation. In US regions, you can choose between 50 TB and 80 TB
|
1470
1571
|
# Snowballs. All other regions use 80 TB capacity Snowballs.
|
1471
1572
|
# @return [String]
|
@@ -1478,7 +1579,7 @@ module Aws::Snowball
|
|
1478
1579
|
# @return [Types::Notification]
|
1479
1580
|
#
|
1480
1581
|
# @!attribute [rw] data_transfer_progress
|
1481
|
-
# A value that defines the real-time status of a
|
1582
|
+
# A value that defines the real-time status of a Snow device's data
|
1482
1583
|
# transfer while the device is at AWS. This data is only available
|
1483
1584
|
# while a job has a `JobState` value of `InProgress`, for both import
|
1484
1585
|
# and export jobs.
|
@@ -1488,8 +1589,8 @@ module Aws::Snowball
|
|
1488
1589
|
# Links to Amazon S3 presigned URLs for the job report and logs. For
|
1489
1590
|
# import jobs, the PDF job report becomes available at the end of the
|
1490
1591
|
# import process. For export jobs, your job report typically becomes
|
1491
|
-
# available while the
|
1492
|
-
# you.
|
1592
|
+
# available while the Snow device for your job part is being delivered
|
1593
|
+
# to you.
|
1493
1594
|
# @return [Types::JobLogs]
|
1494
1595
|
#
|
1495
1596
|
# @!attribute [rw] cluster_id
|
@@ -1807,7 +1908,7 @@ module Aws::Snowball
|
|
1807
1908
|
|
1808
1909
|
# @!attribute [rw] compatible_images
|
1809
1910
|
# A JSON-formatted object that describes a compatible AMI, including
|
1810
|
-
# the ID and name for a
|
1911
|
+
# the ID and name for a Snow device AMI.
|
1811
1912
|
# @return [Array<Types::CompatibleImage>]
|
1812
1913
|
#
|
1813
1914
|
# @!attribute [rw] next_token
|
@@ -1926,6 +2027,21 @@ module Aws::Snowball
|
|
1926
2027
|
include Aws::Structure
|
1927
2028
|
end
|
1928
2029
|
|
2030
|
+
# You get this exception if you call `CreateReturnShippingLabel` and a
|
2031
|
+
# valid return shipping label already exists. In this case, use
|
2032
|
+
# `DescribeReturnShippingLabel` to get the url.
|
2033
|
+
#
|
2034
|
+
# @!attribute [rw] message
|
2035
|
+
# @return [String]
|
2036
|
+
#
|
2037
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ReturnShippingLabelAlreadyExistsException AWS API Documentation
|
2038
|
+
#
|
2039
|
+
class ReturnShippingLabelAlreadyExistsException < Struct.new(
|
2040
|
+
:message)
|
2041
|
+
SENSITIVE = []
|
2042
|
+
include Aws::Structure
|
2043
|
+
end
|
2044
|
+
|
1929
2045
|
# Each `S3Resource` object represents an Amazon S3 bucket that your
|
1930
2046
|
# transferred data will be exported from or imported into. For export
|
1931
2047
|
# jobs, this object can have an optional `KeyRange` value. The length of
|
@@ -1973,8 +2089,8 @@ module Aws::Snowball
|
|
1973
2089
|
#
|
1974
2090
|
# @!attribute [rw] tracking_number
|
1975
2091
|
# The tracking number for this job. Using this tracking number with
|
1976
|
-
# your region's carrier's website, you can track a
|
1977
|
-
# carrier transports it.
|
2092
|
+
# your region's carrier's website, you can track a Snow device as
|
2093
|
+
# the carrier transports it.
|
1978
2094
|
#
|
1979
2095
|
# For India, the carrier is Amazon Logistics. For all other regions,
|
1980
2096
|
# UPS is the carrier.
|
@@ -1994,31 +2110,31 @@ module Aws::Snowball
|
|
1994
2110
|
#
|
1995
2111
|
# @!attribute [rw] shipping_option
|
1996
2112
|
# The shipping speed for a particular job. This speed doesn't dictate
|
1997
|
-
# how soon you'll get the
|
2113
|
+
# how soon you'll get the Snow device from the job's creation date.
|
1998
2114
|
# This speed represents how quickly it moves to its destination while
|
1999
2115
|
# in transit. Regional shipping speeds are as follows:
|
2000
2116
|
#
|
2001
|
-
# * In Australia, you have access to express shipping. Typically,
|
2002
|
-
#
|
2117
|
+
# * In Australia, you have access to express shipping. Typically, Snow
|
2118
|
+
# devices shipped express are delivered in about a day.
|
2003
2119
|
#
|
2004
2120
|
# * In the European Union (EU), you have access to express shipping.
|
2005
|
-
# Typically,
|
2006
|
-
# In addition, most countries in the EU have access to standard
|
2121
|
+
# Typically, Snow devices shipped express are delivered in about a
|
2122
|
+
# day. In addition, most countries in the EU have access to standard
|
2007
2123
|
# shipping, which typically takes less than a week, one way.
|
2008
2124
|
#
|
2009
|
-
# * In India,
|
2125
|
+
# * In India, Snow device are delivered in one to seven days.
|
2010
2126
|
#
|
2011
2127
|
# * In the United States of America (US), you have access to one-day
|
2012
2128
|
# shipping and two-day shipping.
|
2013
2129
|
# @return [String]
|
2014
2130
|
#
|
2015
2131
|
# @!attribute [rw] inbound_shipment
|
2016
|
-
# The `Status` and `TrackingNumber` values for a
|
2132
|
+
# The `Status` and `TrackingNumber` values for a Snow device being
|
2017
2133
|
# returned to AWS for a particular job.
|
2018
2134
|
# @return [Types::Shipment]
|
2019
2135
|
#
|
2020
2136
|
# @!attribute [rw] outbound_shipment
|
2021
|
-
# The `Status` and `TrackingNumber` values for a
|
2137
|
+
# The `Status` and `TrackingNumber` values for a Snow device being
|
2022
2138
|
# delivered to the address that you specified for a particular job.
|
2023
2139
|
# @return [Types::Shipment]
|
2024
2140
|
#
|
@@ -2309,6 +2425,40 @@ module Aws::Snowball
|
|
2309
2425
|
#
|
2310
2426
|
class UpdateJobResult < Aws::EmptyStructure; end
|
2311
2427
|
|
2428
|
+
# @note When making an API call, you may pass UpdateJobShipmentStateRequest
|
2429
|
+
# data as a hash:
|
2430
|
+
#
|
2431
|
+
# {
|
2432
|
+
# job_id: "JobId", # required
|
2433
|
+
# shipment_state: "RECEIVED", # required, accepts RECEIVED, RETURNED
|
2434
|
+
# }
|
2435
|
+
#
|
2436
|
+
# @!attribute [rw] job_id
|
2437
|
+
# The job ID of the job whose shipment date you want to update, for
|
2438
|
+
# example `JID123e4567-e89b-12d3-a456-426655440000`.
|
2439
|
+
# @return [String]
|
2440
|
+
#
|
2441
|
+
# @!attribute [rw] shipment_state
|
2442
|
+
# The state of a device when it is being shipped.
|
2443
|
+
#
|
2444
|
+
# Set to `RECEIVED` when the device arrives at your location.
|
2445
|
+
#
|
2446
|
+
# Set to `RETURNED` when you have returned the device to AWS.
|
2447
|
+
# @return [String]
|
2448
|
+
#
|
2449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateJobShipmentStateRequest AWS API Documentation
|
2450
|
+
#
|
2451
|
+
class UpdateJobShipmentStateRequest < Struct.new(
|
2452
|
+
:job_id,
|
2453
|
+
:shipment_state)
|
2454
|
+
SENSITIVE = []
|
2455
|
+
include Aws::Structure
|
2456
|
+
end
|
2457
|
+
|
2458
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateJobShipmentStateResult AWS API Documentation
|
2459
|
+
#
|
2460
|
+
class UpdateJobShipmentStateResult < Aws::EmptyStructure; end
|
2461
|
+
|
2312
2462
|
# Configures the wireless connection on an AWS Snowcone device.
|
2313
2463
|
#
|
2314
2464
|
# @note When making an API call, you may pass WirelessConnection
|