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.
@@ -1,23 +1,14 @@
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
7
7
 
8
- module Aws
9
- module Snowball
10
- module Errors
8
+ module Aws::Snowball
9
+ module Errors
11
10
 
12
- extend Aws::Errors::DynamicErrors
11
+ extend Aws::Errors::DynamicErrors
13
12
 
14
- # Raised when calling #load or #data on a resource class that can not be
15
- # loaded. This can happen when:
16
- #
17
- # * A resource class has identifiers, but no data attributes.
18
- # * Resource data is only available when making an API call that
19
- # enumerates all resources of that type.
20
- class ResourceNotLoadable < RuntimeError; end
21
- end
22
13
  end
23
14
  end
@@ -1,25 +1,23 @@
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
7
7
 
8
- module Aws
9
- module Snowball
10
- class Resource
8
+ module Aws::Snowball
9
+ class Resource
11
10
 
12
- # @param options ({})
13
- # @option options [Client] :client
14
- def initialize(options = {})
15
- @client = options[:client] || Client.new(options)
16
- end
17
-
18
- # @return [Client]
19
- def client
20
- @client
21
- end
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
22
16
 
17
+ # @return [Client]
18
+ def client
19
+ @client
23
20
  end
21
+
24
22
  end
25
23
  end
@@ -1,1552 +1,1731 @@
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
7
7
 
8
- module Aws
9
- module Snowball
10
- module Types
8
+ module Aws::Snowball
9
+ module Types
11
10
 
12
- # The address that you want the Snowball or Snowballs associated with a
13
- # specific job to be shipped to. Addresses are validated at the time of
14
- # creation. The address you provide must be located within the
15
- # serviceable area of your region. Although no individual elements of
16
- # the `Address` are required, if the address is invalid or unsupported,
17
- # then an exception is thrown.
18
- # @note When making an API call, pass Address
19
- # data as a hash:
20
- #
21
- # {
22
- # address_id: "AddressId",
23
- # name: "String",
24
- # company: "String",
25
- # street_1: "String",
26
- # street_2: "String",
27
- # street_3: "String",
28
- # city: "String",
29
- # state_or_province: "String",
30
- # prefecture_or_district: "String",
31
- # landmark: "String",
32
- # country: "String",
33
- # postal_code: "String",
34
- # phone_number: "String",
35
- # }
36
- # @!attribute [rw] address_id
37
- # The unique ID for an address.
38
- # @return [String]
39
- #
40
- # @!attribute [rw] name
41
- # The name of a person to receive a Snowball at an address.
42
- # @return [String]
43
- #
44
- # @!attribute [rw] company
45
- # The name of the company to receive a Snowball at an address.
46
- # @return [String]
47
- #
48
- # @!attribute [rw] street_1
49
- # The first line in a street address that a Snowball is to be
50
- # delivered to.
51
- # @return [String]
52
- #
53
- # @!attribute [rw] street_2
54
- # The second line in a street address that a Snowball is to be
55
- # delivered to.
56
- # @return [String]
57
- #
58
- # @!attribute [rw] street_3
59
- # The third line in a street address that a Snowball is to be
60
- # delivered to.
61
- # @return [String]
62
- #
63
- # @!attribute [rw] city
64
- # The city in an address that a Snowball is to be delivered to.
65
- # @return [String]
66
- #
67
- # @!attribute [rw] state_or_province
68
- # The state or province in an address that a Snowball is to be
69
- # delivered to.
70
- # @return [String]
71
- #
72
- # @!attribute [rw] prefecture_or_district
73
- # The prefecture or district that the appliance will be shipped to.
74
- # @return [String]
75
- #
76
- # @!attribute [rw] landmark
77
- # The landmark identifying the address that the appliance will be
78
- # shipped to.
79
- # @return [String]
80
- #
81
- # @!attribute [rw] country
82
- # The country in an address that a Snowball is to be delivered to.
83
- # @return [String]
84
- #
85
- # @!attribute [rw] postal_code
86
- # The postal code in an address that a Snowball is to be delivered to.
87
- # @return [String]
88
- #
89
- # @!attribute [rw] phone_number
90
- # The phone number associated with an address that a Snowball is to be
91
- # delivered to.
92
- # @return [String]
93
- class Address < Struct.new(
94
- :address_id,
95
- :name,
96
- :company,
97
- :street_1,
98
- :street_2,
99
- :street_3,
100
- :city,
101
- :state_or_province,
102
- :prefecture_or_district,
103
- :landmark,
104
- :country,
105
- :postal_code,
106
- :phone_number)
107
- include Aws::Structure
108
- end
11
+ # The address that you want the Snowball or Snowballs associated with a
12
+ # specific job to be shipped to. Addresses are validated at the time of
13
+ # creation. The address you provide must be located within the
14
+ # serviceable area of your region. Although no individual elements of
15
+ # the `Address` are required, if the address is invalid or unsupported,
16
+ # then an exception is thrown.
17
+ #
18
+ # @note When making an API call, you may pass Address
19
+ # data as a hash:
20
+ #
21
+ # {
22
+ # address_id: "AddressId",
23
+ # name: "String",
24
+ # company: "String",
25
+ # street_1: "String",
26
+ # street_2: "String",
27
+ # street_3: "String",
28
+ # city: "String",
29
+ # state_or_province: "String",
30
+ # prefecture_or_district: "String",
31
+ # landmark: "String",
32
+ # country: "String",
33
+ # postal_code: "String",
34
+ # phone_number: "String",
35
+ # }
36
+ #
37
+ # @!attribute [rw] address_id
38
+ # The unique ID for an address.
39
+ # @return [String]
40
+ #
41
+ # @!attribute [rw] name
42
+ # The name of a person to receive a Snowball at an address.
43
+ # @return [String]
44
+ #
45
+ # @!attribute [rw] company
46
+ # The name of the company to receive a Snowball at an address.
47
+ # @return [String]
48
+ #
49
+ # @!attribute [rw] street_1
50
+ # The first line in a street address that a Snowball is to be
51
+ # delivered to.
52
+ # @return [String]
53
+ #
54
+ # @!attribute [rw] street_2
55
+ # The second line in a street address that a Snowball is to be
56
+ # delivered to.
57
+ # @return [String]
58
+ #
59
+ # @!attribute [rw] street_3
60
+ # The third line in a street address that a Snowball is to be
61
+ # delivered to.
62
+ # @return [String]
63
+ #
64
+ # @!attribute [rw] city
65
+ # The city in an address that a Snowball is to be delivered to.
66
+ # @return [String]
67
+ #
68
+ # @!attribute [rw] state_or_province
69
+ # The state or province in an address that a Snowball is to be
70
+ # delivered to.
71
+ # @return [String]
72
+ #
73
+ # @!attribute [rw] prefecture_or_district
74
+ # The prefecture or district that the appliance will be shipped to.
75
+ # @return [String]
76
+ #
77
+ # @!attribute [rw] landmark
78
+ # The landmark identifying the address that the appliance will be
79
+ # shipped to.
80
+ # @return [String]
81
+ #
82
+ # @!attribute [rw] country
83
+ # The country in an address that a Snowball is to be delivered to.
84
+ # @return [String]
85
+ #
86
+ # @!attribute [rw] postal_code
87
+ # The postal code in an address that a Snowball is to be delivered to.
88
+ # @return [String]
89
+ #
90
+ # @!attribute [rw] phone_number
91
+ # The phone number associated with an address that a Snowball is to be
92
+ # delivered to.
93
+ # @return [String]
94
+ #
95
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/Address AWS API Documentation
96
+ #
97
+ class Address < Struct.new(
98
+ :address_id,
99
+ :name,
100
+ :company,
101
+ :street_1,
102
+ :street_2,
103
+ :street_3,
104
+ :city,
105
+ :state_or_province,
106
+ :prefecture_or_district,
107
+ :landmark,
108
+ :country,
109
+ :postal_code,
110
+ :phone_number)
111
+ include Aws::Structure
112
+ end
109
113
 
110
- # @note When making an API call, pass CancelClusterRequest
111
- # data as a hash:
112
- #
113
- # {
114
- # cluster_id: "ClusterId", # required
115
- # }
116
- # @!attribute [rw] cluster_id
117
- # The 39-character ID for the cluster that you want to cancel, for
118
- # example `CID123e4567-e89b-12d3-a456-426655440000`.
119
- # @return [String]
120
- class CancelClusterRequest < Struct.new(
121
- :cluster_id)
122
- include Aws::Structure
123
- end
114
+ # @note When making an API call, you may pass CancelClusterRequest
115
+ # data as a hash:
116
+ #
117
+ # {
118
+ # cluster_id: "ClusterId", # required
119
+ # }
120
+ #
121
+ # @!attribute [rw] cluster_id
122
+ # The 39-character ID for the cluster that you want to cancel, for
123
+ # example `CID123e4567-e89b-12d3-a456-426655440000`.
124
+ # @return [String]
125
+ #
126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelClusterRequest AWS API Documentation
127
+ #
128
+ class CancelClusterRequest < Struct.new(
129
+ :cluster_id)
130
+ include Aws::Structure
131
+ end
124
132
 
125
- class CancelClusterResult < Aws::EmptyStructure; end
133
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelClusterResult AWS API Documentation
134
+ #
135
+ class CancelClusterResult < Aws::EmptyStructure; end
126
136
 
127
- # @note When making an API call, pass CancelJobRequest
128
- # data as a hash:
129
- #
130
- # {
131
- # job_id: "JobId", # required
132
- # }
133
- # @!attribute [rw] job_id
134
- # The 39-character job ID for the job that you want to cancel, for
135
- # example `JID123e4567-e89b-12d3-a456-426655440000`.
136
- # @return [String]
137
- class CancelJobRequest < Struct.new(
138
- :job_id)
139
- include Aws::Structure
140
- end
137
+ # @note When making an API call, you may pass CancelJobRequest
138
+ # data as a hash:
139
+ #
140
+ # {
141
+ # job_id: "JobId", # required
142
+ # }
143
+ #
144
+ # @!attribute [rw] job_id
145
+ # The 39-character job ID for the job that you want to cancel, for
146
+ # example `JID123e4567-e89b-12d3-a456-426655440000`.
147
+ # @return [String]
148
+ #
149
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelJobRequest AWS API Documentation
150
+ #
151
+ class CancelJobRequest < Struct.new(
152
+ :job_id)
153
+ include Aws::Structure
154
+ end
141
155
 
142
- class CancelJobResult < Aws::EmptyStructure; end
156
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelJobResult AWS API Documentation
157
+ #
158
+ class CancelJobResult < Aws::EmptyStructure; end
143
159
 
144
- # Contains a cluster's state, a cluster's ID, and other important
145
- # information.
146
- # @!attribute [rw] cluster_id
147
- # The 39-character ID for the cluster that you want to list, for
148
- # example `CID123e4567-e89b-12d3-a456-426655440000`.
149
- # @return [String]
150
- #
151
- # @!attribute [rw] cluster_state
152
- # The current state of this cluster. For information about the state
153
- # of a specific node, see JobListEntry$JobState.
154
- # @return [String]
155
- #
156
- # @!attribute [rw] creation_date
157
- # The creation date for this cluster.
158
- # @return [Time]
159
- #
160
- # @!attribute [rw] description
161
- # Defines an optional description of the cluster, for example
162
- # `Environmental Data Cluster-01`.
163
- # @return [String]
164
- class ClusterListEntry < Struct.new(
165
- :cluster_id,
166
- :cluster_state,
167
- :creation_date,
168
- :description)
169
- include Aws::Structure
170
- end
160
+ # Contains a cluster's state, a cluster's ID, and other important
161
+ # information.
162
+ #
163
+ # @!attribute [rw] cluster_id
164
+ # The 39-character ID for the cluster that you want to list, for
165
+ # example `CID123e4567-e89b-12d3-a456-426655440000`.
166
+ # @return [String]
167
+ #
168
+ # @!attribute [rw] cluster_state
169
+ # The current state of this cluster. For information about the state
170
+ # of a specific node, see JobListEntry$JobState.
171
+ # @return [String]
172
+ #
173
+ # @!attribute [rw] creation_date
174
+ # The creation date for this cluster.
175
+ # @return [Time]
176
+ #
177
+ # @!attribute [rw] description
178
+ # Defines an optional description of the cluster, for example
179
+ # `Environmental Data Cluster-01`.
180
+ # @return [String]
181
+ #
182
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ClusterListEntry AWS API Documentation
183
+ #
184
+ class ClusterListEntry < Struct.new(
185
+ :cluster_id,
186
+ :cluster_state,
187
+ :creation_date,
188
+ :description)
189
+ include Aws::Structure
190
+ end
171
191
 
172
- # Contains metadata about a specific cluster.
173
- # @!attribute [rw] cluster_id
174
- # The automatically generated ID for a cluster.
175
- # @return [String]
176
- #
177
- # @!attribute [rw] description
178
- # The optional description of the cluster.
179
- # @return [String]
180
- #
181
- # @!attribute [rw] kms_key_arn
182
- # The `KmsKeyARN` Amazon Resource Name (ARN) associated with this
183
- # cluster. This ARN was created using the [CreateKey][1] API action in
184
- # AWS Key Management Service (AWS KMS).
185
- #
186
- #
187
- #
188
- # [1]: http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html
189
- # @return [String]
190
- #
191
- # @!attribute [rw] role_arn
192
- # The role ARN associated with this cluster. This ARN was created
193
- # using the [CreateRole][1] API action in AWS Identity and Access
194
- # Management (IAM).
195
- #
196
- #
197
- #
198
- # [1]: http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
199
- # @return [String]
200
- #
201
- # @!attribute [rw] cluster_state
202
- # The current status of the cluster.
203
- # @return [String]
204
- #
205
- # @!attribute [rw] job_type
206
- # The type of job for this cluster. Currently, the only job type
207
- # supported for clusters is `LOCAL_USE`.
208
- # @return [String]
209
- #
210
- # @!attribute [rw] snowball_type
211
- # The type of AWS Snowball appliance to use for this cluster.
212
- # Currently, the only supported appliance type for cluster jobs is
213
- # `EDGE`.
214
- # @return [String]
215
- #
216
- # @!attribute [rw] creation_date
217
- # The creation date for this cluster.
218
- # @return [Time]
219
- #
220
- # @!attribute [rw] resources
221
- # The arrays of JobResource objects that can include updated
222
- # S3Resource objects or LambdaResource objects.
223
- # @return [Types::JobResource]
224
- #
225
- # @!attribute [rw] address_id
226
- # The automatically generated ID for a specific address.
227
- # @return [String]
228
- #
229
- # @!attribute [rw] shipping_option
230
- # The shipping speed for each node in this cluster. This speed
231
- # doesn't dictate how soon you'll get each Snowball Edge appliance,
232
- # rather it represents how quickly each appliance moves to its
233
- # destination while in transit. Regional shipping speeds are as
234
- # follows:
235
- #
236
- # * In Australia, you have access to express shipping. Typically,
237
- # appliances shipped express are delivered in about a day.
238
- #
239
- # * In the European Union (EU), you have access to express shipping.
240
- # Typically, Snowball Edges shipped express are delivered in about a
241
- # day. In addition, most countries in the EU have access to standard
242
- # shipping, which typically takes less than a week, one way.
243
- #
244
- # * In India, Snowball Edges are delivered in one to seven days.
245
- #
246
- # * In the US, you have access to one-day shipping and two-day
247
- # shipping.
248
- # @return [String]
249
- #
250
- # @!attribute [rw] notification
251
- # The Amazon Simple Notification Service (Amazon SNS) notification
252
- # settings for this cluster.
253
- # @return [Types::Notification]
254
- class ClusterMetadata < Struct.new(
255
- :cluster_id,
256
- :description,
257
- :kms_key_arn,
258
- :role_arn,
259
- :cluster_state,
260
- :job_type,
261
- :snowball_type,
262
- :creation_date,
263
- :resources,
264
- :address_id,
265
- :shipping_option,
266
- :notification)
267
- include Aws::Structure
268
- end
192
+ # Contains metadata about a specific cluster.
193
+ #
194
+ # @!attribute [rw] cluster_id
195
+ # The automatically generated ID for a cluster.
196
+ # @return [String]
197
+ #
198
+ # @!attribute [rw] description
199
+ # The optional description of the cluster.
200
+ # @return [String]
201
+ #
202
+ # @!attribute [rw] kms_key_arn
203
+ # The `KmsKeyARN` Amazon Resource Name (ARN) associated with this
204
+ # cluster. This ARN was created using the [CreateKey][1] API action in
205
+ # AWS Key Management Service (AWS KMS).
206
+ #
207
+ #
208
+ #
209
+ # [1]: http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html
210
+ # @return [String]
211
+ #
212
+ # @!attribute [rw] role_arn
213
+ # The role ARN associated with this cluster. This ARN was created
214
+ # using the [CreateRole][1] API action in AWS Identity and Access
215
+ # Management (IAM).
216
+ #
217
+ #
218
+ #
219
+ # [1]: http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
220
+ # @return [String]
221
+ #
222
+ # @!attribute [rw] cluster_state
223
+ # The current status of the cluster.
224
+ # @return [String]
225
+ #
226
+ # @!attribute [rw] job_type
227
+ # The type of job for this cluster. Currently, the only job type
228
+ # supported for clusters is `LOCAL_USE`.
229
+ # @return [String]
230
+ #
231
+ # @!attribute [rw] snowball_type
232
+ # The type of AWS Snowball appliance to use for this cluster.
233
+ # Currently, the only supported appliance type for cluster jobs is
234
+ # `EDGE`.
235
+ # @return [String]
236
+ #
237
+ # @!attribute [rw] creation_date
238
+ # The creation date for this cluster.
239
+ # @return [Time]
240
+ #
241
+ # @!attribute [rw] resources
242
+ # The arrays of JobResource objects that can include updated
243
+ # S3Resource objects or LambdaResource objects.
244
+ # @return [Types::JobResource]
245
+ #
246
+ # @!attribute [rw] address_id
247
+ # The automatically generated ID for a specific address.
248
+ # @return [String]
249
+ #
250
+ # @!attribute [rw] shipping_option
251
+ # The shipping speed for each node in this cluster. This speed
252
+ # doesn't dictate how soon you'll get each Snowball Edge appliance,
253
+ # rather it represents how quickly each appliance moves to its
254
+ # destination while in transit. Regional shipping speeds are as
255
+ # follows:
256
+ #
257
+ # * In Australia, you have access to express shipping. Typically,
258
+ # appliances shipped express are delivered in about a day.
259
+ #
260
+ # * In the European Union (EU), you have access to express shipping.
261
+ # Typically, Snowball Edges shipped express are delivered in about a
262
+ # day. In addition, most countries in the EU have access to standard
263
+ # shipping, which typically takes less than a week, one way.
264
+ #
265
+ # * In India, Snowball Edges are delivered in one to seven days.
266
+ #
267
+ # * In the US, you have access to one-day shipping and two-day
268
+ # shipping.
269
+ # @return [String]
270
+ #
271
+ # @!attribute [rw] notification
272
+ # The Amazon Simple Notification Service (Amazon SNS) notification
273
+ # settings for this cluster.
274
+ # @return [Types::Notification]
275
+ #
276
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ClusterMetadata AWS API Documentation
277
+ #
278
+ class ClusterMetadata < Struct.new(
279
+ :cluster_id,
280
+ :description,
281
+ :kms_key_arn,
282
+ :role_arn,
283
+ :cluster_state,
284
+ :job_type,
285
+ :snowball_type,
286
+ :creation_date,
287
+ :resources,
288
+ :address_id,
289
+ :shipping_option,
290
+ :notification)
291
+ include Aws::Structure
292
+ end
269
293
 
270
- # @note When making an API call, pass CreateAddressRequest
271
- # data as a hash:
272
- #
273
- # {
274
- # address: { # required
275
- # address_id: "AddressId",
276
- # name: "String",
277
- # company: "String",
278
- # street_1: "String",
279
- # street_2: "String",
280
- # street_3: "String",
281
- # city: "String",
282
- # state_or_province: "String",
283
- # prefecture_or_district: "String",
284
- # landmark: "String",
285
- # country: "String",
286
- # postal_code: "String",
287
- # phone_number: "String",
288
- # },
289
- # }
290
- # @!attribute [rw] address
291
- # The address that you want the Snowball shipped to.
292
- # @return [Types::Address]
293
- class CreateAddressRequest < Struct.new(
294
- :address)
295
- include Aws::Structure
296
- end
294
+ # @note When making an API call, you may pass CreateAddressRequest
295
+ # data as a hash:
296
+ #
297
+ # {
298
+ # address: { # required
299
+ # address_id: "AddressId",
300
+ # name: "String",
301
+ # company: "String",
302
+ # street_1: "String",
303
+ # street_2: "String",
304
+ # street_3: "String",
305
+ # city: "String",
306
+ # state_or_province: "String",
307
+ # prefecture_or_district: "String",
308
+ # landmark: "String",
309
+ # country: "String",
310
+ # postal_code: "String",
311
+ # phone_number: "String",
312
+ # },
313
+ # }
314
+ #
315
+ # @!attribute [rw] address
316
+ # The address that you want the Snowball shipped to.
317
+ # @return [Types::Address]
318
+ #
319
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateAddressRequest AWS API Documentation
320
+ #
321
+ class CreateAddressRequest < Struct.new(
322
+ :address)
323
+ include Aws::Structure
324
+ end
297
325
 
298
- # @!attribute [rw] address_id
299
- # The automatically generated ID for a specific address. You'll use
300
- # this ID when you create a job to specify which address you want the
301
- # Snowball for that job shipped to.
302
- # @return [String]
303
- class CreateAddressResult < Struct.new(
304
- :address_id)
305
- include Aws::Structure
306
- end
326
+ # @!attribute [rw] address_id
327
+ # The automatically generated ID for a specific address. You'll use
328
+ # this ID when you create a job to specify which address you want the
329
+ # Snowball for that job shipped to.
330
+ # @return [String]
331
+ #
332
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateAddressResult AWS API Documentation
333
+ #
334
+ class CreateAddressResult < Struct.new(
335
+ :address_id)
336
+ include Aws::Structure
337
+ end
307
338
 
308
- # @note When making an API call, pass CreateClusterRequest
309
- # data as a hash:
310
- #
311
- # {
312
- # job_type: "IMPORT", # required, accepts IMPORT, EXPORT, LOCAL_USE
313
- # resources: { # required
314
- # s3_resources: [
315
- # {
316
- # bucket_arn: "ResourceARN",
317
- # key_range: {
318
- # begin_marker: "String",
319
- # end_marker: "String",
320
- # },
321
- # },
322
- # ],
323
- # lambda_resources: [
324
- # {
325
- # lambda_arn: "ResourceARN",
326
- # event_triggers: [
327
- # {
328
- # event_resource_arn: "ResourceARN",
329
- # },
330
- # ],
331
- # },
332
- # ],
333
- # },
334
- # description: "String",
335
- # address_id: "AddressId", # required
336
- # kms_key_arn: "KmsKeyARN",
337
- # role_arn: "RoleARN", # required
338
- # snowball_type: "STANDARD", # accepts STANDARD, EDGE
339
- # shipping_option: "SECOND_DAY", # required, accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
340
- # notification: {
341
- # sns_topic_arn: "SnsTopicARN",
342
- # job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
343
- # notify_all: false,
344
- # },
345
- # }
346
- # @!attribute [rw] job_type
347
- # The type of job for this cluster. Currently, the only job type
348
- # supported for clusters is `LOCAL_USE`.
349
- # @return [String]
350
- #
351
- # @!attribute [rw] resources
352
- # The resources associated with the cluster job. These resources
353
- # include Amazon S3 buckets and optional AWS Lambda functions written
354
- # in the Python language.
355
- # @return [Types::JobResource]
356
- #
357
- # @!attribute [rw] description
358
- # An optional description of this specific cluster, for example
359
- # `Environmental Data Cluster-01`.
360
- # @return [String]
361
- #
362
- # @!attribute [rw] address_id
363
- # The ID for the address that you want the cluster shipped to.&gt;
364
- # @return [String]
365
- #
366
- # @!attribute [rw] kms_key_arn
367
- # The `KmsKeyARN` value that you want to associate with this cluster.
368
- # `KmsKeyARN` values are created by using the [CreateKey][1] API
369
- # action in AWS Key Management Service (AWS KMS).
370
- #
371
- #
372
- #
373
- # [1]: http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html
374
- # @return [String]
375
- #
376
- # @!attribute [rw] role_arn
377
- # The `RoleARN` that you want to associate with this cluster.
378
- # `RoleArn` values are created by using the [CreateRole][1] API action
379
- # in AWS Identity and Access Management (IAM).
380
- #
381
- #
382
- #
383
- # [1]: http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
384
- # @return [String]
385
- #
386
- # @!attribute [rw] snowball_type
387
- # The type of AWS Snowball appliance to use for this cluster.
388
- # Currently, the only supported appliance type for cluster jobs is
389
- # `EDGE`.
390
- # @return [String]
391
- #
392
- # @!attribute [rw] shipping_option
393
- # The shipping speed for each node in this cluster. This speed
394
- # doesn't dictate how soon you'll get each Snowball Edge appliance,
395
- # rather it represents how quickly each appliance moves to its
396
- # destination while in transit. Regional shipping speeds are as
397
- # follows:
398
- #
399
- # * In Australia, you have access to express shipping. Typically,
400
- # appliances shipped express are delivered in about a day.
401
- #
402
- # * In the European Union (EU), you have access to express shipping.
403
- # Typically, Snowball Edges shipped express are delivered in about a
404
- # day. In addition, most countries in the EU have access to standard
405
- # shipping, which typically takes less than a week, one way.
406
- #
407
- # * In India, Snowball Edges are delivered in one to seven days.
408
- #
409
- # * In the US, you have access to one-day shipping and two-day
410
- # shipping.
411
- # @return [String]
412
- #
413
- # @!attribute [rw] notification
414
- # The Amazon Simple Notification Service (Amazon SNS) notification
415
- # settings for this cluster.
416
- # @return [Types::Notification]
417
- class CreateClusterRequest < Struct.new(
418
- :job_type,
419
- :resources,
420
- :description,
421
- :address_id,
422
- :kms_key_arn,
423
- :role_arn,
424
- :snowball_type,
425
- :shipping_option,
426
- :notification)
427
- include Aws::Structure
428
- end
339
+ # @note When making an API call, you may pass CreateClusterRequest
340
+ # data as a hash:
341
+ #
342
+ # {
343
+ # job_type: "IMPORT", # required, accepts IMPORT, EXPORT, LOCAL_USE
344
+ # resources: { # required
345
+ # s3_resources: [
346
+ # {
347
+ # bucket_arn: "ResourceARN",
348
+ # key_range: {
349
+ # begin_marker: "String",
350
+ # end_marker: "String",
351
+ # },
352
+ # },
353
+ # ],
354
+ # lambda_resources: [
355
+ # {
356
+ # lambda_arn: "ResourceARN",
357
+ # event_triggers: [
358
+ # {
359
+ # event_resource_arn: "ResourceARN",
360
+ # },
361
+ # ],
362
+ # },
363
+ # ],
364
+ # },
365
+ # description: "String",
366
+ # address_id: "AddressId", # required
367
+ # kms_key_arn: "KmsKeyARN",
368
+ # role_arn: "RoleARN", # required
369
+ # snowball_type: "STANDARD", # accepts STANDARD, EDGE
370
+ # shipping_option: "SECOND_DAY", # required, accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
371
+ # notification: {
372
+ # sns_topic_arn: "SnsTopicARN",
373
+ # job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
374
+ # notify_all: false,
375
+ # },
376
+ # }
377
+ #
378
+ # @!attribute [rw] job_type
379
+ # The type of job for this cluster. Currently, the only job type
380
+ # supported for clusters is `LOCAL_USE`.
381
+ # @return [String]
382
+ #
383
+ # @!attribute [rw] resources
384
+ # The resources associated with the cluster job. These resources
385
+ # include Amazon S3 buckets and optional AWS Lambda functions written
386
+ # in the Python language.
387
+ # @return [Types::JobResource]
388
+ #
389
+ # @!attribute [rw] description
390
+ # An optional description of this specific cluster, for example
391
+ # `Environmental Data Cluster-01`.
392
+ # @return [String]
393
+ #
394
+ # @!attribute [rw] address_id
395
+ # The ID for the address that you want the cluster shipped to.&gt;
396
+ # @return [String]
397
+ #
398
+ # @!attribute [rw] kms_key_arn
399
+ # The `KmsKeyARN` value that you want to associate with this cluster.
400
+ # `KmsKeyARN` values are created by using the [CreateKey][1] API
401
+ # action in AWS Key Management Service (AWS KMS).
402
+ #
403
+ #
404
+ #
405
+ # [1]: http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html
406
+ # @return [String]
407
+ #
408
+ # @!attribute [rw] role_arn
409
+ # The `RoleARN` that you want to associate with this cluster.
410
+ # `RoleArn` values are created by using the [CreateRole][1] API action
411
+ # in AWS Identity and Access Management (IAM).
412
+ #
413
+ #
414
+ #
415
+ # [1]: http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
416
+ # @return [String]
417
+ #
418
+ # @!attribute [rw] snowball_type
419
+ # The type of AWS Snowball appliance to use for this cluster.
420
+ # Currently, the only supported appliance type for cluster jobs is
421
+ # `EDGE`.
422
+ # @return [String]
423
+ #
424
+ # @!attribute [rw] shipping_option
425
+ # The shipping speed for each node in this cluster. This speed
426
+ # doesn't dictate how soon you'll get each Snowball Edge appliance,
427
+ # rather it represents how quickly each appliance moves to its
428
+ # destination while in transit. Regional shipping speeds are as
429
+ # follows:
430
+ #
431
+ # * In Australia, you have access to express shipping. Typically,
432
+ # appliances shipped express are delivered in about a day.
433
+ #
434
+ # * In the European Union (EU), you have access to express shipping.
435
+ # Typically, Snowball Edges shipped express are delivered in about a
436
+ # day. In addition, most countries in the EU have access to standard
437
+ # shipping, which typically takes less than a week, one way.
438
+ #
439
+ # * In India, Snowball Edges are delivered in one to seven days.
440
+ #
441
+ # * In the US, you have access to one-day shipping and two-day
442
+ # shipping.
443
+ # @return [String]
444
+ #
445
+ # @!attribute [rw] notification
446
+ # The Amazon Simple Notification Service (Amazon SNS) notification
447
+ # settings for this cluster.
448
+ # @return [Types::Notification]
449
+ #
450
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateClusterRequest AWS API Documentation
451
+ #
452
+ class CreateClusterRequest < Struct.new(
453
+ :job_type,
454
+ :resources,
455
+ :description,
456
+ :address_id,
457
+ :kms_key_arn,
458
+ :role_arn,
459
+ :snowball_type,
460
+ :shipping_option,
461
+ :notification)
462
+ include Aws::Structure
463
+ end
429
464
 
430
- # @!attribute [rw] cluster_id
431
- # The automatically generated ID for a cluster.
432
- # @return [String]
433
- class CreateClusterResult < Struct.new(
434
- :cluster_id)
435
- include Aws::Structure
436
- end
465
+ # @!attribute [rw] cluster_id
466
+ # The automatically generated ID for a cluster.
467
+ # @return [String]
468
+ #
469
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateClusterResult AWS API Documentation
470
+ #
471
+ class CreateClusterResult < Struct.new(
472
+ :cluster_id)
473
+ include Aws::Structure
474
+ end
437
475
 
438
- # @note When making an API call, pass CreateJobRequest
439
- # data as a hash:
440
- #
441
- # {
442
- # job_type: "IMPORT", # accepts IMPORT, EXPORT, LOCAL_USE
443
- # resources: {
444
- # s3_resources: [
445
- # {
446
- # bucket_arn: "ResourceARN",
447
- # key_range: {
448
- # begin_marker: "String",
449
- # end_marker: "String",
450
- # },
451
- # },
452
- # ],
453
- # lambda_resources: [
454
- # {
455
- # lambda_arn: "ResourceARN",
456
- # event_triggers: [
457
- # {
458
- # event_resource_arn: "ResourceARN",
459
- # },
460
- # ],
461
- # },
462
- # ],
463
- # },
464
- # description: "String",
465
- # address_id: "AddressId",
466
- # kms_key_arn: "KmsKeyARN",
467
- # role_arn: "RoleARN",
468
- # snowball_capacity_preference: "T50", # accepts T50, T80, T100, NoPreference
469
- # shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
470
- # notification: {
471
- # sns_topic_arn: "SnsTopicARN",
472
- # job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
473
- # notify_all: false,
474
- # },
475
- # cluster_id: "ClusterId",
476
- # snowball_type: "STANDARD", # accepts STANDARD, EDGE
477
- # }
478
- # @!attribute [rw] job_type
479
- # Defines the type of job that you're creating.
480
- # @return [String]
481
- #
482
- # @!attribute [rw] resources
483
- # Defines the Amazon S3 buckets associated with this job.
484
- #
485
- # With `IMPORT` jobs, you specify the bucket or buckets that your
486
- # transferred data will be imported into.
487
- #
488
- # With `EXPORT` jobs, you specify the bucket or buckets that your
489
- # transferred data will be exported from. Optionally, you can also
490
- # specify a `KeyRange` value. If you choose to export a range, you
491
- # define the length of the range by providing either an inclusive
492
- # `BeginMarker` value, an inclusive `EndMarker` value, or both. Ranges
493
- # are UTF-8 binary sorted.
494
- # @return [Types::JobResource]
495
- #
496
- # @!attribute [rw] description
497
- # Defines an optional description of this specific job, for example
498
- # `Important Photos 2016-08-11`.
499
- # @return [String]
500
- #
501
- # @!attribute [rw] address_id
502
- # The ID for the address that you want the Snowball shipped to.
503
- # @return [String]
504
- #
505
- # @!attribute [rw] kms_key_arn
506
- # The `KmsKeyARN` that you want to associate with this job.
507
- # `KmsKeyARN`s are created using the [CreateKey][1] AWS Key Management
508
- # Service (KMS) API action.
509
- #
510
- #
511
- #
512
- # [1]: http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html
513
- # @return [String]
514
- #
515
- # @!attribute [rw] role_arn
516
- # The `RoleARN` that you want to associate with this job. `RoleArn`s
517
- # are created using the [CreateRole][1] AWS Identity and Access
518
- # Management (IAM) API action.
519
- #
520
- #
521
- #
522
- # [1]: http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
523
- # @return [String]
524
- #
525
- # @!attribute [rw] snowball_capacity_preference
526
- # If your job is being created in one of the US regions, you have the
527
- # option of specifying what size Snowball you'd like for this job. In
528
- # all other regions, Snowballs come with 80 TB in storage capacity.
529
- # @return [String]
530
- #
531
- # @!attribute [rw] shipping_option
532
- # The shipping speed for this job. This speed doesn't dictate how
533
- # soon you'll get the Snowball, rather it represents how quickly the
534
- # Snowball moves to its destination while in transit. Regional
535
- # shipping speeds are as follows:
536
- #
537
- # * In Australia, you have access to express shipping. Typically,
538
- # Snowballs shipped express are delivered in about a day.
539
- #
540
- # * In the European Union (EU), you have access to express shipping.
541
- # Typically, Snowballs shipped express are delivered in about a day.
542
- # In addition, most countries in the EU have access to standard
543
- # shipping, which typically takes less than a week, one way.
544
- #
545
- # * In India, Snowballs are delivered in one to seven days.
546
- #
547
- # * In the US, you have access to one-day shipping and two-day
548
- # shipping.
549
- # @return [String]
550
- #
551
- # @!attribute [rw] notification
552
- # Defines the Amazon Simple Notification Service (Amazon SNS)
553
- # notification settings for this job.
554
- # @return [Types::Notification]
555
- #
556
- # @!attribute [rw] cluster_id
557
- # The ID of a cluster. If you're creating a job for a node in a
558
- # cluster, you need to provide only this `clusterId` value. The other
559
- # job attributes are inherited from the cluster.
560
- # @return [String]
561
- #
562
- # @!attribute [rw] snowball_type
563
- # The type of AWS Snowball appliance to use for this job. Currently,
564
- # the only supported appliance type for cluster jobs is `EDGE`.
565
- # @return [String]
566
- class CreateJobRequest < Struct.new(
567
- :job_type,
568
- :resources,
569
- :description,
570
- :address_id,
571
- :kms_key_arn,
572
- :role_arn,
573
- :snowball_capacity_preference,
574
- :shipping_option,
575
- :notification,
576
- :cluster_id,
577
- :snowball_type)
578
- include Aws::Structure
579
- end
476
+ # @note When making an API call, you may pass CreateJobRequest
477
+ # data as a hash:
478
+ #
479
+ # {
480
+ # job_type: "IMPORT", # accepts IMPORT, EXPORT, LOCAL_USE
481
+ # resources: {
482
+ # s3_resources: [
483
+ # {
484
+ # bucket_arn: "ResourceARN",
485
+ # key_range: {
486
+ # begin_marker: "String",
487
+ # end_marker: "String",
488
+ # },
489
+ # },
490
+ # ],
491
+ # lambda_resources: [
492
+ # {
493
+ # lambda_arn: "ResourceARN",
494
+ # event_triggers: [
495
+ # {
496
+ # event_resource_arn: "ResourceARN",
497
+ # },
498
+ # ],
499
+ # },
500
+ # ],
501
+ # },
502
+ # description: "String",
503
+ # address_id: "AddressId",
504
+ # kms_key_arn: "KmsKeyARN",
505
+ # role_arn: "RoleARN",
506
+ # snowball_capacity_preference: "T50", # accepts T50, T80, T100, NoPreference
507
+ # shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
508
+ # notification: {
509
+ # sns_topic_arn: "SnsTopicARN",
510
+ # job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
511
+ # notify_all: false,
512
+ # },
513
+ # cluster_id: "ClusterId",
514
+ # snowball_type: "STANDARD", # accepts STANDARD, EDGE
515
+ # }
516
+ #
517
+ # @!attribute [rw] job_type
518
+ # Defines the type of job that you're creating.
519
+ # @return [String]
520
+ #
521
+ # @!attribute [rw] resources
522
+ # Defines the Amazon S3 buckets associated with this job.
523
+ #
524
+ # With `IMPORT` jobs, you specify the bucket or buckets that your
525
+ # transferred data will be imported into.
526
+ #
527
+ # With `EXPORT` jobs, you specify the bucket or buckets that your
528
+ # transferred data will be exported from. Optionally, you can also
529
+ # specify a `KeyRange` value. If you choose to export a range, you
530
+ # define the length of the range by providing either an inclusive
531
+ # `BeginMarker` value, an inclusive `EndMarker` value, or both. Ranges
532
+ # are UTF-8 binary sorted.
533
+ # @return [Types::JobResource]
534
+ #
535
+ # @!attribute [rw] description
536
+ # Defines an optional description of this specific job, for example
537
+ # `Important Photos 2016-08-11`.
538
+ # @return [String]
539
+ #
540
+ # @!attribute [rw] address_id
541
+ # The ID for the address that you want the Snowball shipped to.
542
+ # @return [String]
543
+ #
544
+ # @!attribute [rw] kms_key_arn
545
+ # The `KmsKeyARN` that you want to associate with this job.
546
+ # `KmsKeyARN`s are created using the [CreateKey][1] AWS Key Management
547
+ # Service (KMS) API action.
548
+ #
549
+ #
550
+ #
551
+ # [1]: http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html
552
+ # @return [String]
553
+ #
554
+ # @!attribute [rw] role_arn
555
+ # The `RoleARN` that you want to associate with this job. `RoleArn`s
556
+ # are created using the [CreateRole][1] AWS Identity and Access
557
+ # Management (IAM) API action.
558
+ #
559
+ #
560
+ #
561
+ # [1]: http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
562
+ # @return [String]
563
+ #
564
+ # @!attribute [rw] snowball_capacity_preference
565
+ # If your job is being created in one of the US regions, you have the
566
+ # option of specifying what size Snowball you'd like for this job. In
567
+ # all other regions, Snowballs come with 80 TB in storage capacity.
568
+ # @return [String]
569
+ #
570
+ # @!attribute [rw] shipping_option
571
+ # The shipping speed for this job. This speed doesn't dictate how
572
+ # soon you'll get the Snowball, rather it represents how quickly the
573
+ # Snowball moves to its destination while in transit. Regional
574
+ # shipping speeds are as follows:
575
+ #
576
+ # * In Australia, you have access to express shipping. Typically,
577
+ # Snowballs shipped express are delivered in about a day.
578
+ #
579
+ # * In the European Union (EU), you have access to express shipping.
580
+ # Typically, Snowballs shipped express are delivered in about a day.
581
+ # In addition, most countries in the EU have access to standard
582
+ # shipping, which typically takes less than a week, one way.
583
+ #
584
+ # * In India, Snowballs are delivered in one to seven days.
585
+ #
586
+ # * In the US, you have access to one-day shipping and two-day
587
+ # shipping.
588
+ # @return [String]
589
+ #
590
+ # @!attribute [rw] notification
591
+ # Defines the Amazon Simple Notification Service (Amazon SNS)
592
+ # notification settings for this job.
593
+ # @return [Types::Notification]
594
+ #
595
+ # @!attribute [rw] cluster_id
596
+ # The ID of a cluster. If you're creating a job for a node in a
597
+ # cluster, you need to provide only this `clusterId` value. The other
598
+ # job attributes are inherited from the cluster.
599
+ # @return [String]
600
+ #
601
+ # @!attribute [rw] snowball_type
602
+ # The type of AWS Snowball appliance to use for this job. Currently,
603
+ # the only supported appliance type for cluster jobs is `EDGE`.
604
+ # @return [String]
605
+ #
606
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateJobRequest AWS API Documentation
607
+ #
608
+ class CreateJobRequest < Struct.new(
609
+ :job_type,
610
+ :resources,
611
+ :description,
612
+ :address_id,
613
+ :kms_key_arn,
614
+ :role_arn,
615
+ :snowball_capacity_preference,
616
+ :shipping_option,
617
+ :notification,
618
+ :cluster_id,
619
+ :snowball_type)
620
+ include Aws::Structure
621
+ end
580
622
 
581
- # @!attribute [rw] job_id
582
- # The automatically generated ID for a job, for example
583
- # `JID123e4567-e89b-12d3-a456-426655440000`.
584
- # @return [String]
585
- class CreateJobResult < Struct.new(
586
- :job_id)
587
- include Aws::Structure
588
- end
623
+ # @!attribute [rw] job_id
624
+ # The automatically generated ID for a job, for example
625
+ # `JID123e4567-e89b-12d3-a456-426655440000`.
626
+ # @return [String]
627
+ #
628
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateJobResult AWS API Documentation
629
+ #
630
+ class CreateJobResult < Struct.new(
631
+ :job_id)
632
+ include Aws::Structure
633
+ end
589
634
 
590
- # Defines the real-time status of a Snowball's data transfer while the
591
- # appliance is at AWS. This data is only available while a job has a
592
- # `JobState` value of `InProgress`, for both import and export jobs.
593
- # @!attribute [rw] bytes_transferred
594
- # The number of bytes transferred between a Snowball and Amazon S3.
595
- # @return [Integer]
596
- #
597
- # @!attribute [rw] objects_transferred
598
- # The number of objects transferred between a Snowball and Amazon S3.
599
- # @return [Integer]
600
- #
601
- # @!attribute [rw] total_bytes
602
- # The total bytes of data for a transfer between a Snowball and Amazon
603
- # S3. This value is set to 0 (zero) until all the keys that will be
604
- # transferred have been listed.
605
- # @return [Integer]
606
- #
607
- # @!attribute [rw] total_objects
608
- # The total number of objects for a transfer between a Snowball and
609
- # Amazon S3. This value is set to 0 (zero) until all the keys that
610
- # will be transferred have been listed.
611
- # @return [Integer]
612
- class DataTransfer < Struct.new(
613
- :bytes_transferred,
614
- :objects_transferred,
615
- :total_bytes,
616
- :total_objects)
617
- include Aws::Structure
618
- end
635
+ # Defines the real-time status of a Snowball's data transfer while the
636
+ # appliance is at AWS. This data is only available while a job has a
637
+ # `JobState` value of `InProgress`, for both import and export jobs.
638
+ #
639
+ # @!attribute [rw] bytes_transferred
640
+ # The number of bytes transferred between a Snowball and Amazon S3.
641
+ # @return [Integer]
642
+ #
643
+ # @!attribute [rw] objects_transferred
644
+ # The number of objects transferred between a Snowball and Amazon S3.
645
+ # @return [Integer]
646
+ #
647
+ # @!attribute [rw] total_bytes
648
+ # The total bytes of data for a transfer between a Snowball and Amazon
649
+ # S3. This value is set to 0 (zero) until all the keys that will be
650
+ # transferred have been listed.
651
+ # @return [Integer]
652
+ #
653
+ # @!attribute [rw] total_objects
654
+ # The total number of objects for a transfer between a Snowball and
655
+ # Amazon S3. This value is set to 0 (zero) until all the keys that
656
+ # will be transferred have been listed.
657
+ # @return [Integer]
658
+ #
659
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DataTransfer AWS API Documentation
660
+ #
661
+ class DataTransfer < Struct.new(
662
+ :bytes_transferred,
663
+ :objects_transferred,
664
+ :total_bytes,
665
+ :total_objects)
666
+ include Aws::Structure
667
+ end
619
668
 
620
- # @note When making an API call, pass DescribeAddressRequest
621
- # data as a hash:
622
- #
623
- # {
624
- # address_id: "AddressId", # required
625
- # }
626
- # @!attribute [rw] address_id
627
- # The automatically generated ID for a specific address.
628
- # @return [String]
629
- class DescribeAddressRequest < Struct.new(
630
- :address_id)
631
- include Aws::Structure
632
- end
669
+ # @note When making an API call, you may pass DescribeAddressRequest
670
+ # data as a hash:
671
+ #
672
+ # {
673
+ # address_id: "AddressId", # required
674
+ # }
675
+ #
676
+ # @!attribute [rw] address_id
677
+ # The automatically generated ID for a specific address.
678
+ # @return [String]
679
+ #
680
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddressRequest AWS API Documentation
681
+ #
682
+ class DescribeAddressRequest < Struct.new(
683
+ :address_id)
684
+ include Aws::Structure
685
+ end
633
686
 
634
- # @!attribute [rw] address
635
- # The address that you want the Snowball or Snowballs associated with
636
- # a specific job to be shipped to.
637
- # @return [Types::Address]
638
- class DescribeAddressResult < Struct.new(
639
- :address)
640
- include Aws::Structure
641
- end
687
+ # @!attribute [rw] address
688
+ # The address that you want the Snowball or Snowballs associated with
689
+ # a specific job to be shipped to.
690
+ # @return [Types::Address]
691
+ #
692
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddressResult AWS API Documentation
693
+ #
694
+ class DescribeAddressResult < Struct.new(
695
+ :address)
696
+ include Aws::Structure
697
+ end
642
698
 
643
- # @note When making an API call, pass DescribeAddressesRequest
644
- # data as a hash:
645
- #
646
- # {
647
- # max_results: 1,
648
- # next_token: "String",
649
- # }
650
- # @!attribute [rw] max_results
651
- # The number of `ADDRESS` objects to return.
652
- # @return [Integer]
653
- #
654
- # @!attribute [rw] next_token
655
- # HTTP requests are stateless. To identify what object comes "next"
656
- # in the list of `ADDRESS` objects, you have the option of specifying
657
- # a value for `NextToken` as the starting point for your list of
658
- # returned addresses.
659
- # @return [String]
660
- class DescribeAddressesRequest < Struct.new(
661
- :max_results,
662
- :next_token)
663
- include Aws::Structure
664
- end
699
+ # @note When making an API call, you may pass DescribeAddressesRequest
700
+ # data as a hash:
701
+ #
702
+ # {
703
+ # max_results: 1,
704
+ # next_token: "String",
705
+ # }
706
+ #
707
+ # @!attribute [rw] max_results
708
+ # The number of `ADDRESS` objects to return.
709
+ # @return [Integer]
710
+ #
711
+ # @!attribute [rw] next_token
712
+ # HTTP requests are stateless. To identify what object comes "next"
713
+ # in the list of `ADDRESS` objects, you have the option of specifying
714
+ # a value for `NextToken` as the starting point for your list of
715
+ # returned addresses.
716
+ # @return [String]
717
+ #
718
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddressesRequest AWS API Documentation
719
+ #
720
+ class DescribeAddressesRequest < Struct.new(
721
+ :max_results,
722
+ :next_token)
723
+ include Aws::Structure
724
+ end
665
725
 
666
- # @!attribute [rw] addresses
667
- # The Snowball shipping addresses that were created for this account.
668
- # @return [Array<Types::Address>]
669
- #
670
- # @!attribute [rw] next_token
671
- # HTTP requests are stateless. If you use the automatically generated
672
- # `NextToken` value in your next `DescribeAddresses` call, your list
673
- # of returned addresses will start from this point in the array.
674
- # @return [String]
675
- class DescribeAddressesResult < Struct.new(
676
- :addresses,
677
- :next_token)
678
- include Aws::Structure
679
- end
726
+ # @!attribute [rw] addresses
727
+ # The Snowball shipping addresses that were created for this account.
728
+ # @return [Array<Types::Address>]
729
+ #
730
+ # @!attribute [rw] next_token
731
+ # HTTP requests are stateless. If you use the automatically generated
732
+ # `NextToken` value in your next `DescribeAddresses` call, your list
733
+ # of returned addresses will start from this point in the array.
734
+ # @return [String]
735
+ #
736
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeAddressesResult AWS API Documentation
737
+ #
738
+ class DescribeAddressesResult < Struct.new(
739
+ :addresses,
740
+ :next_token)
741
+ include Aws::Structure
742
+ end
680
743
 
681
- # @note When making an API call, pass DescribeClusterRequest
682
- # data as a hash:
683
- #
684
- # {
685
- # cluster_id: "ClusterId", # required
686
- # }
687
- # @!attribute [rw] cluster_id
688
- # The automatically generated ID for a cluster.
689
- # @return [String]
690
- class DescribeClusterRequest < Struct.new(
691
- :cluster_id)
692
- include Aws::Structure
693
- end
744
+ # @note When making an API call, you may pass DescribeClusterRequest
745
+ # data as a hash:
746
+ #
747
+ # {
748
+ # cluster_id: "ClusterId", # required
749
+ # }
750
+ #
751
+ # @!attribute [rw] cluster_id
752
+ # The automatically generated ID for a cluster.
753
+ # @return [String]
754
+ #
755
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeClusterRequest AWS API Documentation
756
+ #
757
+ class DescribeClusterRequest < Struct.new(
758
+ :cluster_id)
759
+ include Aws::Structure
760
+ end
694
761
 
695
- # @!attribute [rw] cluster_metadata
696
- # Information about a specific cluster, including shipping
697
- # information, cluster status, and other important metadata.
698
- # @return [Types::ClusterMetadata]
699
- class DescribeClusterResult < Struct.new(
700
- :cluster_metadata)
701
- include Aws::Structure
702
- end
762
+ # @!attribute [rw] cluster_metadata
763
+ # Information about a specific cluster, including shipping
764
+ # information, cluster status, and other important metadata.
765
+ # @return [Types::ClusterMetadata]
766
+ #
767
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeClusterResult AWS API Documentation
768
+ #
769
+ class DescribeClusterResult < Struct.new(
770
+ :cluster_metadata)
771
+ include Aws::Structure
772
+ end
703
773
 
704
- # @note When making an API call, pass DescribeJobRequest
705
- # data as a hash:
706
- #
707
- # {
708
- # job_id: "JobId", # required
709
- # }
710
- # @!attribute [rw] job_id
711
- # The automatically generated ID for a job, for example
712
- # `JID123e4567-e89b-12d3-a456-426655440000`.
713
- # @return [String]
714
- class DescribeJobRequest < Struct.new(
715
- :job_id)
716
- include Aws::Structure
717
- end
774
+ # @note When making an API call, you may pass DescribeJobRequest
775
+ # data as a hash:
776
+ #
777
+ # {
778
+ # job_id: "JobId", # required
779
+ # }
780
+ #
781
+ # @!attribute [rw] job_id
782
+ # The automatically generated ID for a job, for example
783
+ # `JID123e4567-e89b-12d3-a456-426655440000`.
784
+ # @return [String]
785
+ #
786
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeJobRequest AWS API Documentation
787
+ #
788
+ class DescribeJobRequest < Struct.new(
789
+ :job_id)
790
+ include Aws::Structure
791
+ end
718
792
 
719
- # @!attribute [rw] job_metadata
720
- # Information about a specific job, including shipping information,
721
- # job status, and other important metadata.
722
- # @return [Types::JobMetadata]
723
- #
724
- # @!attribute [rw] sub_job_metadata
725
- # Information about a specific job part (in the case of an export
726
- # job), including shipping information, job status, and other
727
- # important metadata.
728
- # @return [Array<Types::JobMetadata>]
729
- class DescribeJobResult < Struct.new(
730
- :job_metadata,
731
- :sub_job_metadata)
732
- include Aws::Structure
733
- end
793
+ # @!attribute [rw] job_metadata
794
+ # Information about a specific job, including shipping information,
795
+ # job status, and other important metadata.
796
+ # @return [Types::JobMetadata]
797
+ #
798
+ # @!attribute [rw] sub_job_metadata
799
+ # Information about a specific job part (in the case of an export
800
+ # job), including shipping information, job status, and other
801
+ # important metadata.
802
+ # @return [Array<Types::JobMetadata>]
803
+ #
804
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/DescribeJobResult AWS API Documentation
805
+ #
806
+ class DescribeJobResult < Struct.new(
807
+ :job_metadata,
808
+ :sub_job_metadata)
809
+ include Aws::Structure
810
+ end
734
811
 
735
- # The container for the EventTriggerDefinition$EventResourceARN.
736
- # @note When making an API call, pass EventTriggerDefinition
737
- # data as a hash:
738
- #
739
- # {
740
- # event_resource_arn: "ResourceARN",
741
- # }
742
- # @!attribute [rw] event_resource_arn
743
- # The Amazon Resource Name (ARN) for any local Amazon S3 resource that
744
- # is an AWS Lambda function's event trigger associated with this job.
745
- # @return [String]
746
- class EventTriggerDefinition < Struct.new(
747
- :event_resource_arn)
748
- include Aws::Structure
749
- end
812
+ # The container for the EventTriggerDefinition$EventResourceARN.
813
+ #
814
+ # @note When making an API call, you may pass EventTriggerDefinition
815
+ # data as a hash:
816
+ #
817
+ # {
818
+ # event_resource_arn: "ResourceARN",
819
+ # }
820
+ #
821
+ # @!attribute [rw] event_resource_arn
822
+ # The Amazon Resource Name (ARN) for any local Amazon S3 resource that
823
+ # is an AWS Lambda function's event trigger associated with this job.
824
+ # @return [String]
825
+ #
826
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/EventTriggerDefinition AWS API Documentation
827
+ #
828
+ class EventTriggerDefinition < Struct.new(
829
+ :event_resource_arn)
830
+ include Aws::Structure
831
+ end
750
832
 
751
- # @note When making an API call, pass GetJobManifestRequest
752
- # data as a hash:
753
- #
754
- # {
755
- # job_id: "JobId", # required
756
- # }
757
- # @!attribute [rw] job_id
758
- # The ID for a job that you want to get the manifest file for, for
759
- # example `JID123e4567-e89b-12d3-a456-426655440000`.
760
- # @return [String]
761
- class GetJobManifestRequest < Struct.new(
762
- :job_id)
763
- include Aws::Structure
764
- end
833
+ # @note When making an API call, you may pass GetJobManifestRequest
834
+ # data as a hash:
835
+ #
836
+ # {
837
+ # job_id: "JobId", # required
838
+ # }
839
+ #
840
+ # @!attribute [rw] job_id
841
+ # The ID for a job that you want to get the manifest file for, for
842
+ # example `JID123e4567-e89b-12d3-a456-426655440000`.
843
+ # @return [String]
844
+ #
845
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobManifestRequest AWS API Documentation
846
+ #
847
+ class GetJobManifestRequest < Struct.new(
848
+ :job_id)
849
+ include Aws::Structure
850
+ end
765
851
 
766
- # @!attribute [rw] manifest_uri
767
- # The Amazon S3 presigned URL for the manifest file associated with
768
- # the specified `JobId` value.
769
- # @return [String]
770
- class GetJobManifestResult < Struct.new(
771
- :manifest_uri)
772
- include Aws::Structure
773
- end
852
+ # @!attribute [rw] manifest_uri
853
+ # The Amazon S3 presigned URL for the manifest file associated with
854
+ # the specified `JobId` value.
855
+ # @return [String]
856
+ #
857
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobManifestResult AWS API Documentation
858
+ #
859
+ class GetJobManifestResult < Struct.new(
860
+ :manifest_uri)
861
+ include Aws::Structure
862
+ end
774
863
 
775
- # @note When making an API call, pass GetJobUnlockCodeRequest
776
- # data as a hash:
777
- #
778
- # {
779
- # job_id: "JobId", # required
780
- # }
781
- # @!attribute [rw] job_id
782
- # The ID for the job that you want to get the `UnlockCode` value for,
783
- # for example `JID123e4567-e89b-12d3-a456-426655440000`.
784
- # @return [String]
785
- class GetJobUnlockCodeRequest < Struct.new(
786
- :job_id)
787
- include Aws::Structure
788
- end
864
+ # @note When making an API call, you may pass GetJobUnlockCodeRequest
865
+ # data as a hash:
866
+ #
867
+ # {
868
+ # job_id: "JobId", # required
869
+ # }
870
+ #
871
+ # @!attribute [rw] job_id
872
+ # The ID for the job that you want to get the `UnlockCode` value for,
873
+ # for example `JID123e4567-e89b-12d3-a456-426655440000`.
874
+ # @return [String]
875
+ #
876
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobUnlockCodeRequest AWS API Documentation
877
+ #
878
+ class GetJobUnlockCodeRequest < Struct.new(
879
+ :job_id)
880
+ include Aws::Structure
881
+ end
789
882
 
790
- # @!attribute [rw] unlock_code
791
- # The `UnlockCode` value for the specified job. The `UnlockCode` value
792
- # can be accessed for up to 90 days after the job has been created.
793
- # @return [String]
794
- class GetJobUnlockCodeResult < Struct.new(
795
- :unlock_code)
796
- include Aws::Structure
797
- end
883
+ # @!attribute [rw] unlock_code
884
+ # The `UnlockCode` value for the specified job. The `UnlockCode` value
885
+ # can be accessed for up to 90 days after the job has been created.
886
+ # @return [String]
887
+ #
888
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetJobUnlockCodeResult AWS API Documentation
889
+ #
890
+ class GetJobUnlockCodeResult < Struct.new(
891
+ :unlock_code)
892
+ include Aws::Structure
893
+ end
798
894
 
799
- # @api private
800
- class GetSnowballUsageRequest < Aws::EmptyStructure; end
895
+ # @api private
896
+ #
897
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetSnowballUsageRequest AWS API Documentation
898
+ #
899
+ class GetSnowballUsageRequest < Aws::EmptyStructure; end
801
900
 
802
- # @!attribute [rw] snowball_limit
803
- # The service limit for number of Snowballs this account can have at
804
- # once. The default service limit is 1 (one).
805
- # @return [Integer]
806
- #
807
- # @!attribute [rw] snowballs_in_use
808
- # The number of Snowballs that this account is currently using.
809
- # @return [Integer]
810
- class GetSnowballUsageResult < Struct.new(
811
- :snowball_limit,
812
- :snowballs_in_use)
813
- include Aws::Structure
814
- end
901
+ # @!attribute [rw] snowball_limit
902
+ # The service limit for number of Snowballs this account can have at
903
+ # once. The default service limit is 1 (one).
904
+ # @return [Integer]
905
+ #
906
+ # @!attribute [rw] snowballs_in_use
907
+ # The number of Snowballs that this account is currently using.
908
+ # @return [Integer]
909
+ #
910
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/GetSnowballUsageResult AWS API Documentation
911
+ #
912
+ class GetSnowballUsageResult < Struct.new(
913
+ :snowball_limit,
914
+ :snowballs_in_use)
915
+ include Aws::Structure
916
+ end
815
917
 
816
- # Each `JobListEntry` object contains a job's state, a job's ID, and a
817
- # value that indicates whether the job is a job part, in the case of an
818
- # export job.
819
- # @!attribute [rw] job_id
820
- # The automatically generated ID for a job, for example
821
- # `JID123e4567-e89b-12d3-a456-426655440000`.
822
- # @return [String]
823
- #
824
- # @!attribute [rw] job_state
825
- # The current state of this job.
826
- # @return [String]
827
- #
828
- # @!attribute [rw] is_master
829
- # A value that indicates that this job is a master job. A master job
830
- # represents a successful request to create an export job. Master jobs
831
- # aren't associated with any Snowballs. Instead, each master job will
832
- # have at least one job part, and each job part is associated with a
833
- # Snowball. It might take some time before the job parts associated
834
- # with a particular master job are listed, because they are created
835
- # after the master job is created.
836
- # @return [Boolean]
837
- #
838
- # @!attribute [rw] job_type
839
- # The type of job.
840
- # @return [String]
841
- #
842
- # @!attribute [rw] snowball_type
843
- # The type of appliance used with this job.
844
- # @return [String]
845
- #
846
- # @!attribute [rw] creation_date
847
- # The creation date for this job.
848
- # @return [Time]
849
- #
850
- # @!attribute [rw] description
851
- # The optional description of this specific job, for example
852
- # `Important Photos 2016-08-11`.
853
- # @return [String]
854
- class JobListEntry < Struct.new(
855
- :job_id,
856
- :job_state,
857
- :is_master,
858
- :job_type,
859
- :snowball_type,
860
- :creation_date,
861
- :description)
862
- include Aws::Structure
863
- end
918
+ # Each `JobListEntry` object contains a job's state, a job's ID, and a
919
+ # value that indicates whether the job is a job part, in the case of an
920
+ # export job.
921
+ #
922
+ # @!attribute [rw] job_id
923
+ # The automatically generated ID for a job, for example
924
+ # `JID123e4567-e89b-12d3-a456-426655440000`.
925
+ # @return [String]
926
+ #
927
+ # @!attribute [rw] job_state
928
+ # The current state of this job.
929
+ # @return [String]
930
+ #
931
+ # @!attribute [rw] is_master
932
+ # A value that indicates that this job is a master job. A master job
933
+ # represents a successful request to create an export job. Master jobs
934
+ # aren't associated with any Snowballs. Instead, each master job will
935
+ # have at least one job part, and each job part is associated with a
936
+ # Snowball. It might take some time before the job parts associated
937
+ # with a particular master job are listed, because they are created
938
+ # after the master job is created.
939
+ # @return [Boolean]
940
+ #
941
+ # @!attribute [rw] job_type
942
+ # The type of job.
943
+ # @return [String]
944
+ #
945
+ # @!attribute [rw] snowball_type
946
+ # The type of appliance used with this job.
947
+ # @return [String]
948
+ #
949
+ # @!attribute [rw] creation_date
950
+ # The creation date for this job.
951
+ # @return [Time]
952
+ #
953
+ # @!attribute [rw] description
954
+ # The optional description of this specific job, for example
955
+ # `Important Photos 2016-08-11`.
956
+ # @return [String]
957
+ #
958
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/JobListEntry AWS API Documentation
959
+ #
960
+ class JobListEntry < Struct.new(
961
+ :job_id,
962
+ :job_state,
963
+ :is_master,
964
+ :job_type,
965
+ :snowball_type,
966
+ :creation_date,
967
+ :description)
968
+ include Aws::Structure
969
+ end
864
970
 
865
- # Contains job logs. Whenever Snowball is used to import data into or
866
- # export data out of Amazon S3, you'll have the option of downloading a
867
- # PDF job report. Job logs are returned as a part of the response syntax
868
- # of the `DescribeJob` action in the `JobMetadata` data type. The job
869
- # logs can be accessed for up to 60 minutes after this request has been
870
- # made. To access any of the job logs after 60 minutes have passed,
871
- # you'll have to make another call to the `DescribeJob` action.
872
- #
873
- # For import jobs, the PDF job report becomes available at the end of
874
- # the import process. For export jobs, your job report typically becomes
875
- # available while the Snowball for your job part is being delivered to
876
- # you.
877
- #
878
- # The job report provides you insight into the state of your Amazon S3
879
- # data transfer. The report includes details about your job or job part
880
- # for your records.
881
- #
882
- # For deeper visibility into the status of your transferred objects, you
883
- # can look at the two associated logs: a success log and a failure log.
884
- # The logs are saved in comma-separated value (CSV) format, and the name
885
- # of each log includes the ID of the job or job part that the log
886
- # describes.
887
- # @!attribute [rw] job_completion_report_uri
888
- # A link to an Amazon S3 presigned URL where the job completion report
889
- # is located.
890
- # @return [String]
891
- #
892
- # @!attribute [rw] job_success_log_uri
893
- # A link to an Amazon S3 presigned URL where the job success log is
894
- # located.
895
- # @return [String]
896
- #
897
- # @!attribute [rw] job_failure_log_uri
898
- # A link to an Amazon S3 presigned URL where the job failure log is
899
- # located.
900
- # @return [String]
901
- class JobLogs < Struct.new(
902
- :job_completion_report_uri,
903
- :job_success_log_uri,
904
- :job_failure_log_uri)
905
- include Aws::Structure
906
- end
971
+ # Contains job logs. Whenever Snowball is used to import data into or
972
+ # export data out of Amazon S3, you'll have the option of downloading a
973
+ # PDF job report. Job logs are returned as a part of the response syntax
974
+ # of the `DescribeJob` action in the `JobMetadata` data type. The job
975
+ # logs can be accessed for up to 60 minutes after this request has been
976
+ # made. To access any of the job logs after 60 minutes have passed,
977
+ # you'll have to make another call to the `DescribeJob` action.
978
+ #
979
+ # For import jobs, the PDF job report becomes available at the end of
980
+ # the import process. For export jobs, your job report typically becomes
981
+ # available while the Snowball for your job part is being delivered to
982
+ # you.
983
+ #
984
+ # The job report provides you insight into the state of your Amazon S3
985
+ # data transfer. The report includes details about your job or job part
986
+ # for your records.
987
+ #
988
+ # For deeper visibility into the status of your transferred objects, you
989
+ # can look at the two associated logs: a success log and a failure log.
990
+ # The logs are saved in comma-separated value (CSV) format, and the name
991
+ # of each log includes the ID of the job or job part that the log
992
+ # describes.
993
+ #
994
+ # @!attribute [rw] job_completion_report_uri
995
+ # A link to an Amazon S3 presigned URL where the job completion report
996
+ # is located.
997
+ # @return [String]
998
+ #
999
+ # @!attribute [rw] job_success_log_uri
1000
+ # A link to an Amazon S3 presigned URL where the job success log is
1001
+ # located.
1002
+ # @return [String]
1003
+ #
1004
+ # @!attribute [rw] job_failure_log_uri
1005
+ # A link to an Amazon S3 presigned URL where the job failure log is
1006
+ # located.
1007
+ # @return [String]
1008
+ #
1009
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/JobLogs AWS API Documentation
1010
+ #
1011
+ class JobLogs < Struct.new(
1012
+ :job_completion_report_uri,
1013
+ :job_success_log_uri,
1014
+ :job_failure_log_uri)
1015
+ include Aws::Structure
1016
+ end
907
1017
 
908
- # Contains information about a specific job including shipping
909
- # information, job status, and other important metadata. This
910
- # information is returned as a part of the response syntax of the
911
- # `DescribeJob` action.
912
- # @!attribute [rw] job_id
913
- # The automatically generated ID for a job, for example
914
- # `JID123e4567-e89b-12d3-a456-426655440000`.
915
- # @return [String]
916
- #
917
- # @!attribute [rw] job_state
918
- # The current status of the jobs.
919
- # @return [String]
920
- #
921
- # @!attribute [rw] job_type
922
- # The type of job.
923
- # @return [String]
924
- #
925
- # @!attribute [rw] snowball_type
926
- # The type of appliance used with this job.
927
- # @return [String]
928
- #
929
- # @!attribute [rw] creation_date
930
- # The creation date for this job.
931
- # @return [Time]
932
- #
933
- # @!attribute [rw] resources
934
- # An array of `S3Resource` objects. Each `S3Resource` object
935
- # represents an Amazon S3 bucket that your transferred data will be
936
- # exported from or imported into.
937
- # @return [Types::JobResource]
938
- #
939
- # @!attribute [rw] description
940
- # The description of the job, provided at job creation.
941
- # @return [String]
942
- #
943
- # @!attribute [rw] kms_key_arn
944
- # The Amazon Resource Name (ARN) for the AWS Key Management Service
945
- # (AWS KMS) key associated with this job. This ARN was created using
946
- # the `CreateKey` API action in AWS KMS.
947
- # @return [String]
948
- #
949
- # @!attribute [rw] role_arn
950
- # The role ARN associated with this job. This ARN was created using
951
- # the `CreateRole` API action in AWS Identity and Access Management
952
- # (IAM).
953
- # @return [String]
954
- #
955
- # @!attribute [rw] address_id
956
- # The ID for the address that you want the Snowball shipped to.
957
- # @return [String]
958
- #
959
- # @!attribute [rw] shipping_details
960
- # A job's shipping information, including inbound and outbound
961
- # tracking numbers and shipping speed options.
962
- # @return [Types::ShippingDetails]
963
- #
964
- # @!attribute [rw] snowball_capacity_preference
965
- # The Snowball capacity preference for this job, specified at job
966
- # creation. In US regions, you can choose between 50 TB and 80 TB
967
- # Snowballs. All other regions use 80 TB capacity Snowballs.
968
- # @return [String]
969
- #
970
- # @!attribute [rw] notification
971
- # The Amazon Simple Notification Service (Amazon SNS) notification
972
- # settings associated with a specific job. The `Notification` object
973
- # is returned as a part of the response syntax of the `DescribeJob`
974
- # action in the `JobMetadata` data type.
975
- # @return [Types::Notification]
976
- #
977
- # @!attribute [rw] data_transfer_progress
978
- # A value that defines the real-time status of a Snowball's data
979
- # transfer while the appliance is at AWS. This data is only available
980
- # while a job has a `JobState` value of `InProgress`, for both import
981
- # and export jobs.
982
- # @return [Types::DataTransfer]
983
- #
984
- # @!attribute [rw] job_log_info
985
- # Links to Amazon S3 presigned URLs for the job report and logs. For
986
- # import jobs, the PDF job report becomes available at the end of the
987
- # import process. For export jobs, your job report typically becomes
988
- # available while the Snowball for your job part is being delivered to
989
- # you.
990
- # @return [Types::JobLogs]
991
- #
992
- # @!attribute [rw] cluster_id
993
- # The 39-character ID for the cluster, for example
994
- # `CID123e4567-e89b-12d3-a456-426655440000`.
995
- # @return [String]
996
- class JobMetadata < Struct.new(
997
- :job_id,
998
- :job_state,
999
- :job_type,
1000
- :snowball_type,
1001
- :creation_date,
1002
- :resources,
1003
- :description,
1004
- :kms_key_arn,
1005
- :role_arn,
1006
- :address_id,
1007
- :shipping_details,
1008
- :snowball_capacity_preference,
1009
- :notification,
1010
- :data_transfer_progress,
1011
- :job_log_info,
1012
- :cluster_id)
1013
- include Aws::Structure
1014
- end
1018
+ # Contains information about a specific job including shipping
1019
+ # information, job status, and other important metadata. This
1020
+ # information is returned as a part of the response syntax of the
1021
+ # `DescribeJob` action.
1022
+ #
1023
+ # @!attribute [rw] job_id
1024
+ # The automatically generated ID for a job, for example
1025
+ # `JID123e4567-e89b-12d3-a456-426655440000`.
1026
+ # @return [String]
1027
+ #
1028
+ # @!attribute [rw] job_state
1029
+ # The current status of the jobs.
1030
+ # @return [String]
1031
+ #
1032
+ # @!attribute [rw] job_type
1033
+ # The type of job.
1034
+ # @return [String]
1035
+ #
1036
+ # @!attribute [rw] snowball_type
1037
+ # The type of appliance used with this job.
1038
+ # @return [String]
1039
+ #
1040
+ # @!attribute [rw] creation_date
1041
+ # The creation date for this job.
1042
+ # @return [Time]
1043
+ #
1044
+ # @!attribute [rw] resources
1045
+ # An array of `S3Resource` objects. Each `S3Resource` object
1046
+ # represents an Amazon S3 bucket that your transferred data will be
1047
+ # exported from or imported into.
1048
+ # @return [Types::JobResource]
1049
+ #
1050
+ # @!attribute [rw] description
1051
+ # The description of the job, provided at job creation.
1052
+ # @return [String]
1053
+ #
1054
+ # @!attribute [rw] kms_key_arn
1055
+ # The Amazon Resource Name (ARN) for the AWS Key Management Service
1056
+ # (AWS KMS) key associated with this job. This ARN was created using
1057
+ # the `CreateKey` API action in AWS KMS.
1058
+ # @return [String]
1059
+ #
1060
+ # @!attribute [rw] role_arn
1061
+ # The role ARN associated with this job. This ARN was created using
1062
+ # the `CreateRole` API action in AWS Identity and Access Management
1063
+ # (IAM).
1064
+ # @return [String]
1065
+ #
1066
+ # @!attribute [rw] address_id
1067
+ # The ID for the address that you want the Snowball shipped to.
1068
+ # @return [String]
1069
+ #
1070
+ # @!attribute [rw] shipping_details
1071
+ # A job's shipping information, including inbound and outbound
1072
+ # tracking numbers and shipping speed options.
1073
+ # @return [Types::ShippingDetails]
1074
+ #
1075
+ # @!attribute [rw] snowball_capacity_preference
1076
+ # The Snowball capacity preference for this job, specified at job
1077
+ # creation. In US regions, you can choose between 50 TB and 80 TB
1078
+ # Snowballs. All other regions use 80 TB capacity Snowballs.
1079
+ # @return [String]
1080
+ #
1081
+ # @!attribute [rw] notification
1082
+ # The Amazon Simple Notification Service (Amazon SNS) notification
1083
+ # settings associated with a specific job. The `Notification` object
1084
+ # is returned as a part of the response syntax of the `DescribeJob`
1085
+ # action in the `JobMetadata` data type.
1086
+ # @return [Types::Notification]
1087
+ #
1088
+ # @!attribute [rw] data_transfer_progress
1089
+ # A value that defines the real-time status of a Snowball's data
1090
+ # transfer while the appliance is at AWS. This data is only available
1091
+ # while a job has a `JobState` value of `InProgress`, for both import
1092
+ # and export jobs.
1093
+ # @return [Types::DataTransfer]
1094
+ #
1095
+ # @!attribute [rw] job_log_info
1096
+ # Links to Amazon S3 presigned URLs for the job report and logs. For
1097
+ # import jobs, the PDF job report becomes available at the end of the
1098
+ # import process. For export jobs, your job report typically becomes
1099
+ # available while the Snowball for your job part is being delivered to
1100
+ # you.
1101
+ # @return [Types::JobLogs]
1102
+ #
1103
+ # @!attribute [rw] cluster_id
1104
+ # The 39-character ID for the cluster, for example
1105
+ # `CID123e4567-e89b-12d3-a456-426655440000`.
1106
+ # @return [String]
1107
+ #
1108
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/JobMetadata AWS API Documentation
1109
+ #
1110
+ class JobMetadata < Struct.new(
1111
+ :job_id,
1112
+ :job_state,
1113
+ :job_type,
1114
+ :snowball_type,
1115
+ :creation_date,
1116
+ :resources,
1117
+ :description,
1118
+ :kms_key_arn,
1119
+ :role_arn,
1120
+ :address_id,
1121
+ :shipping_details,
1122
+ :snowball_capacity_preference,
1123
+ :notification,
1124
+ :data_transfer_progress,
1125
+ :job_log_info,
1126
+ :cluster_id)
1127
+ include Aws::Structure
1128
+ end
1015
1129
 
1016
- # Contains an array of `S3Resource` objects. Each `S3Resource` object
1017
- # represents an Amazon S3 bucket that your transferred data will be
1018
- # exported from or imported into.
1019
- # @note When making an API call, pass JobResource
1020
- # data as a hash:
1021
- #
1022
- # {
1023
- # s3_resources: [
1024
- # {
1025
- # bucket_arn: "ResourceARN",
1026
- # key_range: {
1027
- # begin_marker: "String",
1028
- # end_marker: "String",
1029
- # },
1030
- # },
1031
- # ],
1032
- # lambda_resources: [
1033
- # {
1034
- # lambda_arn: "ResourceARN",
1035
- # event_triggers: [
1036
- # {
1037
- # event_resource_arn: "ResourceARN",
1038
- # },
1039
- # ],
1040
- # },
1041
- # ],
1042
- # }
1043
- # @!attribute [rw] s3_resources
1044
- # An array of `S3Resource` objects.
1045
- # @return [Array<Types::S3Resource>]
1046
- #
1047
- # @!attribute [rw] lambda_resources
1048
- # The Python-language Lambda functions for this job.
1049
- # @return [Array<Types::LambdaResource>]
1050
- class JobResource < Struct.new(
1051
- :s3_resources,
1052
- :lambda_resources)
1053
- include Aws::Structure
1054
- end
1130
+ # Contains an array of `S3Resource` objects. Each `S3Resource` object
1131
+ # represents an Amazon S3 bucket that your transferred data will be
1132
+ # exported from or imported into.
1133
+ #
1134
+ # @note When making an API call, you may pass JobResource
1135
+ # data as a hash:
1136
+ #
1137
+ # {
1138
+ # s3_resources: [
1139
+ # {
1140
+ # bucket_arn: "ResourceARN",
1141
+ # key_range: {
1142
+ # begin_marker: "String",
1143
+ # end_marker: "String",
1144
+ # },
1145
+ # },
1146
+ # ],
1147
+ # lambda_resources: [
1148
+ # {
1149
+ # lambda_arn: "ResourceARN",
1150
+ # event_triggers: [
1151
+ # {
1152
+ # event_resource_arn: "ResourceARN",
1153
+ # },
1154
+ # ],
1155
+ # },
1156
+ # ],
1157
+ # }
1158
+ #
1159
+ # @!attribute [rw] s3_resources
1160
+ # An array of `S3Resource` objects.
1161
+ # @return [Array<Types::S3Resource>]
1162
+ #
1163
+ # @!attribute [rw] lambda_resources
1164
+ # The Python-language Lambda functions for this job.
1165
+ # @return [Array<Types::LambdaResource>]
1166
+ #
1167
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/JobResource AWS API Documentation
1168
+ #
1169
+ class JobResource < Struct.new(
1170
+ :s3_resources,
1171
+ :lambda_resources)
1172
+ include Aws::Structure
1173
+ end
1055
1174
 
1056
- # Contains a key range. For export jobs, a `S3Resource` object can have
1057
- # an optional `KeyRange` value. The length of the range is defined at
1058
- # job creation, and has either an inclusive `BeginMarker`, an inclusive
1059
- # `EndMarker`, or both. Ranges are UTF-8 binary sorted.
1060
- # @note When making an API call, pass KeyRange
1061
- # data as a hash:
1062
- #
1063
- # {
1064
- # begin_marker: "String",
1065
- # end_marker: "String",
1066
- # }
1067
- # @!attribute [rw] begin_marker
1068
- # The key that starts an optional key range for an export job. Ranges
1069
- # are inclusive and UTF-8 binary sorted.
1070
- # @return [String]
1071
- #
1072
- # @!attribute [rw] end_marker
1073
- # The key that ends an optional key range for an export job. Ranges
1074
- # are inclusive and UTF-8 binary sorted.
1075
- # @return [String]
1076
- class KeyRange < Struct.new(
1077
- :begin_marker,
1078
- :end_marker)
1079
- include Aws::Structure
1080
- end
1175
+ # Contains a key range. For export jobs, a `S3Resource` object can have
1176
+ # an optional `KeyRange` value. The length of the range is defined at
1177
+ # job creation, and has either an inclusive `BeginMarker`, an inclusive
1178
+ # `EndMarker`, or both. Ranges are UTF-8 binary sorted.
1179
+ #
1180
+ # @note When making an API call, you may pass KeyRange
1181
+ # data as a hash:
1182
+ #
1183
+ # {
1184
+ # begin_marker: "String",
1185
+ # end_marker: "String",
1186
+ # }
1187
+ #
1188
+ # @!attribute [rw] begin_marker
1189
+ # The key that starts an optional key range for an export job. Ranges
1190
+ # are inclusive and UTF-8 binary sorted.
1191
+ # @return [String]
1192
+ #
1193
+ # @!attribute [rw] end_marker
1194
+ # The key that ends an optional key range for an export job. Ranges
1195
+ # are inclusive and UTF-8 binary sorted.
1196
+ # @return [String]
1197
+ #
1198
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/KeyRange AWS API Documentation
1199
+ #
1200
+ class KeyRange < Struct.new(
1201
+ :begin_marker,
1202
+ :end_marker)
1203
+ include Aws::Structure
1204
+ end
1081
1205
 
1082
- # Identifies
1083
- # @note When making an API call, pass LambdaResource
1084
- # data as a hash:
1085
- #
1086
- # {
1087
- # lambda_arn: "ResourceARN",
1088
- # event_triggers: [
1089
- # {
1090
- # event_resource_arn: "ResourceARN",
1091
- # },
1092
- # ],
1093
- # }
1094
- # @!attribute [rw] lambda_arn
1095
- # An Amazon Resource Name (ARN) that represents an AWS Lambda function
1096
- # to be triggered by PUT object actions on the associated local Amazon
1097
- # S3 resource.
1098
- # @return [String]
1099
- #
1100
- # @!attribute [rw] event_triggers
1101
- # The array of ARNs for S3Resource objects to trigger the
1102
- # LambdaResource objects associated with this job.
1103
- # @return [Array<Types::EventTriggerDefinition>]
1104
- class LambdaResource < Struct.new(
1105
- :lambda_arn,
1106
- :event_triggers)
1107
- include Aws::Structure
1108
- end
1206
+ # Identifies
1207
+ #
1208
+ # @note When making an API call, you may pass LambdaResource
1209
+ # data as a hash:
1210
+ #
1211
+ # {
1212
+ # lambda_arn: "ResourceARN",
1213
+ # event_triggers: [
1214
+ # {
1215
+ # event_resource_arn: "ResourceARN",
1216
+ # },
1217
+ # ],
1218
+ # }
1219
+ #
1220
+ # @!attribute [rw] lambda_arn
1221
+ # An Amazon Resource Name (ARN) that represents an AWS Lambda function
1222
+ # to be triggered by PUT object actions on the associated local Amazon
1223
+ # S3 resource.
1224
+ # @return [String]
1225
+ #
1226
+ # @!attribute [rw] event_triggers
1227
+ # The array of ARNs for S3Resource objects to trigger the
1228
+ # LambdaResource objects associated with this job.
1229
+ # @return [Array<Types::EventTriggerDefinition>]
1230
+ #
1231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/LambdaResource AWS API Documentation
1232
+ #
1233
+ class LambdaResource < Struct.new(
1234
+ :lambda_arn,
1235
+ :event_triggers)
1236
+ include Aws::Structure
1237
+ end
1109
1238
 
1110
- # @note When making an API call, pass ListClusterJobsRequest
1111
- # data as a hash:
1112
- #
1113
- # {
1114
- # cluster_id: "ClusterId", # required
1115
- # max_results: 1,
1116
- # next_token: "String",
1117
- # }
1118
- # @!attribute [rw] cluster_id
1119
- # The 39-character ID for the cluster that you want to list, for
1120
- # example `CID123e4567-e89b-12d3-a456-426655440000`.
1121
- # @return [String]
1122
- #
1123
- # @!attribute [rw] max_results
1124
- # The number of `JobListEntry` objects to return.
1125
- # @return [Integer]
1126
- #
1127
- # @!attribute [rw] next_token
1128
- # HTTP requests are stateless. To identify what object comes "next"
1129
- # in the list of `JobListEntry` objects, you have the option of
1130
- # specifying `NextToken` as the starting point for your returned list.
1131
- # @return [String]
1132
- class ListClusterJobsRequest < Struct.new(
1133
- :cluster_id,
1134
- :max_results,
1135
- :next_token)
1136
- include Aws::Structure
1137
- end
1239
+ # @note When making an API call, you may pass ListClusterJobsRequest
1240
+ # data as a hash:
1241
+ #
1242
+ # {
1243
+ # cluster_id: "ClusterId", # required
1244
+ # max_results: 1,
1245
+ # next_token: "String",
1246
+ # }
1247
+ #
1248
+ # @!attribute [rw] cluster_id
1249
+ # The 39-character ID for the cluster that you want to list, for
1250
+ # example `CID123e4567-e89b-12d3-a456-426655440000`.
1251
+ # @return [String]
1252
+ #
1253
+ # @!attribute [rw] max_results
1254
+ # The number of `JobListEntry` objects to return.
1255
+ # @return [Integer]
1256
+ #
1257
+ # @!attribute [rw] next_token
1258
+ # HTTP requests are stateless. To identify what object comes "next"
1259
+ # in the list of `JobListEntry` objects, you have the option of
1260
+ # specifying `NextToken` as the starting point for your returned list.
1261
+ # @return [String]
1262
+ #
1263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClusterJobsRequest AWS API Documentation
1264
+ #
1265
+ class ListClusterJobsRequest < Struct.new(
1266
+ :cluster_id,
1267
+ :max_results,
1268
+ :next_token)
1269
+ include Aws::Structure
1270
+ end
1138
1271
 
1139
- # @!attribute [rw] job_list_entries
1140
- # Each `JobListEntry` object contains a job's state, a job's ID, and
1141
- # a value that indicates whether the job is a job part, in the case of
1142
- # export jobs.
1143
- # @return [Array<Types::JobListEntry>]
1144
- #
1145
- # @!attribute [rw] next_token
1146
- # HTTP requests are stateless. If you use the automatically generated
1147
- # `NextToken` value in your next `ListClusterJobsResult` call, your
1148
- # list of returned jobs will start from this point in the array.
1149
- # @return [String]
1150
- class ListClusterJobsResult < Struct.new(
1151
- :job_list_entries,
1152
- :next_token)
1153
- include Aws::Structure
1154
- end
1272
+ # @!attribute [rw] job_list_entries
1273
+ # Each `JobListEntry` object contains a job's state, a job's ID, and
1274
+ # a value that indicates whether the job is a job part, in the case of
1275
+ # export jobs.
1276
+ # @return [Array<Types::JobListEntry>]
1277
+ #
1278
+ # @!attribute [rw] next_token
1279
+ # HTTP requests are stateless. If you use the automatically generated
1280
+ # `NextToken` value in your next `ListClusterJobsResult` call, your
1281
+ # list of returned jobs will start from this point in the array.
1282
+ # @return [String]
1283
+ #
1284
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClusterJobsResult AWS API Documentation
1285
+ #
1286
+ class ListClusterJobsResult < Struct.new(
1287
+ :job_list_entries,
1288
+ :next_token)
1289
+ include Aws::Structure
1290
+ end
1155
1291
 
1156
- # @note When making an API call, pass ListClustersRequest
1157
- # data as a hash:
1158
- #
1159
- # {
1160
- # max_results: 1,
1161
- # next_token: "String",
1162
- # }
1163
- # @!attribute [rw] max_results
1164
- # The number of `ClusterListEntry` objects to return.
1165
- # @return [Integer]
1166
- #
1167
- # @!attribute [rw] next_token
1168
- # HTTP requests are stateless. To identify what object comes "next"
1169
- # in the list of `ClusterListEntry` objects, you have the option of
1170
- # specifying `NextToken` as the starting point for your returned list.
1171
- # @return [String]
1172
- class ListClustersRequest < Struct.new(
1173
- :max_results,
1174
- :next_token)
1175
- include Aws::Structure
1176
- end
1292
+ # @note When making an API call, you may pass ListClustersRequest
1293
+ # data as a hash:
1294
+ #
1295
+ # {
1296
+ # max_results: 1,
1297
+ # next_token: "String",
1298
+ # }
1299
+ #
1300
+ # @!attribute [rw] max_results
1301
+ # The number of `ClusterListEntry` objects to return.
1302
+ # @return [Integer]
1303
+ #
1304
+ # @!attribute [rw] next_token
1305
+ # HTTP requests are stateless. To identify what object comes "next"
1306
+ # in the list of `ClusterListEntry` objects, you have the option of
1307
+ # specifying `NextToken` as the starting point for your returned list.
1308
+ # @return [String]
1309
+ #
1310
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClustersRequest AWS API Documentation
1311
+ #
1312
+ class ListClustersRequest < Struct.new(
1313
+ :max_results,
1314
+ :next_token)
1315
+ include Aws::Structure
1316
+ end
1177
1317
 
1178
- # @!attribute [rw] cluster_list_entries
1179
- # Each `ClusterListEntry` object contains a cluster's state, a
1180
- # cluster's ID, and other important status information.
1181
- # @return [Array<Types::ClusterListEntry>]
1182
- #
1183
- # @!attribute [rw] next_token
1184
- # HTTP requests are stateless. If you use the automatically generated
1185
- # `NextToken` value in your next `ClusterListEntry` call, your list of
1186
- # returned clusters will start from this point in the array.
1187
- # @return [String]
1188
- class ListClustersResult < Struct.new(
1189
- :cluster_list_entries,
1190
- :next_token)
1191
- include Aws::Structure
1192
- end
1318
+ # @!attribute [rw] cluster_list_entries
1319
+ # Each `ClusterListEntry` object contains a cluster's state, a
1320
+ # cluster's ID, and other important status information.
1321
+ # @return [Array<Types::ClusterListEntry>]
1322
+ #
1323
+ # @!attribute [rw] next_token
1324
+ # HTTP requests are stateless. If you use the automatically generated
1325
+ # `NextToken` value in your next `ClusterListEntry` call, your list of
1326
+ # returned clusters will start from this point in the array.
1327
+ # @return [String]
1328
+ #
1329
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListClustersResult AWS API Documentation
1330
+ #
1331
+ class ListClustersResult < Struct.new(
1332
+ :cluster_list_entries,
1333
+ :next_token)
1334
+ include Aws::Structure
1335
+ end
1193
1336
 
1194
- # @note When making an API call, pass ListJobsRequest
1195
- # data as a hash:
1196
- #
1197
- # {
1198
- # max_results: 1,
1199
- # next_token: "String",
1200
- # }
1201
- # @!attribute [rw] max_results
1202
- # The number of `JobListEntry` objects to return.
1203
- # @return [Integer]
1204
- #
1205
- # @!attribute [rw] next_token
1206
- # HTTP requests are stateless. To identify what object comes "next"
1207
- # in the list of `JobListEntry` objects, you have the option of
1208
- # specifying `NextToken` as the starting point for your returned list.
1209
- # @return [String]
1210
- class ListJobsRequest < Struct.new(
1211
- :max_results,
1212
- :next_token)
1213
- include Aws::Structure
1214
- end
1337
+ # @note When making an API call, you may pass ListJobsRequest
1338
+ # data as a hash:
1339
+ #
1340
+ # {
1341
+ # max_results: 1,
1342
+ # next_token: "String",
1343
+ # }
1344
+ #
1345
+ # @!attribute [rw] max_results
1346
+ # The number of `JobListEntry` objects to return.
1347
+ # @return [Integer]
1348
+ #
1349
+ # @!attribute [rw] next_token
1350
+ # HTTP requests are stateless. To identify what object comes "next"
1351
+ # in the list of `JobListEntry` objects, you have the option of
1352
+ # specifying `NextToken` as the starting point for your returned list.
1353
+ # @return [String]
1354
+ #
1355
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListJobsRequest AWS API Documentation
1356
+ #
1357
+ class ListJobsRequest < Struct.new(
1358
+ :max_results,
1359
+ :next_token)
1360
+ include Aws::Structure
1361
+ end
1215
1362
 
1216
- # @!attribute [rw] job_list_entries
1217
- # Each `JobListEntry` object contains a job's state, a job's ID, and
1218
- # a value that indicates whether the job is a job part, in the case of
1219
- # export jobs.
1220
- # @return [Array<Types::JobListEntry>]
1221
- #
1222
- # @!attribute [rw] next_token
1223
- # HTTP requests are stateless. If you use this automatically generated
1224
- # `NextToken` value in your next `ListJobs` call, your returned
1225
- # `JobListEntry` objects will start from this point in the array.
1226
- # @return [String]
1227
- class ListJobsResult < Struct.new(
1228
- :job_list_entries,
1229
- :next_token)
1230
- include Aws::Structure
1231
- end
1363
+ # @!attribute [rw] job_list_entries
1364
+ # Each `JobListEntry` object contains a job's state, a job's ID, and
1365
+ # a value that indicates whether the job is a job part, in the case of
1366
+ # export jobs.
1367
+ # @return [Array<Types::JobListEntry>]
1368
+ #
1369
+ # @!attribute [rw] next_token
1370
+ # HTTP requests are stateless. If you use this automatically generated
1371
+ # `NextToken` value in your next `ListJobs` call, your returned
1372
+ # `JobListEntry` objects will start from this point in the array.
1373
+ # @return [String]
1374
+ #
1375
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ListJobsResult AWS API Documentation
1376
+ #
1377
+ class ListJobsResult < Struct.new(
1378
+ :job_list_entries,
1379
+ :next_token)
1380
+ include Aws::Structure
1381
+ end
1232
1382
 
1233
- # The Amazon Simple Notification Service (Amazon SNS) notification
1234
- # settings associated with a specific job. The `Notification` object is
1235
- # returned as a part of the response syntax of the `DescribeJob` action
1236
- # in the `JobMetadata` data type.
1237
- #
1238
- # When the notification settings are defined during job creation, you
1239
- # can choose to notify based on a specific set of job states using the
1240
- # `JobStatesToNotify` array of strings, or you can specify that you want
1241
- # to have Amazon SNS notifications sent out for all job states with
1242
- # `NotifyAll` set to true.
1243
- # @note When making an API call, pass Notification
1244
- # data as a hash:
1245
- #
1246
- # {
1247
- # sns_topic_arn: "SnsTopicARN",
1248
- # job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
1249
- # notify_all: false,
1250
- # }
1251
- # @!attribute [rw] sns_topic_arn
1252
- # The new SNS `TopicArn` that you want to associate with this job. You
1253
- # can create Amazon Resource Names (ARNs) for topics by using the
1254
- # [CreateTopic][1] Amazon SNS API action.
1255
- #
1256
- # You can subscribe email addresses to an Amazon SNS topic through the
1257
- # AWS Management Console, or by using the [Subscribe][2] AWS Simple
1258
- # Notification Service (SNS) API action.
1259
- #
1260
- #
1261
- #
1262
- # [1]: http://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html
1263
- # [2]: http://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html
1264
- # @return [String]
1265
- #
1266
- # @!attribute [rw] job_states_to_notify
1267
- # The list of job states that will trigger a notification for this
1268
- # job.
1269
- # @return [Array<String>]
1270
- #
1271
- # @!attribute [rw] notify_all
1272
- # Any change in job state will trigger a notification for this job.
1273
- # @return [Boolean]
1274
- class Notification < Struct.new(
1275
- :sns_topic_arn,
1276
- :job_states_to_notify,
1277
- :notify_all)
1278
- include Aws::Structure
1279
- end
1383
+ # The Amazon Simple Notification Service (Amazon SNS) notification
1384
+ # settings associated with a specific job. The `Notification` object is
1385
+ # returned as a part of the response syntax of the `DescribeJob` action
1386
+ # in the `JobMetadata` data type.
1387
+ #
1388
+ # When the notification settings are defined during job creation, you
1389
+ # can choose to notify based on a specific set of job states using the
1390
+ # `JobStatesToNotify` array of strings, or you can specify that you want
1391
+ # to have Amazon SNS notifications sent out for all job states with
1392
+ # `NotifyAll` set to true.
1393
+ #
1394
+ # @note When making an API call, you may pass Notification
1395
+ # data as a hash:
1396
+ #
1397
+ # {
1398
+ # sns_topic_arn: "SnsTopicARN",
1399
+ # job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
1400
+ # notify_all: false,
1401
+ # }
1402
+ #
1403
+ # @!attribute [rw] sns_topic_arn
1404
+ # The new SNS `TopicArn` that you want to associate with this job. You
1405
+ # can create Amazon Resource Names (ARNs) for topics by using the
1406
+ # [CreateTopic][1] Amazon SNS API action.
1407
+ #
1408
+ # You can subscribe email addresses to an Amazon SNS topic through the
1409
+ # AWS Management Console, or by using the [Subscribe][2] AWS Simple
1410
+ # Notification Service (SNS) API action.
1411
+ #
1412
+ #
1413
+ #
1414
+ # [1]: http://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html
1415
+ # [2]: http://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html
1416
+ # @return [String]
1417
+ #
1418
+ # @!attribute [rw] job_states_to_notify
1419
+ # The list of job states that will trigger a notification for this
1420
+ # job.
1421
+ # @return [Array<String>]
1422
+ #
1423
+ # @!attribute [rw] notify_all
1424
+ # Any change in job state will trigger a notification for this job.
1425
+ # @return [Boolean]
1426
+ #
1427
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/Notification AWS API Documentation
1428
+ #
1429
+ class Notification < Struct.new(
1430
+ :sns_topic_arn,
1431
+ :job_states_to_notify,
1432
+ :notify_all)
1433
+ include Aws::Structure
1434
+ end
1280
1435
 
1281
- # Each `S3Resource` object represents an Amazon S3 bucket that your
1282
- # transferred data will be exported from or imported into. For export
1283
- # jobs, this object can have an optional `KeyRange` value. The length of
1284
- # the range is defined at job creation, and has either an inclusive
1285
- # `BeginMarker`, an inclusive `EndMarker`, or both. Ranges are UTF-8
1286
- # binary sorted.
1287
- # @note When making an API call, pass S3Resource
1288
- # data as a hash:
1289
- #
1290
- # {
1291
- # bucket_arn: "ResourceARN",
1292
- # key_range: {
1293
- # begin_marker: "String",
1294
- # end_marker: "String",
1295
- # },
1296
- # }
1297
- # @!attribute [rw] bucket_arn
1298
- # The Amazon Resource Name (ARN) of an Amazon S3 bucket.
1299
- # @return [String]
1300
- #
1301
- # @!attribute [rw] key_range
1302
- # For export jobs, you can provide an optional `KeyRange` within a
1303
- # specific Amazon S3 bucket. The length of the range is defined at job
1304
- # creation, and has either an inclusive `BeginMarker`, an inclusive
1305
- # `EndMarker`, or both. Ranges are UTF-8 binary sorted.
1306
- # @return [Types::KeyRange]
1307
- class S3Resource < Struct.new(
1308
- :bucket_arn,
1309
- :key_range)
1310
- include Aws::Structure
1311
- end
1436
+ # Each `S3Resource` object represents an Amazon S3 bucket that your
1437
+ # transferred data will be exported from or imported into. For export
1438
+ # jobs, this object can have an optional `KeyRange` value. The length of
1439
+ # the range is defined at job creation, and has either an inclusive
1440
+ # `BeginMarker`, an inclusive `EndMarker`, or both. Ranges are UTF-8
1441
+ # binary sorted.
1442
+ #
1443
+ # @note When making an API call, you may pass S3Resource
1444
+ # data as a hash:
1445
+ #
1446
+ # {
1447
+ # bucket_arn: "ResourceARN",
1448
+ # key_range: {
1449
+ # begin_marker: "String",
1450
+ # end_marker: "String",
1451
+ # },
1452
+ # }
1453
+ #
1454
+ # @!attribute [rw] bucket_arn
1455
+ # The Amazon Resource Name (ARN) of an Amazon S3 bucket.
1456
+ # @return [String]
1457
+ #
1458
+ # @!attribute [rw] key_range
1459
+ # For export jobs, you can provide an optional `KeyRange` within a
1460
+ # specific Amazon S3 bucket. The length of the range is defined at job
1461
+ # creation, and has either an inclusive `BeginMarker`, an inclusive
1462
+ # `EndMarker`, or both. Ranges are UTF-8 binary sorted.
1463
+ # @return [Types::KeyRange]
1464
+ #
1465
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/S3Resource AWS API Documentation
1466
+ #
1467
+ class S3Resource < Struct.new(
1468
+ :bucket_arn,
1469
+ :key_range)
1470
+ include Aws::Structure
1471
+ end
1312
1472
 
1313
- # The `Status` and `TrackingNumber` information for an inbound or
1314
- # outbound shipment.
1315
- # @!attribute [rw] status
1316
- # Status information for a shipment. Valid statuses include `NEW`,
1317
- # `IN_TRANSIT`, and `DELIVERED`.
1318
- # @return [String]
1319
- #
1320
- # @!attribute [rw] tracking_number
1321
- # The tracking number for this job. Using this tracking number with
1322
- # your region's carrier's website, you can track a Snowball as the
1323
- # carrier transports it.
1324
- #
1325
- # For India, the carrier is Amazon Logistics. For all other regions,
1326
- # UPS is the carrier.
1327
- # @return [String]
1328
- class Shipment < Struct.new(
1329
- :status,
1330
- :tracking_number)
1331
- include Aws::Structure
1332
- end
1473
+ # The `Status` and `TrackingNumber` information for an inbound or
1474
+ # outbound shipment.
1475
+ #
1476
+ # @!attribute [rw] status
1477
+ # Status information for a shipment. Valid statuses include `NEW`,
1478
+ # `IN_TRANSIT`, and `DELIVERED`.
1479
+ # @return [String]
1480
+ #
1481
+ # @!attribute [rw] tracking_number
1482
+ # The tracking number for this job. Using this tracking number with
1483
+ # your region's carrier's website, you can track a Snowball as the
1484
+ # carrier transports it.
1485
+ #
1486
+ # For India, the carrier is Amazon Logistics. For all other regions,
1487
+ # UPS is the carrier.
1488
+ # @return [String]
1489
+ #
1490
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/Shipment AWS API Documentation
1491
+ #
1492
+ class Shipment < Struct.new(
1493
+ :status,
1494
+ :tracking_number)
1495
+ include Aws::Structure
1496
+ end
1333
1497
 
1334
- # A job's shipping information, including inbound and outbound tracking
1335
- # numbers and shipping speed options.
1336
- # @!attribute [rw] shipping_option
1337
- # The shipping speed for a particular job. This speed doesn't dictate
1338
- # how soon you'll get the Snowball from the job's creation date.
1339
- # This speed represents how quickly it moves to its destination while
1340
- # in transit. Regional shipping speeds are as follows:
1341
- #
1342
- # * In Australia, you have access to express shipping. Typically,
1343
- # Snowballs shipped express are delivered in about a day.
1344
- #
1345
- # * In the European Union (EU), you have access to express shipping.
1346
- # Typically, Snowballs shipped express are delivered in about a day.
1347
- # In addition, most countries in the EU have access to standard
1348
- # shipping, which typically takes less than a week, one way.
1349
- #
1350
- # * In India, Snowballs are delivered in one to seven days.
1351
- #
1352
- # * In the United States of America (US), you have access to one-day
1353
- # shipping and two-day shipping.
1354
- # @return [String]
1355
- #
1356
- # @!attribute [rw] inbound_shipment
1357
- # The `Status` and `TrackingNumber` values for a Snowball being
1358
- # delivered to the address that you specified for a particular job.
1359
- # @return [Types::Shipment]
1360
- #
1361
- # @!attribute [rw] outbound_shipment
1362
- # The `Status` and `TrackingNumber` values for a Snowball being
1363
- # returned to AWS for a particular job.
1364
- # @return [Types::Shipment]
1365
- class ShippingDetails < Struct.new(
1366
- :shipping_option,
1367
- :inbound_shipment,
1368
- :outbound_shipment)
1369
- include Aws::Structure
1370
- end
1498
+ # A job's shipping information, including inbound and outbound tracking
1499
+ # numbers and shipping speed options.
1500
+ #
1501
+ # @!attribute [rw] shipping_option
1502
+ # The shipping speed for a particular job. This speed doesn't dictate
1503
+ # how soon you'll get the Snowball from the job's creation date.
1504
+ # This speed represents how quickly it moves to its destination while
1505
+ # in transit. Regional shipping speeds are as follows:
1506
+ #
1507
+ # * In Australia, you have access to express shipping. Typically,
1508
+ # Snowballs shipped express are delivered in about a day.
1509
+ #
1510
+ # * In the European Union (EU), you have access to express shipping.
1511
+ # Typically, Snowballs shipped express are delivered in about a day.
1512
+ # In addition, most countries in the EU have access to standard
1513
+ # shipping, which typically takes less than a week, one way.
1514
+ #
1515
+ # * In India, Snowballs are delivered in one to seven days.
1516
+ #
1517
+ # * In the United States of America (US), you have access to one-day
1518
+ # shipping and two-day shipping.
1519
+ # @return [String]
1520
+ #
1521
+ # @!attribute [rw] inbound_shipment
1522
+ # The `Status` and `TrackingNumber` values for a Snowball being
1523
+ # delivered to the address that you specified for a particular job.
1524
+ # @return [Types::Shipment]
1525
+ #
1526
+ # @!attribute [rw] outbound_shipment
1527
+ # The `Status` and `TrackingNumber` values for a Snowball being
1528
+ # returned to AWS for a particular job.
1529
+ # @return [Types::Shipment]
1530
+ #
1531
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ShippingDetails AWS API Documentation
1532
+ #
1533
+ class ShippingDetails < Struct.new(
1534
+ :shipping_option,
1535
+ :inbound_shipment,
1536
+ :outbound_shipment)
1537
+ include Aws::Structure
1538
+ end
1371
1539
 
1372
- # @note When making an API call, pass UpdateClusterRequest
1373
- # data as a hash:
1374
- #
1375
- # {
1376
- # cluster_id: "ClusterId", # required
1377
- # role_arn: "RoleARN",
1378
- # description: "String",
1379
- # resources: {
1380
- # s3_resources: [
1381
- # {
1382
- # bucket_arn: "ResourceARN",
1383
- # key_range: {
1384
- # begin_marker: "String",
1385
- # end_marker: "String",
1386
- # },
1387
- # },
1388
- # ],
1389
- # lambda_resources: [
1390
- # {
1391
- # lambda_arn: "ResourceARN",
1392
- # event_triggers: [
1393
- # {
1394
- # event_resource_arn: "ResourceARN",
1395
- # },
1396
- # ],
1397
- # },
1398
- # ],
1399
- # },
1400
- # address_id: "AddressId",
1401
- # shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
1402
- # notification: {
1403
- # sns_topic_arn: "SnsTopicARN",
1404
- # job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
1405
- # notify_all: false,
1406
- # },
1407
- # }
1408
- # @!attribute [rw] cluster_id
1409
- # The cluster ID of the cluster that you want to update, for example
1410
- # `CID123e4567-e89b-12d3-a456-426655440000`.
1411
- # @return [String]
1412
- #
1413
- # @!attribute [rw] role_arn
1414
- # The new role Amazon Resource Name (ARN) that you want to associate
1415
- # with this cluster. To create a role ARN, use the [CreateRole][1] API
1416
- # action in AWS Identity and Access Management (IAM).
1417
- #
1418
- #
1419
- #
1420
- # [1]: http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
1421
- # @return [String]
1422
- #
1423
- # @!attribute [rw] description
1424
- # The updated description of this cluster.
1425
- # @return [String]
1426
- #
1427
- # @!attribute [rw] resources
1428
- # The updated arrays of JobResource objects that can include updated
1429
- # S3Resource objects or LambdaResource objects.
1430
- # @return [Types::JobResource]
1431
- #
1432
- # @!attribute [rw] address_id
1433
- # The ID of the updated Address object.
1434
- # @return [String]
1435
- #
1436
- # @!attribute [rw] shipping_option
1437
- # The updated shipping option value of this cluster's ShippingDetails
1438
- # object.
1439
- # @return [String]
1440
- #
1441
- # @!attribute [rw] notification
1442
- # The new or updated Notification object.
1443
- # @return [Types::Notification]
1444
- class UpdateClusterRequest < Struct.new(
1445
- :cluster_id,
1446
- :role_arn,
1447
- :description,
1448
- :resources,
1449
- :address_id,
1450
- :shipping_option,
1451
- :notification)
1452
- include Aws::Structure
1453
- end
1540
+ # @note When making an API call, you may pass UpdateClusterRequest
1541
+ # data as a hash:
1542
+ #
1543
+ # {
1544
+ # cluster_id: "ClusterId", # required
1545
+ # role_arn: "RoleARN",
1546
+ # description: "String",
1547
+ # resources: {
1548
+ # s3_resources: [
1549
+ # {
1550
+ # bucket_arn: "ResourceARN",
1551
+ # key_range: {
1552
+ # begin_marker: "String",
1553
+ # end_marker: "String",
1554
+ # },
1555
+ # },
1556
+ # ],
1557
+ # lambda_resources: [
1558
+ # {
1559
+ # lambda_arn: "ResourceARN",
1560
+ # event_triggers: [
1561
+ # {
1562
+ # event_resource_arn: "ResourceARN",
1563
+ # },
1564
+ # ],
1565
+ # },
1566
+ # ],
1567
+ # },
1568
+ # address_id: "AddressId",
1569
+ # shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
1570
+ # notification: {
1571
+ # sns_topic_arn: "SnsTopicARN",
1572
+ # job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
1573
+ # notify_all: false,
1574
+ # },
1575
+ # }
1576
+ #
1577
+ # @!attribute [rw] cluster_id
1578
+ # The cluster ID of the cluster that you want to update, for example
1579
+ # `CID123e4567-e89b-12d3-a456-426655440000`.
1580
+ # @return [String]
1581
+ #
1582
+ # @!attribute [rw] role_arn
1583
+ # The new role Amazon Resource Name (ARN) that you want to associate
1584
+ # with this cluster. To create a role ARN, use the [CreateRole][1] API
1585
+ # action in AWS Identity and Access Management (IAM).
1586
+ #
1587
+ #
1588
+ #
1589
+ # [1]: http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
1590
+ # @return [String]
1591
+ #
1592
+ # @!attribute [rw] description
1593
+ # The updated description of this cluster.
1594
+ # @return [String]
1595
+ #
1596
+ # @!attribute [rw] resources
1597
+ # The updated arrays of JobResource objects that can include updated
1598
+ # S3Resource objects or LambdaResource objects.
1599
+ # @return [Types::JobResource]
1600
+ #
1601
+ # @!attribute [rw] address_id
1602
+ # The ID of the updated Address object.
1603
+ # @return [String]
1604
+ #
1605
+ # @!attribute [rw] shipping_option
1606
+ # The updated shipping option value of this cluster's ShippingDetails
1607
+ # object.
1608
+ # @return [String]
1609
+ #
1610
+ # @!attribute [rw] notification
1611
+ # The new or updated Notification object.
1612
+ # @return [Types::Notification]
1613
+ #
1614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateClusterRequest AWS API Documentation
1615
+ #
1616
+ class UpdateClusterRequest < Struct.new(
1617
+ :cluster_id,
1618
+ :role_arn,
1619
+ :description,
1620
+ :resources,
1621
+ :address_id,
1622
+ :shipping_option,
1623
+ :notification)
1624
+ include Aws::Structure
1625
+ end
1454
1626
 
1455
- class UpdateClusterResult < Aws::EmptyStructure; end
1627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateClusterResult AWS API Documentation
1628
+ #
1629
+ class UpdateClusterResult < Aws::EmptyStructure; end
1456
1630
 
1457
- # @note When making an API call, pass UpdateJobRequest
1458
- # data as a hash:
1459
- #
1460
- # {
1461
- # job_id: "JobId", # required
1462
- # role_arn: "RoleARN",
1463
- # notification: {
1464
- # sns_topic_arn: "SnsTopicARN",
1465
- # job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
1466
- # notify_all: false,
1467
- # },
1468
- # resources: {
1469
- # s3_resources: [
1470
- # {
1471
- # bucket_arn: "ResourceARN",
1472
- # key_range: {
1473
- # begin_marker: "String",
1474
- # end_marker: "String",
1475
- # },
1476
- # },
1477
- # ],
1478
- # lambda_resources: [
1479
- # {
1480
- # lambda_arn: "ResourceARN",
1481
- # event_triggers: [
1482
- # {
1483
- # event_resource_arn: "ResourceARN",
1484
- # },
1485
- # ],
1486
- # },
1487
- # ],
1488
- # },
1489
- # address_id: "AddressId",
1490
- # shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
1491
- # description: "String",
1492
- # snowball_capacity_preference: "T50", # accepts T50, T80, T100, NoPreference
1493
- # }
1494
- # @!attribute [rw] job_id
1495
- # The job ID of the job that you want to update, for example
1496
- # `JID123e4567-e89b-12d3-a456-426655440000`.
1497
- # @return [String]
1498
- #
1499
- # @!attribute [rw] role_arn
1500
- # The new role Amazon Resource Name (ARN) that you want to associate
1501
- # with this job. To create a role ARN, use the [CreateRole][1] AWS
1502
- # Identity and Access Management (IAM) API action.
1503
- #
1504
- #
1505
- #
1506
- # [1]: http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
1507
- # @return [String]
1508
- #
1509
- # @!attribute [rw] notification
1510
- # The new or updated Notification object.
1511
- # @return [Types::Notification]
1512
- #
1513
- # @!attribute [rw] resources
1514
- # The updated S3Resource object (for a single Amazon S3 bucket or key
1515
- # range), or the updated JobResource object (for multiple buckets or
1516
- # key ranges).
1517
- # @return [Types::JobResource]
1518
- #
1519
- # @!attribute [rw] address_id
1520
- # The ID of the updated Address object.
1521
- # @return [String]
1522
- #
1523
- # @!attribute [rw] shipping_option
1524
- # The updated shipping option value of this job's ShippingDetails
1525
- # object.
1526
- # @return [String]
1527
- #
1528
- # @!attribute [rw] description
1529
- # The updated description of this job's JobMetadata object.
1530
- # @return [String]
1531
- #
1532
- # @!attribute [rw] snowball_capacity_preference
1533
- # The updated `SnowballCapacityPreference` of this job's JobMetadata
1534
- # object. The 50 TB Snowballs are only available in the US regions.
1535
- # @return [String]
1536
- class UpdateJobRequest < Struct.new(
1537
- :job_id,
1538
- :role_arn,
1539
- :notification,
1540
- :resources,
1541
- :address_id,
1542
- :shipping_option,
1543
- :description,
1544
- :snowball_capacity_preference)
1545
- include Aws::Structure
1546
- end
1631
+ # @note When making an API call, you may pass UpdateJobRequest
1632
+ # data as a hash:
1633
+ #
1634
+ # {
1635
+ # job_id: "JobId", # required
1636
+ # role_arn: "RoleARN",
1637
+ # notification: {
1638
+ # sns_topic_arn: "SnsTopicARN",
1639
+ # job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
1640
+ # notify_all: false,
1641
+ # },
1642
+ # resources: {
1643
+ # s3_resources: [
1644
+ # {
1645
+ # bucket_arn: "ResourceARN",
1646
+ # key_range: {
1647
+ # begin_marker: "String",
1648
+ # end_marker: "String",
1649
+ # },
1650
+ # },
1651
+ # ],
1652
+ # lambda_resources: [
1653
+ # {
1654
+ # lambda_arn: "ResourceARN",
1655
+ # event_triggers: [
1656
+ # {
1657
+ # event_resource_arn: "ResourceARN",
1658
+ # },
1659
+ # ],
1660
+ # },
1661
+ # ],
1662
+ # },
1663
+ # address_id: "AddressId",
1664
+ # shipping_option: "SECOND_DAY", # accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD
1665
+ # description: "String",
1666
+ # snowball_capacity_preference: "T50", # accepts T50, T80, T100, NoPreference
1667
+ # }
1668
+ #
1669
+ # @!attribute [rw] job_id
1670
+ # The job ID of the job that you want to update, for example
1671
+ # `JID123e4567-e89b-12d3-a456-426655440000`.
1672
+ # @return [String]
1673
+ #
1674
+ # @!attribute [rw] role_arn
1675
+ # The new role Amazon Resource Name (ARN) that you want to associate
1676
+ # with this job. To create a role ARN, use the [CreateRole][1] AWS
1677
+ # Identity and Access Management (IAM) API action.
1678
+ #
1679
+ #
1680
+ #
1681
+ # [1]: http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
1682
+ # @return [String]
1683
+ #
1684
+ # @!attribute [rw] notification
1685
+ # The new or updated Notification object.
1686
+ # @return [Types::Notification]
1687
+ #
1688
+ # @!attribute [rw] resources
1689
+ # The updated S3Resource object (for a single Amazon S3 bucket or key
1690
+ # range), or the updated JobResource object (for multiple buckets or
1691
+ # key ranges).
1692
+ # @return [Types::JobResource]
1693
+ #
1694
+ # @!attribute [rw] address_id
1695
+ # The ID of the updated Address object.
1696
+ # @return [String]
1697
+ #
1698
+ # @!attribute [rw] shipping_option
1699
+ # The updated shipping option value of this job's ShippingDetails
1700
+ # object.
1701
+ # @return [String]
1702
+ #
1703
+ # @!attribute [rw] description
1704
+ # The updated description of this job's JobMetadata object.
1705
+ # @return [String]
1706
+ #
1707
+ # @!attribute [rw] snowball_capacity_preference
1708
+ # The updated `SnowballCapacityPreference` of this job's JobMetadata
1709
+ # object. The 50 TB Snowballs are only available in the US regions.
1710
+ # @return [String]
1711
+ #
1712
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateJobRequest AWS API Documentation
1713
+ #
1714
+ class UpdateJobRequest < Struct.new(
1715
+ :job_id,
1716
+ :role_arn,
1717
+ :notification,
1718
+ :resources,
1719
+ :address_id,
1720
+ :shipping_option,
1721
+ :description,
1722
+ :snowball_capacity_preference)
1723
+ include Aws::Structure
1724
+ end
1547
1725
 
1548
- class UpdateJobResult < Aws::EmptyStructure; end
1726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/UpdateJobResult AWS API Documentation
1727
+ #
1728
+ class UpdateJobResult < Aws::EmptyStructure; end
1549
1729
 
1550
- end
1551
1730
  end
1552
1731
  end