UNPKG

13.2 kBJSONView Raw
1{
2 "version": "2.0",
3 "metadata": {
4 "apiVersion": "2016-06-30",
5 "endpointPrefix": "snowball",
6 "jsonVersion": "1.1",
7 "protocol": "json",
8 "serviceAbbreviation": "Amazon Snowball",
9 "serviceFullName": "Amazon Import/Export Snowball",
10 "serviceId": "Snowball",
11 "signatureVersion": "v4",
12 "targetPrefix": "AWSIESnowballJobManagementService",
13 "uid": "snowball-2016-06-30"
14 },
15 "operations": {
16 "CancelCluster": {
17 "input": {
18 "type": "structure",
19 "required": [
20 "ClusterId"
21 ],
22 "members": {
23 "ClusterId": {}
24 }
25 },
26 "output": {
27 "type": "structure",
28 "members": {}
29 }
30 },
31 "CancelJob": {
32 "input": {
33 "type": "structure",
34 "required": [
35 "JobId"
36 ],
37 "members": {
38 "JobId": {}
39 }
40 },
41 "output": {
42 "type": "structure",
43 "members": {}
44 }
45 },
46 "CreateAddress": {
47 "input": {
48 "type": "structure",
49 "required": [
50 "Address"
51 ],
52 "members": {
53 "Address": {
54 "shape": "S8"
55 }
56 }
57 },
58 "output": {
59 "type": "structure",
60 "members": {
61 "AddressId": {}
62 }
63 }
64 },
65 "CreateCluster": {
66 "input": {
67 "type": "structure",
68 "required": [
69 "JobType",
70 "Resources",
71 "AddressId",
72 "RoleARN",
73 "ShippingOption"
74 ],
75 "members": {
76 "JobType": {},
77 "Resources": {
78 "shape": "Sf"
79 },
80 "Description": {},
81 "AddressId": {},
82 "KmsKeyARN": {},
83 "RoleARN": {},
84 "SnowballType": {},
85 "ShippingOption": {},
86 "Notification": {
87 "shape": "Sv"
88 },
89 "ForwardingAddressId": {}
90 }
91 },
92 "output": {
93 "type": "structure",
94 "members": {
95 "ClusterId": {}
96 }
97 }
98 },
99 "CreateJob": {
100 "input": {
101 "type": "structure",
102 "members": {
103 "JobType": {},
104 "Resources": {
105 "shape": "Sf"
106 },
107 "Description": {},
108 "AddressId": {},
109 "KmsKeyARN": {},
110 "RoleARN": {},
111 "SnowballCapacityPreference": {},
112 "ShippingOption": {},
113 "Notification": {
114 "shape": "Sv"
115 },
116 "ClusterId": {},
117 "SnowballType": {},
118 "ForwardingAddressId": {}
119 }
120 },
121 "output": {
122 "type": "structure",
123 "members": {
124 "JobId": {}
125 }
126 }
127 },
128 "DescribeAddress": {
129 "input": {
130 "type": "structure",
131 "required": [
132 "AddressId"
133 ],
134 "members": {
135 "AddressId": {}
136 }
137 },
138 "output": {
139 "type": "structure",
140 "members": {
141 "Address": {
142 "shape": "S8"
143 }
144 }
145 }
146 },
147 "DescribeAddresses": {
148 "input": {
149 "type": "structure",
150 "members": {
151 "MaxResults": {
152 "type": "integer"
153 },
154 "NextToken": {}
155 }
156 },
157 "output": {
158 "type": "structure",
159 "members": {
160 "Addresses": {
161 "type": "list",
162 "member": {
163 "shape": "S8"
164 }
165 },
166 "NextToken": {}
167 }
168 }
169 },
170 "DescribeCluster": {
171 "input": {
172 "type": "structure",
173 "required": [
174 "ClusterId"
175 ],
176 "members": {
177 "ClusterId": {}
178 }
179 },
180 "output": {
181 "type": "structure",
182 "members": {
183 "ClusterMetadata": {
184 "type": "structure",
185 "members": {
186 "ClusterId": {},
187 "Description": {},
188 "KmsKeyARN": {},
189 "RoleARN": {},
190 "ClusterState": {},
191 "JobType": {},
192 "SnowballType": {},
193 "CreationDate": {
194 "type": "timestamp"
195 },
196 "Resources": {
197 "shape": "Sf"
198 },
199 "AddressId": {},
200 "ShippingOption": {},
201 "Notification": {
202 "shape": "Sv"
203 },
204 "ForwardingAddressId": {}
205 }
206 }
207 }
208 }
209 },
210 "DescribeJob": {
211 "input": {
212 "type": "structure",
213 "required": [
214 "JobId"
215 ],
216 "members": {
217 "JobId": {}
218 }
219 },
220 "output": {
221 "type": "structure",
222 "members": {
223 "JobMetadata": {
224 "shape": "S1g"
225 },
226 "SubJobMetadata": {
227 "type": "list",
228 "member": {
229 "shape": "S1g"
230 }
231 }
232 }
233 }
234 },
235 "GetJobManifest": {
236 "input": {
237 "type": "structure",
238 "required": [
239 "JobId"
240 ],
241 "members": {
242 "JobId": {}
243 }
244 },
245 "output": {
246 "type": "structure",
247 "members": {
248 "ManifestURI": {}
249 }
250 }
251 },
252 "GetJobUnlockCode": {
253 "input": {
254 "type": "structure",
255 "required": [
256 "JobId"
257 ],
258 "members": {
259 "JobId": {}
260 }
261 },
262 "output": {
263 "type": "structure",
264 "members": {
265 "UnlockCode": {}
266 }
267 }
268 },
269 "GetSnowballUsage": {
270 "input": {
271 "type": "structure",
272 "members": {}
273 },
274 "output": {
275 "type": "structure",
276 "members": {
277 "SnowballLimit": {
278 "type": "integer"
279 },
280 "SnowballsInUse": {
281 "type": "integer"
282 }
283 }
284 }
285 },
286 "ListClusterJobs": {
287 "input": {
288 "type": "structure",
289 "required": [
290 "ClusterId"
291 ],
292 "members": {
293 "ClusterId": {},
294 "MaxResults": {
295 "type": "integer"
296 },
297 "NextToken": {}
298 }
299 },
300 "output": {
301 "type": "structure",
302 "members": {
303 "JobListEntries": {
304 "shape": "S1w"
305 },
306 "NextToken": {}
307 }
308 }
309 },
310 "ListClusters": {
311 "input": {
312 "type": "structure",
313 "members": {
314 "MaxResults": {
315 "type": "integer"
316 },
317 "NextToken": {}
318 }
319 },
320 "output": {
321 "type": "structure",
322 "members": {
323 "ClusterListEntries": {
324 "type": "list",
325 "member": {
326 "type": "structure",
327 "members": {
328 "ClusterId": {},
329 "ClusterState": {},
330 "CreationDate": {
331 "type": "timestamp"
332 },
333 "Description": {}
334 }
335 }
336 },
337 "NextToken": {}
338 }
339 }
340 },
341 "ListCompatibleImages": {
342 "input": {
343 "type": "structure",
344 "members": {
345 "MaxResults": {
346 "type": "integer"
347 },
348 "NextToken": {}
349 }
350 },
351 "output": {
352 "type": "structure",
353 "members": {
354 "CompatibleImages": {
355 "type": "list",
356 "member": {
357 "type": "structure",
358 "members": {
359 "AmiId": {},
360 "Name": {}
361 }
362 }
363 },
364 "NextToken": {}
365 }
366 }
367 },
368 "ListJobs": {
369 "input": {
370 "type": "structure",
371 "members": {
372 "MaxResults": {
373 "type": "integer"
374 },
375 "NextToken": {}
376 }
377 },
378 "output": {
379 "type": "structure",
380 "members": {
381 "JobListEntries": {
382 "shape": "S1w"
383 },
384 "NextToken": {}
385 }
386 }
387 },
388 "UpdateCluster": {
389 "input": {
390 "type": "structure",
391 "required": [
392 "ClusterId"
393 ],
394 "members": {
395 "ClusterId": {},
396 "RoleARN": {},
397 "Description": {},
398 "Resources": {
399 "shape": "Sf"
400 },
401 "AddressId": {},
402 "ShippingOption": {},
403 "Notification": {
404 "shape": "Sv"
405 },
406 "ForwardingAddressId": {}
407 }
408 },
409 "output": {
410 "type": "structure",
411 "members": {}
412 }
413 },
414 "UpdateJob": {
415 "input": {
416 "type": "structure",
417 "required": [
418 "JobId"
419 ],
420 "members": {
421 "JobId": {},
422 "RoleARN": {},
423 "Notification": {
424 "shape": "Sv"
425 },
426 "Resources": {
427 "shape": "Sf"
428 },
429 "AddressId": {},
430 "ShippingOption": {},
431 "Description": {},
432 "SnowballCapacityPreference": {},
433 "ForwardingAddressId": {}
434 }
435 },
436 "output": {
437 "type": "structure",
438 "members": {}
439 }
440 }
441 },
442 "shapes": {
443 "S8": {
444 "type": "structure",
445 "members": {
446 "AddressId": {},
447 "Name": {},
448 "Company": {},
449 "Street1": {},
450 "Street2": {},
451 "Street3": {},
452 "City": {},
453 "StateOrProvince": {},
454 "PrefectureOrDistrict": {},
455 "Landmark": {},
456 "Country": {},
457 "PostalCode": {},
458 "PhoneNumber": {},
459 "IsRestricted": {
460 "type": "boolean"
461 }
462 }
463 },
464 "Sf": {
465 "type": "structure",
466 "members": {
467 "S3Resources": {
468 "type": "list",
469 "member": {
470 "type": "structure",
471 "members": {
472 "BucketArn": {},
473 "KeyRange": {
474 "type": "structure",
475 "members": {
476 "BeginMarker": {},
477 "EndMarker": {}
478 }
479 }
480 }
481 }
482 },
483 "LambdaResources": {
484 "type": "list",
485 "member": {
486 "type": "structure",
487 "members": {
488 "LambdaArn": {},
489 "EventTriggers": {
490 "type": "list",
491 "member": {
492 "type": "structure",
493 "members": {
494 "EventResourceARN": {}
495 }
496 }
497 }
498 }
499 }
500 },
501 "Ec2AmiResources": {
502 "type": "list",
503 "member": {
504 "type": "structure",
505 "required": [
506 "AmiId"
507 ],
508 "members": {
509 "AmiId": {},
510 "SnowballAmiId": {}
511 }
512 }
513 }
514 }
515 },
516 "Sv": {
517 "type": "structure",
518 "members": {
519 "SnsTopicARN": {},
520 "JobStatesToNotify": {
521 "type": "list",
522 "member": {}
523 },
524 "NotifyAll": {
525 "type": "boolean"
526 }
527 }
528 },
529 "S1g": {
530 "type": "structure",
531 "members": {
532 "JobId": {},
533 "JobState": {},
534 "JobType": {},
535 "SnowballType": {},
536 "CreationDate": {
537 "type": "timestamp"
538 },
539 "Resources": {
540 "shape": "Sf"
541 },
542 "Description": {},
543 "KmsKeyARN": {},
544 "RoleARN": {},
545 "AddressId": {},
546 "ShippingDetails": {
547 "type": "structure",
548 "members": {
549 "ShippingOption": {},
550 "InboundShipment": {
551 "shape": "S1i"
552 },
553 "OutboundShipment": {
554 "shape": "S1i"
555 }
556 }
557 },
558 "SnowballCapacityPreference": {},
559 "Notification": {
560 "shape": "Sv"
561 },
562 "DataTransferProgress": {
563 "type": "structure",
564 "members": {
565 "BytesTransferred": {
566 "type": "long"
567 },
568 "ObjectsTransferred": {
569 "type": "long"
570 },
571 "TotalBytes": {
572 "type": "long"
573 },
574 "TotalObjects": {
575 "type": "long"
576 }
577 }
578 },
579 "JobLogInfo": {
580 "type": "structure",
581 "members": {
582 "JobCompletionReportURI": {},
583 "JobSuccessLogURI": {},
584 "JobFailureLogURI": {}
585 }
586 },
587 "ClusterId": {},
588 "ForwardingAddressId": {}
589 }
590 },
591 "S1i": {
592 "type": "structure",
593 "members": {
594 "Status": {},
595 "TrackingNumber": {}
596 }
597 },
598 "S1w": {
599 "type": "list",
600 "member": {
601 "type": "structure",
602 "members": {
603 "JobId": {},
604 "JobState": {},
605 "IsMaster": {
606 "type": "boolean"
607 },
608 "JobType": {},
609 "SnowballType": {},
610 "CreationDate": {
611 "type": "timestamp"
612 },
613 "Description": {}
614 }
615 }
616 }
617 }
618}
\No newline at end of file