snowball.d.ts
51.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class Snowball extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Snowball.Types.ClientConfiguration)
config: Config & Snowball.Types.ClientConfiguration;
/**
* Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it.
*/
cancelCluster(params: Snowball.Types.CancelClusterRequest, callback?: (err: AWSError, data: Snowball.Types.CancelClusterResult) => void): Request<Snowball.Types.CancelClusterResult, AWSError>;
/**
* Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it.
*/
cancelCluster(callback?: (err: AWSError, data: Snowball.Types.CancelClusterResult) => void): Request<Snowball.Types.CancelClusterResult, AWSError>;
/**
* Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState as part of the response element data returned.
*/
cancelJob(params: Snowball.Types.CancelJobRequest, callback?: (err: AWSError, data: Snowball.Types.CancelJobResult) => void): Request<Snowball.Types.CancelJobResult, AWSError>;
/**
* Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState as part of the response element data returned.
*/
cancelJob(callback?: (err: AWSError, data: Snowball.Types.CancelJobResult) => void): Request<Snowball.Types.CancelJobResult, AWSError>;
/**
* Creates an address for a Snowball to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.
*/
createAddress(params: Snowball.Types.CreateAddressRequest, callback?: (err: AWSError, data: Snowball.Types.CreateAddressResult) => void): Request<Snowball.Types.CreateAddressResult, AWSError>;
/**
* Creates an address for a Snowball to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.
*/
createAddress(callback?: (err: AWSError, data: Snowball.Types.CreateAddressResult) => void): Request<Snowball.Types.CreateAddressResult, AWSError>;
/**
* Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.
*/
createCluster(params: Snowball.Types.CreateClusterRequest, callback?: (err: AWSError, data: Snowball.Types.CreateClusterResult) => void): Request<Snowball.Types.CreateClusterResult, AWSError>;
/**
* Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.
*/
createCluster(callback?: (err: AWSError, data: Snowball.Types.CreateClusterResult) => void): Request<Snowball.Types.CreateClusterResult, AWSError>;
/**
* Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for Snowball. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.
*/
createJob(params: Snowball.Types.CreateJobRequest, callback?: (err: AWSError, data: Snowball.Types.CreateJobResult) => void): Request<Snowball.Types.CreateJobResult, AWSError>;
/**
* Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for Snowball. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.
*/
createJob(callback?: (err: AWSError, data: Snowball.Types.CreateJobResult) => void): Request<Snowball.Types.CreateJobResult, AWSError>;
/**
* Takes an AddressId and returns specific details about that address in the form of an Address object.
*/
describeAddress(params: Snowball.Types.DescribeAddressRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeAddressResult) => void): Request<Snowball.Types.DescribeAddressResult, AWSError>;
/**
* Takes an AddressId and returns specific details about that address in the form of an Address object.
*/
describeAddress(callback?: (err: AWSError, data: Snowball.Types.DescribeAddressResult) => void): Request<Snowball.Types.DescribeAddressResult, AWSError>;
/**
* Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.
*/
describeAddresses(params: Snowball.Types.DescribeAddressesRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeAddressesResult) => void): Request<Snowball.Types.DescribeAddressesResult, AWSError>;
/**
* Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.
*/
describeAddresses(callback?: (err: AWSError, data: Snowball.Types.DescribeAddressesResult) => void): Request<Snowball.Types.DescribeAddressesResult, AWSError>;
/**
* Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
*/
describeCluster(params: Snowball.Types.DescribeClusterRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeClusterResult) => void): Request<Snowball.Types.DescribeClusterResult, AWSError>;
/**
* Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
*/
describeCluster(callback?: (err: AWSError, data: Snowball.Types.DescribeClusterResult) => void): Request<Snowball.Types.DescribeClusterResult, AWSError>;
/**
* Returns information about a specific job including shipping information, job status, and other important metadata.
*/
describeJob(params: Snowball.Types.DescribeJobRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeJobResult) => void): Request<Snowball.Types.DescribeJobResult, AWSError>;
/**
* Returns information about a specific job including shipping information, job status, and other important metadata.
*/
describeJob(callback?: (err: AWSError, data: Snowball.Types.DescribeJobResult) => void): Request<Snowball.Types.DescribeJobResult, AWSError>;
/**
* Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action. The manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job. The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.
*/
getJobManifest(params: Snowball.Types.GetJobManifestRequest, callback?: (err: AWSError, data: Snowball.Types.GetJobManifestResult) => void): Request<Snowball.Types.GetJobManifestResult, AWSError>;
/**
* Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action. The manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job. The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.
*/
getJobManifest(callback?: (err: AWSError, data: Snowball.Types.GetJobManifestResult) => void): Request<Snowball.Types.GetJobManifestResult, AWSError>;
/**
* Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created. The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.
*/
getJobUnlockCode(params: Snowball.Types.GetJobUnlockCodeRequest, callback?: (err: AWSError, data: Snowball.Types.GetJobUnlockCodeResult) => void): Request<Snowball.Types.GetJobUnlockCodeResult, AWSError>;
/**
* Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created. The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.
*/
getJobUnlockCode(callback?: (err: AWSError, data: Snowball.Types.GetJobUnlockCodeResult) => void): Request<Snowball.Types.GetJobUnlockCodeResult, AWSError>;
/**
* Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use. The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support.
*/
getSnowballUsage(params: Snowball.Types.GetSnowballUsageRequest, callback?: (err: AWSError, data: Snowball.Types.GetSnowballUsageResult) => void): Request<Snowball.Types.GetSnowballUsageResult, AWSError>;
/**
* Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use. The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support.
*/
getSnowballUsage(callback?: (err: AWSError, data: Snowball.Types.GetSnowballUsageResult) => void): Request<Snowball.Types.GetSnowballUsageResult, AWSError>;
/**
* Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
*/
getSoftwareUpdates(params: Snowball.Types.GetSoftwareUpdatesRequest, callback?: (err: AWSError, data: Snowball.Types.GetSoftwareUpdatesResult) => void): Request<Snowball.Types.GetSoftwareUpdatesResult, AWSError>;
/**
* Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
*/
getSoftwareUpdates(callback?: (err: AWSError, data: Snowball.Types.GetSoftwareUpdatesResult) => void): Request<Snowball.Types.GetSoftwareUpdatesResult, AWSError>;
/**
* Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.
*/
listClusterJobs(params: Snowball.Types.ListClusterJobsRequest, callback?: (err: AWSError, data: Snowball.Types.ListClusterJobsResult) => void): Request<Snowball.Types.ListClusterJobsResult, AWSError>;
/**
* Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.
*/
listClusterJobs(callback?: (err: AWSError, data: Snowball.Types.ListClusterJobsResult) => void): Request<Snowball.Types.ListClusterJobsResult, AWSError>;
/**
* Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.
*/
listClusters(params: Snowball.Types.ListClustersRequest, callback?: (err: AWSError, data: Snowball.Types.ListClustersResult) => void): Request<Snowball.Types.ListClustersResult, AWSError>;
/**
* Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.
*/
listClusters(callback?: (err: AWSError, data: Snowball.Types.ListClustersResult) => void): Request<Snowball.Types.ListClustersResult, AWSError>;
/**
* This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your AWS account that would be supported for use on a Snowball Edge device. Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the AWS Marketplace.
*/
listCompatibleImages(params: Snowball.Types.ListCompatibleImagesRequest, callback?: (err: AWSError, data: Snowball.Types.ListCompatibleImagesResult) => void): Request<Snowball.Types.ListCompatibleImagesResult, AWSError>;
/**
* This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your AWS account that would be supported for use on a Snowball Edge device. Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the AWS Marketplace.
*/
listCompatibleImages(callback?: (err: AWSError, data: Snowball.Types.ListCompatibleImagesResult) => void): Request<Snowball.Types.ListCompatibleImagesResult, AWSError>;
/**
* Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.
*/
listJobs(params: Snowball.Types.ListJobsRequest, callback?: (err: AWSError, data: Snowball.Types.ListJobsResult) => void): Request<Snowball.Types.ListJobsResult, AWSError>;
/**
* Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.
*/
listJobs(callback?: (err: AWSError, data: Snowball.Types.ListJobsResult) => void): Request<Snowball.Types.ListJobsResult, AWSError>;
/**
* While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available.
*/
updateCluster(params: Snowball.Types.UpdateClusterRequest, callback?: (err: AWSError, data: Snowball.Types.UpdateClusterResult) => void): Request<Snowball.Types.UpdateClusterResult, AWSError>;
/**
* While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available.
*/
updateCluster(callback?: (err: AWSError, data: Snowball.Types.UpdateClusterResult) => void): Request<Snowball.Types.UpdateClusterResult, AWSError>;
/**
* While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.
*/
updateJob(params: Snowball.Types.UpdateJobRequest, callback?: (err: AWSError, data: Snowball.Types.UpdateJobResult) => void): Request<Snowball.Types.UpdateJobResult, AWSError>;
/**
* While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.
*/
updateJob(callback?: (err: AWSError, data: Snowball.Types.UpdateJobResult) => void): Request<Snowball.Types.UpdateJobResult, AWSError>;
}
declare namespace Snowball {
export interface Address {
/**
* The unique ID for an address.
*/
AddressId?: AddressId;
/**
* The name of a person to receive a Snowball at an address.
*/
Name?: String;
/**
* The name of the company to receive a Snowball at an address.
*/
Company?: String;
/**
* The first line in a street address that a Snowball is to be delivered to.
*/
Street1?: String;
/**
* The second line in a street address that a Snowball is to be delivered to.
*/
Street2?: String;
/**
* The third line in a street address that a Snowball is to be delivered to.
*/
Street3?: String;
/**
* The city in an address that a Snowball is to be delivered to.
*/
City?: String;
/**
* The state or province in an address that a Snowball is to be delivered to.
*/
StateOrProvince?: String;
/**
* This field is no longer used and the value is ignored.
*/
PrefectureOrDistrict?: String;
/**
* This field is no longer used and the value is ignored.
*/
Landmark?: String;
/**
* The country in an address that a Snowball is to be delivered to.
*/
Country?: String;
/**
* The postal code in an address that a Snowball is to be delivered to.
*/
PostalCode?: String;
/**
* The phone number associated with an address that a Snowball is to be delivered to.
*/
PhoneNumber?: String;
/**
* If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.
*/
IsRestricted?: Boolean;
}
export type AddressId = string;
export type AddressList = Address[];
export type AmiId = string;
export type Boolean = boolean;
export interface CancelClusterRequest {
/**
* The 39-character ID for the cluster that you want to cancel, for example CID123e4567-e89b-12d3-a456-426655440000.
*/
ClusterId: ClusterId;
}
export interface CancelClusterResult {
}
export interface CancelJobRequest {
/**
* The 39-character job ID for the job that you want to cancel, for example JID123e4567-e89b-12d3-a456-426655440000.
*/
JobId: JobId;
}
export interface CancelJobResult {
}
export type ClusterId = string;
export interface ClusterListEntry {
/**
* The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000.
*/
ClusterId?: String;
/**
* The current state of this cluster. For information about the state of a specific node, see JobListEntry$JobState.
*/
ClusterState?: ClusterState;
/**
* The creation date for this cluster.
*/
CreationDate?: Timestamp;
/**
* Defines an optional description of the cluster, for example Environmental Data Cluster-01.
*/
Description?: String;
}
export type ClusterListEntryList = ClusterListEntry[];
export interface ClusterMetadata {
/**
* The automatically generated ID for a cluster.
*/
ClusterId?: String;
/**
* The optional description of the cluster.
*/
Description?: String;
/**
* The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in AWS Key Management Service (AWS KMS).
*/
KmsKeyARN?: KmsKeyARN;
/**
* The role ARN associated with this cluster. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).
*/
RoleARN?: RoleARN;
/**
* The current status of the cluster.
*/
ClusterState?: ClusterState;
/**
* The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.
*/
JobType?: JobType;
/**
* The type of AWS Snowball device to use for this cluster. Currently, the only supported device type for cluster jobs is EDGE.
*/
SnowballType?: SnowballType;
/**
* The creation date for this cluster.
*/
CreationDate?: Timestamp;
/**
* The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
*/
Resources?: JobResource;
/**
* The automatically generated ID for a specific address.
*/
AddressId?: AddressId;
/**
* The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows: In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day. In the European Union (EU), you have access to express shipping. Typically, Snowball Edges shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way. In India, Snowball Edges are delivered in one to seven days. In the US, you have access to one-day shipping and two-day shipping.
*/
ShippingOption?: ShippingOption;
/**
* The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
*/
Notification?: Notification;
/**
* The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions.
*/
ForwardingAddressId?: AddressId;
}
export type ClusterState = "AwaitingQuorum"|"Pending"|"InUse"|"Complete"|"Cancelled"|string;
export interface CompatibleImage {
/**
* The unique identifier for an individual Snowball Edge AMI.
*/
AmiId?: String;
/**
* The optional name of a compatible image.
*/
Name?: String;
}
export type CompatibleImageList = CompatibleImage[];
export interface CreateAddressRequest {
/**
* The address that you want the Snowball shipped to.
*/
Address: Address;
}
export interface CreateAddressResult {
/**
* The automatically generated ID for a specific address. You'll use this ID when you create a job to specify which address you want the Snowball for that job shipped to.
*/
AddressId?: String;
}
export interface CreateClusterRequest {
/**
* The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.
*/
JobType: JobType;
/**
* The resources associated with the cluster job. These resources include Amazon S3 buckets and optional AWS Lambda functions written in the Python language.
*/
Resources: JobResource;
/**
* An optional description of this specific cluster, for example Environmental Data Cluster-01.
*/
Description?: String;
/**
* The ID for the address that you want the cluster shipped to.
*/
AddressId: AddressId;
/**
* The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).
*/
KmsKeyARN?: KmsKeyARN;
/**
* The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).
*/
RoleARN: RoleARN;
/**
* The type of AWS Snowball device to use for this cluster. Currently, the only supported device type for cluster jobs is EDGE.
*/
SnowballType?: SnowballType;
/**
* The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows: In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day. In the European Union (EU), you have access to express shipping. Typically, Snowball Edges shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way. In India, Snowball Edges are delivered in one to seven days. In the US, you have access to one-day shipping and two-day shipping.
*/
ShippingOption: ShippingOption;
/**
* The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
*/
Notification?: Notification;
/**
* The forwarding address ID for a cluster. This field is not supported in most regions.
*/
ForwardingAddressId?: AddressId;
}
export interface CreateClusterResult {
/**
* The automatically generated ID for a cluster.
*/
ClusterId?: ClusterId;
}
export interface CreateJobRequest {
/**
* Defines the type of job that you're creating.
*/
JobType?: JobType;
/**
* Defines the Amazon S3 buckets associated with this job. With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into. With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.
*/
Resources?: JobResource;
/**
* Defines an optional description of this specific job, for example Important Photos 2016-08-11.
*/
Description?: String;
/**
* The ID for the address that you want the Snowball shipped to.
*/
AddressId?: AddressId;
/**
* The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action.
*/
KmsKeyARN?: KmsKeyARN;
/**
* The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action.
*/
RoleARN?: RoleARN;
/**
* If your job is being created in one of the US regions, you have the option of specifying what size Snowball you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.
*/
SnowballCapacityPreference?: SnowballCapacity;
/**
* The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snowball, rather it represents how quickly the Snowball moves to its destination while in transit. Regional shipping speeds are as follows: In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In the European Union (EU), you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way. In India, Snowballs are delivered in one to seven days. In the US, you have access to one-day shipping and two-day shipping.
*/
ShippingOption?: ShippingOption;
/**
* Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.
*/
Notification?: Notification;
/**
* The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.
*/
ClusterId?: ClusterId;
/**
* The type of AWS Snowball device to use for this job. Currently, the only supported device type for cluster jobs is EDGE.
*/
SnowballType?: SnowballType;
/**
* The forwarding address ID for a job. This field is not supported in most regions.
*/
ForwardingAddressId?: AddressId;
}
export interface CreateJobResult {
/**
* The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
*/
JobId?: JobId;
}
export interface DataTransfer {
/**
* The number of bytes transferred between a Snowball and Amazon S3.
*/
BytesTransferred?: Long;
/**
* The number of objects transferred between a Snowball and Amazon S3.
*/
ObjectsTransferred?: Long;
/**
* The total bytes of data for a transfer between a Snowball and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.
*/
TotalBytes?: Long;
/**
* The total number of objects for a transfer between a Snowball and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.
*/
TotalObjects?: Long;
}
export interface DescribeAddressRequest {
/**
* The automatically generated ID for a specific address.
*/
AddressId: AddressId;
}
export interface DescribeAddressResult {
/**
* The address that you want the Snowball or Snowballs associated with a specific job to be shipped to.
*/
Address?: Address;
}
export interface DescribeAddressesRequest {
/**
* The number of ADDRESS objects to return.
*/
MaxResults?: ListLimit;
/**
* HTTP requests are stateless. To identify what object comes "next" in the list of ADDRESS objects, you have the option of specifying a value for NextToken as the starting point for your list of returned addresses.
*/
NextToken?: String;
}
export interface DescribeAddressesResult {
/**
* The Snowball shipping addresses that were created for this account.
*/
Addresses?: AddressList;
/**
* HTTP requests are stateless. If you use the automatically generated NextToken value in your next DescribeAddresses call, your list of returned addresses will start from this point in the array.
*/
NextToken?: String;
}
export interface DescribeClusterRequest {
/**
* The automatically generated ID for a cluster.
*/
ClusterId: ClusterId;
}
export interface DescribeClusterResult {
/**
* Information about a specific cluster, including shipping information, cluster status, and other important metadata.
*/
ClusterMetadata?: ClusterMetadata;
}
export interface DescribeJobRequest {
/**
* The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
*/
JobId: JobId;
}
export interface DescribeJobResult {
/**
* Information about a specific job, including shipping information, job status, and other important metadata.
*/
JobMetadata?: JobMetadata;
/**
* Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata.
*/
SubJobMetadata?: JobMetadataList;
}
export interface Ec2AmiResource {
/**
* The ID of the AMI in Amazon EC2.
*/
AmiId: AmiId;
/**
* The ID of the AMI on the Snowball Edge device.
*/
SnowballAmiId?: String;
}
export type Ec2AmiResourceList = Ec2AmiResource[];
export interface EventTriggerDefinition {
/**
* The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an AWS Lambda function's event trigger associated with this job.
*/
EventResourceARN?: ResourceARN;
}
export type EventTriggerDefinitionList = EventTriggerDefinition[];
export interface GetJobManifestRequest {
/**
* The ID for a job that you want to get the manifest file for, for example JID123e4567-e89b-12d3-a456-426655440000.
*/
JobId: JobId;
}
export interface GetJobManifestResult {
/**
* The Amazon S3 presigned URL for the manifest file associated with the specified JobId value.
*/
ManifestURI?: String;
}
export interface GetJobUnlockCodeRequest {
/**
* The ID for the job that you want to get the UnlockCode value for, for example JID123e4567-e89b-12d3-a456-426655440000.
*/
JobId: JobId;
}
export interface GetJobUnlockCodeResult {
/**
* The UnlockCode value for the specified job. The UnlockCode value can be accessed for up to 90 days after the job has been created.
*/
UnlockCode?: String;
}
export interface GetSnowballUsageRequest {
}
export interface GetSnowballUsageResult {
/**
* The service limit for number of Snowballs this account can have at once. The default service limit is 1 (one).
*/
SnowballLimit?: Integer;
/**
* The number of Snowballs that this account is currently using.
*/
SnowballsInUse?: Integer;
}
export interface GetSoftwareUpdatesRequest {
/**
* The ID for a job that you want to get the software update file for, for example JID123e4567-e89b-12d3-a456-426655440000.
*/
JobId: JobId;
}
export interface GetSoftwareUpdatesResult {
/**
* The Amazon S3 presigned URL for the update file associated with the specified JobId value. The software update will be available for 2 days after this request is made. To access an update after the 2 days have passed, you'll have to make another call to GetSoftwareUpdates.
*/
UpdatesURI?: String;
}
export type Integer = number;
export type JobId = string;
export interface JobListEntry {
/**
* The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
*/
JobId?: String;
/**
* The current state of this job.
*/
JobState?: JobState;
/**
* A value that indicates that this job is a master job. A master job represents a successful request to create an export job. Master jobs aren't associated with any Snowballs. Instead, each master job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular master job are listed, because they are created after the master job is created.
*/
IsMaster?: Boolean;
/**
* The type of job.
*/
JobType?: JobType;
/**
* The type of device used with this job.
*/
SnowballType?: SnowballType;
/**
* The creation date for this job.
*/
CreationDate?: Timestamp;
/**
* The optional description of this specific job, for example Important Photos 2016-08-11.
*/
Description?: String;
}
export type JobListEntryList = JobListEntry[];
export interface JobLogs {
/**
* A link to an Amazon S3 presigned URL where the job completion report is located.
*/
JobCompletionReportURI?: String;
/**
* A link to an Amazon S3 presigned URL where the job success log is located.
*/
JobSuccessLogURI?: String;
/**
* A link to an Amazon S3 presigned URL where the job failure log is located.
*/
JobFailureLogURI?: String;
}
export interface JobMetadata {
/**
* The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
*/
JobId?: String;
/**
* The current status of the jobs.
*/
JobState?: JobState;
/**
* The type of job.
*/
JobType?: JobType;
/**
* The type of device used with this job.
*/
SnowballType?: SnowballType;
/**
* The creation date for this job.
*/
CreationDate?: Timestamp;
/**
* An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.
*/
Resources?: JobResource;
/**
* The description of the job, provided at job creation.
*/
Description?: String;
/**
* The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS.
*/
KmsKeyARN?: KmsKeyARN;
/**
* The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).
*/
RoleARN?: RoleARN;
/**
* The ID for the address that you want the Snowball shipped to.
*/
AddressId?: AddressId;
/**
* A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
*/
ShippingDetails?: ShippingDetails;
/**
* The Snowball capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.
*/
SnowballCapacityPreference?: SnowballCapacity;
/**
* The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.
*/
Notification?: Notification;
/**
* A value that defines the real-time status of a Snowball's data transfer while the device is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.
*/
DataTransferProgress?: DataTransfer;
/**
* Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snowball for your job part is being delivered to you.
*/
JobLogInfo?: JobLogs;
/**
* The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.
*/
ClusterId?: String;
/**
* The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.
*/
ForwardingAddressId?: AddressId;
}
export type JobMetadataList = JobMetadata[];
export interface JobResource {
/**
* An array of S3Resource objects.
*/
S3Resources?: S3ResourceList;
/**
* The Python-language Lambda functions for this job.
*/
LambdaResources?: LambdaResourceList;
/**
* The Amazon Machine Images (AMIs) associated with this job.
*/
Ec2AmiResources?: Ec2AmiResourceList;
}
export type JobState = "New"|"PreparingAppliance"|"PreparingShipment"|"InTransitToCustomer"|"WithCustomer"|"InTransitToAWS"|"WithAWSSortingFacility"|"WithAWS"|"InProgress"|"Complete"|"Cancelled"|"Listing"|"Pending"|string;
export type JobStateList = JobState[];
export type JobType = "IMPORT"|"EXPORT"|"LOCAL_USE"|string;
export interface KeyRange {
/**
* The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
*/
BeginMarker?: String;
/**
* The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
*/
EndMarker?: String;
}
export type KmsKeyARN = string;
export interface LambdaResource {
/**
* An Amazon Resource Name (ARN) that represents an AWS Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
*/
LambdaArn?: ResourceARN;
/**
* The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
*/
EventTriggers?: EventTriggerDefinitionList;
}
export type LambdaResourceList = LambdaResource[];
export interface ListClusterJobsRequest {
/**
* The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000.
*/
ClusterId: ClusterId;
/**
* The number of JobListEntry objects to return.
*/
MaxResults?: ListLimit;
/**
* HTTP requests are stateless. To identify what object comes "next" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.
*/
NextToken?: String;
}
export interface ListClusterJobsResult {
/**
* Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs.
*/
JobListEntries?: JobListEntryList;
/**
* HTTP requests are stateless. If you use the automatically generated NextToken value in your next ListClusterJobsResult call, your list of returned jobs will start from this point in the array.
*/
NextToken?: String;
}
export interface ListClustersRequest {
/**
* The number of ClusterListEntry objects to return.
*/
MaxResults?: ListLimit;
/**
* HTTP requests are stateless. To identify what object comes "next" in the list of ClusterListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.
*/
NextToken?: String;
}
export interface ListClustersResult {
/**
* Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.
*/
ClusterListEntries?: ClusterListEntryList;
/**
* HTTP requests are stateless. If you use the automatically generated NextToken value in your next ClusterListEntry call, your list of returned clusters will start from this point in the array.
*/
NextToken?: String;
}
export interface ListCompatibleImagesRequest {
/**
* The maximum number of results for the list of compatible images. Currently, a Snowball Edge device can store 10 AMIs.
*/
MaxResults?: ListLimit;
/**
* HTTP requests are stateless. To identify what object comes "next" in the list of compatible images, you can specify a value for NextToken as the starting point for your list of returned images.
*/
NextToken?: String;
}
export interface ListCompatibleImagesResult {
/**
* A JSON-formatted object that describes a compatible AMI, including the ID and name for a Snowball Edge AMI.
*/
CompatibleImages?: CompatibleImageList;
/**
* Because HTTP requests are stateless, this is the starting point for your next list of returned images.
*/
NextToken?: String;
}
export interface ListJobsRequest {
/**
* The number of JobListEntry objects to return.
*/
MaxResults?: ListLimit;
/**
* HTTP requests are stateless. To identify what object comes "next" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.
*/
NextToken?: String;
}
export interface ListJobsResult {
/**
* Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs.
*/
JobListEntries?: JobListEntryList;
/**
* HTTP requests are stateless. If you use this automatically generated NextToken value in your next ListJobs call, your returned JobListEntry objects will start from this point in the array.
*/
NextToken?: String;
}
export type ListLimit = number;
export type Long = number;
export interface Notification {
/**
* The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action. You can subscribe email addresses to an Amazon SNS topic through the AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.
*/
SnsTopicARN?: SnsTopicARN;
/**
* The list of job states that will trigger a notification for this job.
*/
JobStatesToNotify?: JobStateList;
/**
* Any change in job state will trigger a notification for this job.
*/
NotifyAll?: Boolean;
}
export type ResourceARN = string;
export type RoleARN = string;
export interface S3Resource {
/**
* The Amazon Resource Name (ARN) of an Amazon S3 bucket.
*/
BucketArn?: ResourceARN;
/**
* For export jobs, you can provide an optional KeyRange within a specific Amazon S3 bucket. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted.
*/
KeyRange?: KeyRange;
}
export type S3ResourceList = S3Resource[];
export interface Shipment {
/**
* Status information for a shipment.
*/
Status?: String;
/**
* The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snowball as the carrier transports it. For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.
*/
TrackingNumber?: String;
}
export interface ShippingDetails {
/**
* The shipping speed for a particular job. This speed doesn't dictate how soon you'll get the Snowball from the job's creation date. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows: In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In the European Union (EU), you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way. In India, Snowballs are delivered in one to seven days. In the United States of America (US), you have access to one-day shipping and two-day shipping.
*/
ShippingOption?: ShippingOption;
/**
* The Status and TrackingNumber values for a Snowball being returned to AWS for a particular job.
*/
InboundShipment?: Shipment;
/**
* The Status and TrackingNumber values for a Snowball being delivered to the address that you specified for a particular job.
*/
OutboundShipment?: Shipment;
}
export type ShippingOption = "SECOND_DAY"|"NEXT_DAY"|"EXPRESS"|"STANDARD"|string;
export type SnowballCapacity = "T50"|"T80"|"T100"|"T42"|"NoPreference"|string;
export type SnowballType = "STANDARD"|"EDGE"|"EDGE_C"|"EDGE_CG"|string;
export type SnsTopicARN = string;
export type String = string;
export type Timestamp = Date;
export interface UpdateClusterRequest {
/**
* The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000.
*/
ClusterId: ClusterId;
/**
* The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the CreateRole API action in AWS Identity and Access Management (IAM).
*/
RoleARN?: RoleARN;
/**
* The updated description of this cluster.
*/
Description?: String;
/**
* The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
*/
Resources?: JobResource;
/**
* The ID of the updated Address object.
*/
AddressId?: AddressId;
/**
* The updated shipping option value of this cluster's ShippingDetails object.
*/
ShippingOption?: ShippingOption;
/**
* The new or updated Notification object.
*/
Notification?: Notification;
/**
* The updated ID for the forwarding address for a cluster. This field is not supported in most regions.
*/
ForwardingAddressId?: AddressId;
}
export interface UpdateClusterResult {
}
export interface UpdateJobRequest {
/**
* The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.
*/
JobId: JobId;
/**
* The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRoleAWS Identity and Access Management (IAM) API action.
*/
RoleARN?: RoleARN;
/**
* The new or updated Notification object.
*/
Notification?: Notification;
/**
* The updated JobResource object, or the updated JobResource object.
*/
Resources?: JobResource;
/**
* The ID of the updated Address object.
*/
AddressId?: AddressId;
/**
* The updated shipping option value of this job's ShippingDetails object.
*/
ShippingOption?: ShippingOption;
/**
* The updated description of this job's JobMetadata object.
*/
Description?: String;
/**
* The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US regions.
*/
SnowballCapacityPreference?: SnowballCapacity;
/**
* The updated ID for the forwarding address for a job. This field is not supported in most regions.
*/
ForwardingAddressId?: AddressId;
}
export interface UpdateJobResult {
}
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2016-06-30"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the Snowball client.
*/
export import Types = Snowball;
}
export = Snowball;