@aws-sdk/client-snowball 3.379.1 → 3.382.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +271 -0
- package/package.json +5 -5
|
@@ -22,67 +22,82 @@ export type AddressType = (typeof AddressType)[keyof typeof AddressType];
|
|
|
22
22
|
*/
|
|
23
23
|
export interface Address {
|
|
24
24
|
/**
|
|
25
|
+
* @public
|
|
25
26
|
* <p>The unique ID for an address.</p>
|
|
26
27
|
*/
|
|
27
28
|
AddressId?: string;
|
|
28
29
|
/**
|
|
30
|
+
* @public
|
|
29
31
|
* <p>The name of a person to receive a Snow device at an address.</p>
|
|
30
32
|
*/
|
|
31
33
|
Name?: string;
|
|
32
34
|
/**
|
|
35
|
+
* @public
|
|
33
36
|
* <p>The name of the company to receive a Snow device at an address.</p>
|
|
34
37
|
*/
|
|
35
38
|
Company?: string;
|
|
36
39
|
/**
|
|
40
|
+
* @public
|
|
37
41
|
* <p>The first line in a street address that a Snow device is to be delivered
|
|
38
42
|
* to.</p>
|
|
39
43
|
*/
|
|
40
44
|
Street1?: string;
|
|
41
45
|
/**
|
|
46
|
+
* @public
|
|
42
47
|
* <p>The second line in a street address that a Snow device is to be delivered
|
|
43
48
|
* to.</p>
|
|
44
49
|
*/
|
|
45
50
|
Street2?: string;
|
|
46
51
|
/**
|
|
52
|
+
* @public
|
|
47
53
|
* <p>The third line in a street address that a Snow device is to be delivered
|
|
48
54
|
* to.</p>
|
|
49
55
|
*/
|
|
50
56
|
Street3?: string;
|
|
51
57
|
/**
|
|
58
|
+
* @public
|
|
52
59
|
* <p>The city in an address that a Snow device is to be delivered to.</p>
|
|
53
60
|
*/
|
|
54
61
|
City?: string;
|
|
55
62
|
/**
|
|
63
|
+
* @public
|
|
56
64
|
* <p>The state or province in an address that a Snow device is to be delivered to.</p>
|
|
57
65
|
*/
|
|
58
66
|
StateOrProvince?: string;
|
|
59
67
|
/**
|
|
68
|
+
* @public
|
|
60
69
|
* <p>This field is no longer used and the value is ignored.</p>
|
|
61
70
|
*/
|
|
62
71
|
PrefectureOrDistrict?: string;
|
|
63
72
|
/**
|
|
73
|
+
* @public
|
|
64
74
|
* <p>This field is no longer used and the value is ignored.</p>
|
|
65
75
|
*/
|
|
66
76
|
Landmark?: string;
|
|
67
77
|
/**
|
|
78
|
+
* @public
|
|
68
79
|
* <p>The country in an address that a Snow device is to be delivered to.</p>
|
|
69
80
|
*/
|
|
70
81
|
Country?: string;
|
|
71
82
|
/**
|
|
83
|
+
* @public
|
|
72
84
|
* <p>The postal code in an address that a Snow device is to be delivered to.</p>
|
|
73
85
|
*/
|
|
74
86
|
PostalCode?: string;
|
|
75
87
|
/**
|
|
88
|
+
* @public
|
|
76
89
|
* <p>The phone number associated with an address that a Snow device is to be delivered
|
|
77
90
|
* to.</p>
|
|
78
91
|
*/
|
|
79
92
|
PhoneNumber?: string;
|
|
80
93
|
/**
|
|
94
|
+
* @public
|
|
81
95
|
* <p>If the address you are creating is a primary address, then set this option to
|
|
82
96
|
* true. This field is not supported in most regions.</p>
|
|
83
97
|
*/
|
|
84
98
|
IsRestricted?: boolean;
|
|
85
99
|
/**
|
|
100
|
+
* @public
|
|
86
101
|
* <p>Differentiates between delivery address and pickup address in the customer account. Provided at job creation.</p>
|
|
87
102
|
*/
|
|
88
103
|
Type?: AddressType | string;
|
|
@@ -92,6 +107,7 @@ export interface Address {
|
|
|
92
107
|
*/
|
|
93
108
|
export interface CancelClusterRequest {
|
|
94
109
|
/**
|
|
110
|
+
* @public
|
|
95
111
|
* <p>The 39-character ID for the cluster that you want to cancel, for example
|
|
96
112
|
* <code>CID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
97
113
|
*/
|
|
@@ -126,6 +142,7 @@ export declare class InvalidResourceException extends __BaseException {
|
|
|
126
142
|
readonly $fault: "client";
|
|
127
143
|
Message?: string;
|
|
128
144
|
/**
|
|
145
|
+
* @public
|
|
129
146
|
* <p>The provided resource value is invalid.</p>
|
|
130
147
|
*/
|
|
131
148
|
ResourceType?: string;
|
|
@@ -153,6 +170,7 @@ export declare class KMSRequestFailedException extends __BaseException {
|
|
|
153
170
|
*/
|
|
154
171
|
export interface CancelJobRequest {
|
|
155
172
|
/**
|
|
173
|
+
* @public
|
|
156
174
|
* <p>The 39-character job ID for the job that you want to cancel, for example
|
|
157
175
|
* <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
158
176
|
*/
|
|
@@ -168,6 +186,7 @@ export interface CancelJobResult {
|
|
|
168
186
|
*/
|
|
169
187
|
export interface CreateAddressRequest {
|
|
170
188
|
/**
|
|
189
|
+
* @public
|
|
171
190
|
* <p>The address that you want the Snow device shipped to.</p>
|
|
172
191
|
*/
|
|
173
192
|
Address: Address | undefined;
|
|
@@ -177,6 +196,7 @@ export interface CreateAddressRequest {
|
|
|
177
196
|
*/
|
|
178
197
|
export interface CreateAddressResult {
|
|
179
198
|
/**
|
|
199
|
+
* @public
|
|
180
200
|
* <p>The automatically generated ID for a specific address. You'll use this ID when you
|
|
181
201
|
* create a job to specify which address you want the Snow device for that job shipped
|
|
182
202
|
* to.</p>
|
|
@@ -261,6 +281,7 @@ export type JobState = (typeof JobState)[keyof typeof JobState];
|
|
|
261
281
|
*/
|
|
262
282
|
export interface Notification {
|
|
263
283
|
/**
|
|
284
|
+
* @public
|
|
264
285
|
* <p>The new SNS <code>TopicArn</code> that you want to associate with this job. You can
|
|
265
286
|
* create Amazon Resource Names (ARNs) for topics by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html">CreateTopic</a> Amazon SNS API
|
|
266
287
|
* action.</p>
|
|
@@ -269,14 +290,17 @@ export interface Notification {
|
|
|
269
290
|
*/
|
|
270
291
|
SnsTopicARN?: string;
|
|
271
292
|
/**
|
|
293
|
+
* @public
|
|
272
294
|
* <p>The list of job states that will trigger a notification for this job.</p>
|
|
273
295
|
*/
|
|
274
296
|
JobStatesToNotify?: (JobState | string)[];
|
|
275
297
|
/**
|
|
298
|
+
* @public
|
|
276
299
|
* <p>Any change in job state will trigger a notification for this job.</p>
|
|
277
300
|
*/
|
|
278
301
|
NotifyAll?: boolean;
|
|
279
302
|
/**
|
|
303
|
+
* @public
|
|
280
304
|
* <p>Used to send SNS notifications for the person picking up the device (identified during job creation).</p>
|
|
281
305
|
*/
|
|
282
306
|
DevicePickupSnsTopicARN?: string;
|
|
@@ -287,10 +311,12 @@ export interface Notification {
|
|
|
287
311
|
*/
|
|
288
312
|
export interface EKSOnDeviceServiceConfiguration {
|
|
289
313
|
/**
|
|
314
|
+
* @public
|
|
290
315
|
* <p>The Kubernetes version for EKS Anywhere on the Snow Family device.</p>
|
|
291
316
|
*/
|
|
292
317
|
KubernetesVersion?: string;
|
|
293
318
|
/**
|
|
319
|
+
* @public
|
|
294
320
|
* <p>The version of EKS Anywhere on the Snow Family device.</p>
|
|
295
321
|
*/
|
|
296
322
|
EKSAnywhereVersion?: string;
|
|
@@ -313,10 +339,12 @@ export type StorageUnit = (typeof StorageUnit)[keyof typeof StorageUnit];
|
|
|
313
339
|
*/
|
|
314
340
|
export interface NFSOnDeviceServiceConfiguration {
|
|
315
341
|
/**
|
|
342
|
+
* @public
|
|
316
343
|
* <p>The maximum NFS storage for one Snow Family device.</p>
|
|
317
344
|
*/
|
|
318
345
|
StorageLimit?: number;
|
|
319
346
|
/**
|
|
347
|
+
* @public
|
|
320
348
|
* <p>The scale unit of the NFS storage on the device.</p>
|
|
321
349
|
* <p>Valid values: TB.</p>
|
|
322
350
|
*/
|
|
@@ -328,20 +356,24 @@ export interface NFSOnDeviceServiceConfiguration {
|
|
|
328
356
|
*/
|
|
329
357
|
export interface S3OnDeviceServiceConfiguration {
|
|
330
358
|
/**
|
|
359
|
+
* @public
|
|
331
360
|
* <p>If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used.
|
|
332
361
|
* If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has
|
|
333
362
|
* the same storage limit as specified, the other input need to be provided.</p>
|
|
334
363
|
*/
|
|
335
364
|
StorageLimit?: number;
|
|
336
365
|
/**
|
|
366
|
+
* @public
|
|
337
367
|
* <p>Storage unit. Currently the only supported unit is TB.</p>
|
|
338
368
|
*/
|
|
339
369
|
StorageUnit?: StorageUnit | string;
|
|
340
370
|
/**
|
|
371
|
+
* @public
|
|
341
372
|
* <p>Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.</p>
|
|
342
373
|
*/
|
|
343
374
|
ServiceSize?: number;
|
|
344
375
|
/**
|
|
376
|
+
* @public
|
|
345
377
|
* <p>>Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified <code>StorageLimit</code> matches more than one Amazon S3 compatible storage on Snow family devices service configuration.</p>
|
|
346
378
|
*/
|
|
347
379
|
FaultTolerance?: number;
|
|
@@ -353,11 +385,13 @@ export interface S3OnDeviceServiceConfiguration {
|
|
|
353
385
|
*/
|
|
354
386
|
export interface TGWOnDeviceServiceConfiguration {
|
|
355
387
|
/**
|
|
388
|
+
* @public
|
|
356
389
|
* <p>The maximum number of virtual tapes to store on one Snow Family device. Due to physical
|
|
357
390
|
* resource limitations, this value must be set to 80 for Snowball Edge.</p>
|
|
358
391
|
*/
|
|
359
392
|
StorageLimit?: number;
|
|
360
393
|
/**
|
|
394
|
+
* @public
|
|
361
395
|
* <p>The scale unit of the virtual tapes on the device.</p>
|
|
362
396
|
*/
|
|
363
397
|
StorageUnit?: StorageUnit | string;
|
|
@@ -369,18 +403,22 @@ export interface TGWOnDeviceServiceConfiguration {
|
|
|
369
403
|
*/
|
|
370
404
|
export interface OnDeviceServiceConfiguration {
|
|
371
405
|
/**
|
|
406
|
+
* @public
|
|
372
407
|
* <p>Represents the NFS (Network File System) service on a Snow Family device.</p>
|
|
373
408
|
*/
|
|
374
409
|
NFSOnDeviceService?: NFSOnDeviceServiceConfiguration;
|
|
375
410
|
/**
|
|
411
|
+
* @public
|
|
376
412
|
* <p>Represents the Storage Gateway service Tape Gateway type on a Snow Family device.</p>
|
|
377
413
|
*/
|
|
378
414
|
TGWOnDeviceService?: TGWOnDeviceServiceConfiguration;
|
|
379
415
|
/**
|
|
416
|
+
* @public
|
|
380
417
|
* <p>The configuration of EKS Anywhere on the Snow Family device.</p>
|
|
381
418
|
*/
|
|
382
419
|
EKSOnDeviceService?: EKSOnDeviceServiceConfiguration;
|
|
383
420
|
/**
|
|
421
|
+
* @public
|
|
384
422
|
* <p>Configuration for Amazon S3 compatible storage on Snow family devices.</p>
|
|
385
423
|
*/
|
|
386
424
|
S3OnDeviceService?: S3OnDeviceServiceConfiguration;
|
|
@@ -406,10 +444,12 @@ export type RemoteManagement = (typeof RemoteManagement)[keyof typeof RemoteMana
|
|
|
406
444
|
*/
|
|
407
445
|
export interface Ec2AmiResource {
|
|
408
446
|
/**
|
|
447
|
+
* @public
|
|
409
448
|
* <p>The ID of the AMI in Amazon EC2.</p>
|
|
410
449
|
*/
|
|
411
450
|
AmiId: string | undefined;
|
|
412
451
|
/**
|
|
452
|
+
* @public
|
|
413
453
|
* <p>The ID of the AMI on the Snow device.</p>
|
|
414
454
|
*/
|
|
415
455
|
SnowballAmiId?: string;
|
|
@@ -420,6 +460,7 @@ export interface Ec2AmiResource {
|
|
|
420
460
|
*/
|
|
421
461
|
export interface EventTriggerDefinition {
|
|
422
462
|
/**
|
|
463
|
+
* @public
|
|
423
464
|
* <p>The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.</p>
|
|
424
465
|
*/
|
|
425
466
|
EventResourceARN?: string;
|
|
@@ -430,11 +471,13 @@ export interface EventTriggerDefinition {
|
|
|
430
471
|
*/
|
|
431
472
|
export interface LambdaResource {
|
|
432
473
|
/**
|
|
474
|
+
* @public
|
|
433
475
|
* <p>An Amazon Resource Name (ARN) that represents an Lambda function to be
|
|
434
476
|
* triggered by PUT object actions on the associated local Amazon S3 resource.</p>
|
|
435
477
|
*/
|
|
436
478
|
LambdaArn?: string;
|
|
437
479
|
/**
|
|
480
|
+
* @public
|
|
438
481
|
* <p>The array of ARNs for <a>S3Resource</a> objects to trigger the <a>LambdaResource</a> objects associated with this job.</p>
|
|
439
482
|
*/
|
|
440
483
|
EventTriggers?: EventTriggerDefinition[];
|
|
@@ -448,11 +491,13 @@ export interface LambdaResource {
|
|
|
448
491
|
*/
|
|
449
492
|
export interface KeyRange {
|
|
450
493
|
/**
|
|
494
|
+
* @public
|
|
451
495
|
* <p>The key that starts an optional key range for an export job. Ranges are inclusive and
|
|
452
496
|
* UTF-8 binary sorted.</p>
|
|
453
497
|
*/
|
|
454
498
|
BeginMarker?: string;
|
|
455
499
|
/**
|
|
500
|
+
* @public
|
|
456
501
|
* <p>The key that ends an optional key range for an export job. Ranges are inclusive and
|
|
457
502
|
* UTF-8 binary sorted.</p>
|
|
458
503
|
*/
|
|
@@ -491,11 +536,13 @@ export type TransferOption = (typeof TransferOption)[keyof typeof TransferOption
|
|
|
491
536
|
*/
|
|
492
537
|
export interface TargetOnDeviceService {
|
|
493
538
|
/**
|
|
539
|
+
* @public
|
|
494
540
|
* <p>Specifies the name of the service on the Snow Family device that your transferred data
|
|
495
541
|
* will be exported from or imported into.</p>
|
|
496
542
|
*/
|
|
497
543
|
ServiceName?: DeviceServiceName | string;
|
|
498
544
|
/**
|
|
545
|
+
* @public
|
|
499
546
|
* <p>Specifies whether the data is being imported or exported. You can import or export the
|
|
500
547
|
* data, or use it locally on the device.</p>
|
|
501
548
|
*/
|
|
@@ -511,10 +558,12 @@ export interface TargetOnDeviceService {
|
|
|
511
558
|
*/
|
|
512
559
|
export interface S3Resource {
|
|
513
560
|
/**
|
|
561
|
+
* @public
|
|
514
562
|
* <p>The Amazon Resource Name (ARN) of an Amazon S3 bucket.</p>
|
|
515
563
|
*/
|
|
516
564
|
BucketArn?: string;
|
|
517
565
|
/**
|
|
566
|
+
* @public
|
|
518
567
|
* <p>For export jobs, you can provide an optional <code>KeyRange</code> within a specific
|
|
519
568
|
* Amazon S3 bucket. The length of the range is defined at job creation, and has either an
|
|
520
569
|
* inclusive <code>BeginMarker</code>, an inclusive <code>EndMarker</code>, or both. Ranges are
|
|
@@ -522,6 +571,7 @@ export interface S3Resource {
|
|
|
522
571
|
*/
|
|
523
572
|
KeyRange?: KeyRange;
|
|
524
573
|
/**
|
|
574
|
+
* @public
|
|
525
575
|
* <p>Specifies the service or services on the Snow Family device that your transferred data
|
|
526
576
|
* will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File
|
|
527
577
|
* System).</p>
|
|
@@ -536,14 +586,17 @@ export interface S3Resource {
|
|
|
536
586
|
*/
|
|
537
587
|
export interface JobResource {
|
|
538
588
|
/**
|
|
589
|
+
* @public
|
|
539
590
|
* <p>An array of <code>S3Resource</code> objects.</p>
|
|
540
591
|
*/
|
|
541
592
|
S3Resources?: S3Resource[];
|
|
542
593
|
/**
|
|
594
|
+
* @public
|
|
543
595
|
* <p>The Python-language Lambda functions for this job.</p>
|
|
544
596
|
*/
|
|
545
597
|
LambdaResources?: LambdaResource[];
|
|
546
598
|
/**
|
|
599
|
+
* @public
|
|
547
600
|
* <p>The Amazon Machine Images (AMIs) associated with this job.</p>
|
|
548
601
|
*/
|
|
549
602
|
Ec2AmiResources?: Ec2AmiResource[];
|
|
@@ -609,6 +662,7 @@ export type SnowballType = (typeof SnowballType)[keyof typeof SnowballType];
|
|
|
609
662
|
*/
|
|
610
663
|
export interface INDTaxDocuments {
|
|
611
664
|
/**
|
|
665
|
+
* @public
|
|
612
666
|
* <p>The Goods and Services Tax (GST) documents required in Amazon Web Services Region in
|
|
613
667
|
* India.</p>
|
|
614
668
|
*/
|
|
@@ -620,6 +674,7 @@ export interface INDTaxDocuments {
|
|
|
620
674
|
*/
|
|
621
675
|
export interface TaxDocuments {
|
|
622
676
|
/**
|
|
677
|
+
* @public
|
|
623
678
|
* <p>The tax documents required in Amazon Web Services Region in India.</p>
|
|
624
679
|
*/
|
|
625
680
|
IND?: INDTaxDocuments;
|
|
@@ -629,6 +684,7 @@ export interface TaxDocuments {
|
|
|
629
684
|
*/
|
|
630
685
|
export interface CreateClusterRequest {
|
|
631
686
|
/**
|
|
687
|
+
* @public
|
|
632
688
|
* <p>The type of job for this cluster. Currently, the only job type supported for clusters
|
|
633
689
|
* is <code>LOCAL_USE</code>.</p>
|
|
634
690
|
* <p>For more information, see
|
|
@@ -639,37 +695,44 @@ export interface CreateClusterRequest {
|
|
|
639
695
|
*/
|
|
640
696
|
JobType: JobType | string | undefined;
|
|
641
697
|
/**
|
|
698
|
+
* @public
|
|
642
699
|
* <p>The resources associated with the cluster job. These resources include Amazon S3
|
|
643
700
|
* buckets and optional Lambda functions written in the Python language.
|
|
644
701
|
* </p>
|
|
645
702
|
*/
|
|
646
703
|
Resources?: JobResource;
|
|
647
704
|
/**
|
|
705
|
+
* @public
|
|
648
706
|
* <p>Specifies the service or services on the Snow Family device that your transferred data
|
|
649
707
|
* will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS
|
|
650
708
|
* (Network File System).</p>
|
|
651
709
|
*/
|
|
652
710
|
OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration;
|
|
653
711
|
/**
|
|
712
|
+
* @public
|
|
654
713
|
* <p>An optional description of this specific cluster, for example <code>Environmental Data
|
|
655
714
|
* Cluster-01</code>.</p>
|
|
656
715
|
*/
|
|
657
716
|
Description?: string;
|
|
658
717
|
/**
|
|
718
|
+
* @public
|
|
659
719
|
* <p>The ID for the address that you want the cluster shipped to.</p>
|
|
660
720
|
*/
|
|
661
721
|
AddressId: string | undefined;
|
|
662
722
|
/**
|
|
723
|
+
* @public
|
|
663
724
|
* <p>The <code>KmsKeyARN</code> value that you want to associate with this cluster.
|
|
664
725
|
* <code>KmsKeyARN</code> values are created by using the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a> API action in Key Management Service (KMS). </p>
|
|
665
726
|
*/
|
|
666
727
|
KmsKeyARN?: string;
|
|
667
728
|
/**
|
|
729
|
+
* @public
|
|
668
730
|
* <p>The <code>RoleARN</code> that you want to associate with this cluster.
|
|
669
731
|
* <code>RoleArn</code> values are created by using the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> API action in Identity and Access Management (IAM).</p>
|
|
670
732
|
*/
|
|
671
733
|
RoleARN?: string;
|
|
672
734
|
/**
|
|
735
|
+
* @public
|
|
673
736
|
* <p>The type of Snow Family devices to use for this cluster. </p>
|
|
674
737
|
* <note>
|
|
675
738
|
* <p>For cluster jobs, Amazon Web Services Snow Family currently supports only the
|
|
@@ -683,6 +746,7 @@ export interface CreateClusterRequest {
|
|
|
683
746
|
*/
|
|
684
747
|
SnowballType: SnowballType | string | undefined;
|
|
685
748
|
/**
|
|
749
|
+
* @public
|
|
686
750
|
* <p>The shipping speed for each node in this cluster. This speed doesn't dictate how soon
|
|
687
751
|
* you'll get each Snowball Edge device, rather it represents how quickly each device moves to
|
|
688
752
|
* its destination while in transit. Regional shipping speeds are as follows: </p>
|
|
@@ -726,20 +790,24 @@ export interface CreateClusterRequest {
|
|
|
726
790
|
*/
|
|
727
791
|
ShippingOption: ShippingOption | string | undefined;
|
|
728
792
|
/**
|
|
793
|
+
* @public
|
|
729
794
|
* <p>The Amazon Simple Notification Service (Amazon SNS) notification settings for this
|
|
730
795
|
* cluster.</p>
|
|
731
796
|
*/
|
|
732
797
|
Notification?: Notification;
|
|
733
798
|
/**
|
|
799
|
+
* @public
|
|
734
800
|
* <p>The forwarding address ID for a cluster. This field is not supported in most
|
|
735
801
|
* regions.</p>
|
|
736
802
|
*/
|
|
737
803
|
ForwardingAddressId?: string;
|
|
738
804
|
/**
|
|
805
|
+
* @public
|
|
739
806
|
* <p>The tax documents required in your Amazon Web Services Region.</p>
|
|
740
807
|
*/
|
|
741
808
|
TaxDocuments?: TaxDocuments;
|
|
742
809
|
/**
|
|
810
|
+
* @public
|
|
743
811
|
* <p>Allows you to securely operate and manage Snow devices in a cluster remotely from outside
|
|
744
812
|
* of your internal network. When set to <code>INSTALLED_AUTOSTART</code>, remote management will
|
|
745
813
|
* automatically be available when the device arrives at your location. Otherwise, you need to
|
|
@@ -747,19 +815,23 @@ export interface CreateClusterRequest {
|
|
|
747
815
|
*/
|
|
748
816
|
RemoteManagement?: RemoteManagement | string;
|
|
749
817
|
/**
|
|
818
|
+
* @public
|
|
750
819
|
* <p>If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.</p>
|
|
751
820
|
*/
|
|
752
821
|
InitialClusterSize?: number;
|
|
753
822
|
/**
|
|
823
|
+
* @public
|
|
754
824
|
* <p>Force to create cluster when user attempts to overprovision or underprovision a cluster. A cluster is overprovisioned or underprovisioned if the initial size of the cluster is more (overprovisioned) or less (underprovisioned) than what
|
|
755
825
|
* needed to meet capacity requirement specified with <code>OnDeviceServiceConfiguration</code>.</p>
|
|
756
826
|
*/
|
|
757
827
|
ForceCreateJobs?: boolean;
|
|
758
828
|
/**
|
|
829
|
+
* @public
|
|
759
830
|
* <p>Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.</p>
|
|
760
831
|
*/
|
|
761
832
|
LongTermPricingIds?: string[];
|
|
762
833
|
/**
|
|
834
|
+
* @public
|
|
763
835
|
* <p>If your job is being created in one of the US regions, you have the option of
|
|
764
836
|
* specifying what size Snow device you'd like for this job. In all other regions, Snowballs come
|
|
765
837
|
* with 80 TB in storage capacity.</p>
|
|
@@ -778,15 +850,18 @@ export interface CreateClusterRequest {
|
|
|
778
850
|
*/
|
|
779
851
|
export interface JobListEntry {
|
|
780
852
|
/**
|
|
853
|
+
* @public
|
|
781
854
|
* <p>The automatically generated ID for a job, for example
|
|
782
855
|
* <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
783
856
|
*/
|
|
784
857
|
JobId?: string;
|
|
785
858
|
/**
|
|
859
|
+
* @public
|
|
786
860
|
* <p>The current state of this job.</p>
|
|
787
861
|
*/
|
|
788
862
|
JobState?: JobState | string;
|
|
789
863
|
/**
|
|
864
|
+
* @public
|
|
790
865
|
* <p>A value that indicates that this job is a main job. A main job represents a successful
|
|
791
866
|
* request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each
|
|
792
867
|
* main job will have at least one job part, and each job part is associated with a Snowball. It
|
|
@@ -795,18 +870,22 @@ export interface JobListEntry {
|
|
|
795
870
|
*/
|
|
796
871
|
IsMaster?: boolean;
|
|
797
872
|
/**
|
|
873
|
+
* @public
|
|
798
874
|
* <p>The type of job.</p>
|
|
799
875
|
*/
|
|
800
876
|
JobType?: JobType | string;
|
|
801
877
|
/**
|
|
878
|
+
* @public
|
|
802
879
|
* <p>The type of device used with this job.</p>
|
|
803
880
|
*/
|
|
804
881
|
SnowballType?: SnowballType | string;
|
|
805
882
|
/**
|
|
883
|
+
* @public
|
|
806
884
|
* <p>The creation date for this job.</p>
|
|
807
885
|
*/
|
|
808
886
|
CreationDate?: Date;
|
|
809
887
|
/**
|
|
888
|
+
* @public
|
|
810
889
|
* <p>The optional description of this specific job, for example <code>Important Photos
|
|
811
890
|
* 2016-08-11</code>.</p>
|
|
812
891
|
*/
|
|
@@ -817,10 +896,12 @@ export interface JobListEntry {
|
|
|
817
896
|
*/
|
|
818
897
|
export interface CreateClusterResult {
|
|
819
898
|
/**
|
|
899
|
+
* @public
|
|
820
900
|
* <p>The automatically generated ID for a cluster.</p>
|
|
821
901
|
*/
|
|
822
902
|
ClusterId?: string;
|
|
823
903
|
/**
|
|
904
|
+
* @public
|
|
824
905
|
* <p>List of jobs created for this cluster. For syntax, see <a href="http://amazonaws.com/snowball/latest/api-reference/API_ListJobs.html#API_ListJobs_ResponseSyntax">ListJobsResult$JobListEntries</a> in this guide.</p>
|
|
825
906
|
*/
|
|
826
907
|
JobListEntries?: JobListEntry[];
|
|
@@ -873,6 +954,7 @@ export declare class ClusterLimitExceededException extends __BaseException {
|
|
|
873
954
|
*/
|
|
874
955
|
export interface WirelessConnection {
|
|
875
956
|
/**
|
|
957
|
+
* @public
|
|
876
958
|
* <p>Enables the Wi-Fi adapter on an Snowcone device.</p>
|
|
877
959
|
*/
|
|
878
960
|
IsWifiEnabled?: boolean;
|
|
@@ -883,6 +965,7 @@ export interface WirelessConnection {
|
|
|
883
965
|
*/
|
|
884
966
|
export interface SnowconeDeviceConfiguration {
|
|
885
967
|
/**
|
|
968
|
+
* @public
|
|
886
969
|
* <p>Configures the wireless connection for the Snowcone device.</p>
|
|
887
970
|
*/
|
|
888
971
|
WirelessConnection?: WirelessConnection;
|
|
@@ -893,6 +976,7 @@ export interface SnowconeDeviceConfiguration {
|
|
|
893
976
|
*/
|
|
894
977
|
export interface DeviceConfiguration {
|
|
895
978
|
/**
|
|
979
|
+
* @public
|
|
896
980
|
* <p>Returns information about the device configuration for an Snowcone
|
|
897
981
|
* job.</p>
|
|
898
982
|
*/
|
|
@@ -919,30 +1003,37 @@ export type ImpactLevel = (typeof ImpactLevel)[keyof typeof ImpactLevel];
|
|
|
919
1003
|
*/
|
|
920
1004
|
export interface PickupDetails {
|
|
921
1005
|
/**
|
|
1006
|
+
* @public
|
|
922
1007
|
* <p>The name of the person picking up the device.</p>
|
|
923
1008
|
*/
|
|
924
1009
|
Name?: string;
|
|
925
1010
|
/**
|
|
1011
|
+
* @public
|
|
926
1012
|
* <p>The phone number of the person picking up the device.</p>
|
|
927
1013
|
*/
|
|
928
1014
|
PhoneNumber?: string;
|
|
929
1015
|
/**
|
|
1016
|
+
* @public
|
|
930
1017
|
* <p>The email address of the person picking up the device.</p>
|
|
931
1018
|
*/
|
|
932
1019
|
Email?: string;
|
|
933
1020
|
/**
|
|
1021
|
+
* @public
|
|
934
1022
|
* <p>The number on the credential identifying the person picking up the device.</p>
|
|
935
1023
|
*/
|
|
936
1024
|
IdentificationNumber?: string;
|
|
937
1025
|
/**
|
|
1026
|
+
* @public
|
|
938
1027
|
* <p>Expiration date of the credential identifying the person picking up the device.</p>
|
|
939
1028
|
*/
|
|
940
1029
|
IdentificationExpirationDate?: Date;
|
|
941
1030
|
/**
|
|
1031
|
+
* @public
|
|
942
1032
|
* <p>Organization that issued the credential identifying the person picking up the device.</p>
|
|
943
1033
|
*/
|
|
944
1034
|
IdentificationIssuingOrg?: string;
|
|
945
1035
|
/**
|
|
1036
|
+
* @public
|
|
946
1037
|
* <p>The unique ID for a device that will be picked up.</p>
|
|
947
1038
|
*/
|
|
948
1039
|
DevicePickupId?: string;
|
|
@@ -952,11 +1043,13 @@ export interface PickupDetails {
|
|
|
952
1043
|
*/
|
|
953
1044
|
export interface CreateJobRequest {
|
|
954
1045
|
/**
|
|
1046
|
+
* @public
|
|
955
1047
|
* <p>Defines the type of job that you're creating.
|
|
956
1048
|
* </p>
|
|
957
1049
|
*/
|
|
958
1050
|
JobType?: JobType | string;
|
|
959
1051
|
/**
|
|
1052
|
+
* @public
|
|
960
1053
|
* <p>Defines the Amazon S3 buckets associated with this job.</p>
|
|
961
1054
|
* <p>With <code>IMPORT</code> jobs, you specify the bucket or buckets that your transferred
|
|
962
1055
|
* data will be imported into.</p>
|
|
@@ -968,33 +1061,39 @@ export interface CreateJobRequest {
|
|
|
968
1061
|
*/
|
|
969
1062
|
Resources?: JobResource;
|
|
970
1063
|
/**
|
|
1064
|
+
* @public
|
|
971
1065
|
* <p>Specifies the service or services on the Snow Family device that your transferred data
|
|
972
1066
|
* will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File
|
|
973
1067
|
* System) and the Amazon Web Services Storage Gateway service Tape Gateway type.</p>
|
|
974
1068
|
*/
|
|
975
1069
|
OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration;
|
|
976
1070
|
/**
|
|
1071
|
+
* @public
|
|
977
1072
|
* <p>Defines an optional description of this specific job, for example <code>Important
|
|
978
1073
|
* Photos 2016-08-11</code>.</p>
|
|
979
1074
|
*/
|
|
980
1075
|
Description?: string;
|
|
981
1076
|
/**
|
|
1077
|
+
* @public
|
|
982
1078
|
* <p>The ID for the address that you want the Snow device shipped to.</p>
|
|
983
1079
|
*/
|
|
984
1080
|
AddressId?: string;
|
|
985
1081
|
/**
|
|
1082
|
+
* @public
|
|
986
1083
|
* <p>The <code>KmsKeyARN</code> that you want to associate with this job.
|
|
987
1084
|
* <code>KmsKeyARN</code>s are created using the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a>
|
|
988
1085
|
* Key Management Service (KMS) API action.</p>
|
|
989
1086
|
*/
|
|
990
1087
|
KmsKeyARN?: string;
|
|
991
1088
|
/**
|
|
1089
|
+
* @public
|
|
992
1090
|
* <p>The <code>RoleARN</code> that you want to associate with this job.
|
|
993
1091
|
* <code>RoleArn</code>s are created using the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a>
|
|
994
1092
|
* Identity and Access Management (IAM) API action.</p>
|
|
995
1093
|
*/
|
|
996
1094
|
RoleARN?: string;
|
|
997
1095
|
/**
|
|
1096
|
+
* @public
|
|
998
1097
|
* <p>If your job is being created in one of the US regions, you have the option of
|
|
999
1098
|
* specifying what size Snow device you'd like for this job. In all other regions, Snowballs come
|
|
1000
1099
|
* with 80 TB in storage capacity.</p>
|
|
@@ -1006,6 +1105,7 @@ export interface CreateJobRequest {
|
|
|
1006
1105
|
*/
|
|
1007
1106
|
SnowballCapacityPreference?: SnowballCapacity | string;
|
|
1008
1107
|
/**
|
|
1108
|
+
* @public
|
|
1009
1109
|
* <p>The shipping speed for this job. This speed doesn't dictate how soon you'll get the
|
|
1010
1110
|
* Snow device, rather it represents how quickly the Snow device moves to its destination while
|
|
1011
1111
|
* in transit. Regional shipping speeds are as follows:</p>
|
|
@@ -1030,17 +1130,20 @@ export interface CreateJobRequest {
|
|
|
1030
1130
|
*/
|
|
1031
1131
|
ShippingOption?: ShippingOption | string;
|
|
1032
1132
|
/**
|
|
1133
|
+
* @public
|
|
1033
1134
|
* <p>Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for
|
|
1034
1135
|
* this job.</p>
|
|
1035
1136
|
*/
|
|
1036
1137
|
Notification?: Notification;
|
|
1037
1138
|
/**
|
|
1139
|
+
* @public
|
|
1038
1140
|
* <p>The ID of a cluster. If you're creating a job for a node in a cluster, you need to
|
|
1039
1141
|
* provide only this <code>clusterId</code> value. The other job attributes are inherited from
|
|
1040
1142
|
* the cluster.</p>
|
|
1041
1143
|
*/
|
|
1042
1144
|
ClusterId?: string;
|
|
1043
1145
|
/**
|
|
1146
|
+
* @public
|
|
1044
1147
|
* <p>The type of Snow Family devices to use for this job.
|
|
1045
1148
|
* </p>
|
|
1046
1149
|
* <note>
|
|
@@ -1059,15 +1162,18 @@ export interface CreateJobRequest {
|
|
|
1059
1162
|
*/
|
|
1060
1163
|
SnowballType?: SnowballType | string;
|
|
1061
1164
|
/**
|
|
1165
|
+
* @public
|
|
1062
1166
|
* <p>The forwarding address ID for a job. This field is not supported in most
|
|
1063
1167
|
* Regions.</p>
|
|
1064
1168
|
*/
|
|
1065
1169
|
ForwardingAddressId?: string;
|
|
1066
1170
|
/**
|
|
1171
|
+
* @public
|
|
1067
1172
|
* <p>The tax documents required in your Amazon Web Services Region.</p>
|
|
1068
1173
|
*/
|
|
1069
1174
|
TaxDocuments?: TaxDocuments;
|
|
1070
1175
|
/**
|
|
1176
|
+
* @public
|
|
1071
1177
|
* <p>Defines the device configuration for an Snowcone job.</p>
|
|
1072
1178
|
* <p>For more information, see
|
|
1073
1179
|
* "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow
|
|
@@ -1077,6 +1183,7 @@ export interface CreateJobRequest {
|
|
|
1077
1183
|
*/
|
|
1078
1184
|
DeviceConfiguration?: DeviceConfiguration;
|
|
1079
1185
|
/**
|
|
1186
|
+
* @public
|
|
1080
1187
|
* <p>Allows you to securely operate and manage Snowcone devices remotely from outside of your
|
|
1081
1188
|
* internal network. When set to <code>INSTALLED_AUTOSTART</code>, remote management will
|
|
1082
1189
|
* automatically be available when the device arrives at your location. Otherwise, you need to
|
|
@@ -1084,14 +1191,17 @@ export interface CreateJobRequest {
|
|
|
1084
1191
|
*/
|
|
1085
1192
|
RemoteManagement?: RemoteManagement | string;
|
|
1086
1193
|
/**
|
|
1194
|
+
* @public
|
|
1087
1195
|
* <p>The ID of the long-term pricing type for the device.</p>
|
|
1088
1196
|
*/
|
|
1089
1197
|
LongTermPricingId?: string;
|
|
1090
1198
|
/**
|
|
1199
|
+
* @public
|
|
1091
1200
|
* <p>The highest impact level of data that will be stored or processed on the device, provided at job creation.</p>
|
|
1092
1201
|
*/
|
|
1093
1202
|
ImpactLevel?: ImpactLevel | string;
|
|
1094
1203
|
/**
|
|
1204
|
+
* @public
|
|
1095
1205
|
* <p>Information identifying the person picking up the device.</p>
|
|
1096
1206
|
*/
|
|
1097
1207
|
PickupDetails?: PickupDetails;
|
|
@@ -1101,6 +1211,7 @@ export interface CreateJobRequest {
|
|
|
1101
1211
|
*/
|
|
1102
1212
|
export interface CreateJobResult {
|
|
1103
1213
|
/**
|
|
1214
|
+
* @public
|
|
1104
1215
|
* <p>The automatically generated ID for a job, for example
|
|
1105
1216
|
* <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
1106
1217
|
*/
|
|
@@ -1124,16 +1235,19 @@ export type LongTermPricingType = (typeof LongTermPricingType)[keyof typeof Long
|
|
|
1124
1235
|
*/
|
|
1125
1236
|
export interface CreateLongTermPricingRequest {
|
|
1126
1237
|
/**
|
|
1238
|
+
* @public
|
|
1127
1239
|
* <p>The type of long-term pricing option you want for the device, either 1-year or 3-year
|
|
1128
1240
|
* long-term pricing.</p>
|
|
1129
1241
|
*/
|
|
1130
1242
|
LongTermPricingType: LongTermPricingType | string | undefined;
|
|
1131
1243
|
/**
|
|
1244
|
+
* @public
|
|
1132
1245
|
* <p>Specifies whether the current long-term pricing type for the device should be
|
|
1133
1246
|
* renewed.</p>
|
|
1134
1247
|
*/
|
|
1135
1248
|
IsLongTermPricingAutoRenew?: boolean;
|
|
1136
1249
|
/**
|
|
1250
|
+
* @public
|
|
1137
1251
|
* <p>The type of Snow Family devices to use for the long-term pricing job.</p>
|
|
1138
1252
|
*/
|
|
1139
1253
|
SnowballType: SnowballType | string | undefined;
|
|
@@ -1143,6 +1257,7 @@ export interface CreateLongTermPricingRequest {
|
|
|
1143
1257
|
*/
|
|
1144
1258
|
export interface CreateLongTermPricingResult {
|
|
1145
1259
|
/**
|
|
1260
|
+
* @public
|
|
1146
1261
|
* <p>The ID of the long-term pricing type for the device.</p>
|
|
1147
1262
|
*/
|
|
1148
1263
|
LongTermPricingId?: string;
|
|
@@ -1156,6 +1271,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
1156
1271
|
readonly name: "ConflictException";
|
|
1157
1272
|
readonly $fault: "client";
|
|
1158
1273
|
/**
|
|
1274
|
+
* @public
|
|
1159
1275
|
* <p>You get this resource when you call <code>CreateReturnShippingLabel</code> more than once when other requests are not completed. .</p>
|
|
1160
1276
|
*/
|
|
1161
1277
|
ConflictResource?: string;
|
|
@@ -1170,11 +1286,13 @@ export declare class ConflictException extends __BaseException {
|
|
|
1170
1286
|
*/
|
|
1171
1287
|
export interface CreateReturnShippingLabelRequest {
|
|
1172
1288
|
/**
|
|
1289
|
+
* @public
|
|
1173
1290
|
* <p>The ID for a job that you want to create the return shipping label for; for example,
|
|
1174
1291
|
* <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
1175
1292
|
*/
|
|
1176
1293
|
JobId: string | undefined;
|
|
1177
1294
|
/**
|
|
1295
|
+
* @public
|
|
1178
1296
|
* <p>The shipping speed for a particular job. This speed doesn't dictate how soon the device
|
|
1179
1297
|
* is returned to Amazon Web Services. This speed represents how quickly it moves to its
|
|
1180
1298
|
* destination while in transit. Regional shipping speeds are as follows:</p>
|
|
@@ -1200,6 +1318,7 @@ export type ShippingLabelStatus = (typeof ShippingLabelStatus)[keyof typeof Ship
|
|
|
1200
1318
|
*/
|
|
1201
1319
|
export interface CreateReturnShippingLabelResult {
|
|
1202
1320
|
/**
|
|
1321
|
+
* @public
|
|
1203
1322
|
* <p>The status information of the task on a Snow device that is being returned to Amazon Web Services.</p>
|
|
1204
1323
|
*/
|
|
1205
1324
|
Status?: ShippingLabelStatus | string;
|
|
@@ -1224,6 +1343,7 @@ export declare class ReturnShippingLabelAlreadyExistsException extends __BaseExc
|
|
|
1224
1343
|
*/
|
|
1225
1344
|
export interface DescribeAddressRequest {
|
|
1226
1345
|
/**
|
|
1346
|
+
* @public
|
|
1227
1347
|
* <p>The automatically generated ID for a specific address.</p>
|
|
1228
1348
|
*/
|
|
1229
1349
|
AddressId: string | undefined;
|
|
@@ -1233,6 +1353,7 @@ export interface DescribeAddressRequest {
|
|
|
1233
1353
|
*/
|
|
1234
1354
|
export interface DescribeAddressResult {
|
|
1235
1355
|
/**
|
|
1356
|
+
* @public
|
|
1236
1357
|
* <p>The address that you want the Snow device(s) associated with a specific job to be
|
|
1237
1358
|
* shipped to.</p>
|
|
1238
1359
|
*/
|
|
@@ -1243,10 +1364,12 @@ export interface DescribeAddressResult {
|
|
|
1243
1364
|
*/
|
|
1244
1365
|
export interface DescribeAddressesRequest {
|
|
1245
1366
|
/**
|
|
1367
|
+
* @public
|
|
1246
1368
|
* <p>The number of <code>ADDRESS</code> objects to return.</p>
|
|
1247
1369
|
*/
|
|
1248
1370
|
MaxResults?: number;
|
|
1249
1371
|
/**
|
|
1372
|
+
* @public
|
|
1250
1373
|
* <p>HTTP requests are stateless. To identify what object comes "next" in the list of
|
|
1251
1374
|
* <code>ADDRESS</code> objects, you have the option of specifying a value for
|
|
1252
1375
|
* <code>NextToken</code> as the starting point for your list of returned addresses.</p>
|
|
@@ -1258,10 +1381,12 @@ export interface DescribeAddressesRequest {
|
|
|
1258
1381
|
*/
|
|
1259
1382
|
export interface DescribeAddressesResult {
|
|
1260
1383
|
/**
|
|
1384
|
+
* @public
|
|
1261
1385
|
* <p>The Snow device shipping addresses that were created for this account.</p>
|
|
1262
1386
|
*/
|
|
1263
1387
|
Addresses?: Address[];
|
|
1264
1388
|
/**
|
|
1389
|
+
* @public
|
|
1265
1390
|
* <p>HTTP requests are stateless. If you use the automatically generated
|
|
1266
1391
|
* <code>NextToken</code> value in your next <code>DescribeAddresses</code> call, your list of
|
|
1267
1392
|
* returned addresses will start from this point in the array.</p>
|
|
@@ -1288,6 +1413,7 @@ export declare class InvalidNextTokenException extends __BaseException {
|
|
|
1288
1413
|
*/
|
|
1289
1414
|
export interface DescribeClusterRequest {
|
|
1290
1415
|
/**
|
|
1416
|
+
* @public
|
|
1291
1417
|
* <p>The automatically generated ID for a cluster.</p>
|
|
1292
1418
|
*/
|
|
1293
1419
|
ClusterId: string | undefined;
|
|
@@ -1313,33 +1439,40 @@ export type ClusterState = (typeof ClusterState)[keyof typeof ClusterState];
|
|
|
1313
1439
|
*/
|
|
1314
1440
|
export interface ClusterMetadata {
|
|
1315
1441
|
/**
|
|
1442
|
+
* @public
|
|
1316
1443
|
* <p>The automatically generated ID for a cluster.</p>
|
|
1317
1444
|
*/
|
|
1318
1445
|
ClusterId?: string;
|
|
1319
1446
|
/**
|
|
1447
|
+
* @public
|
|
1320
1448
|
* <p>The optional description of the cluster.</p>
|
|
1321
1449
|
*/
|
|
1322
1450
|
Description?: string;
|
|
1323
1451
|
/**
|
|
1452
|
+
* @public
|
|
1324
1453
|
* <p>The <code>KmsKeyARN</code> Amazon Resource Name (ARN) associated with this cluster.
|
|
1325
1454
|
* This ARN was created using the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a> API action in Key Management Service (KMS.</p>
|
|
1326
1455
|
*/
|
|
1327
1456
|
KmsKeyARN?: string;
|
|
1328
1457
|
/**
|
|
1458
|
+
* @public
|
|
1329
1459
|
* <p>The role ARN associated with this cluster. This ARN was created using the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a>
|
|
1330
1460
|
* API action in Identity and Access Management (IAM).</p>
|
|
1331
1461
|
*/
|
|
1332
1462
|
RoleARN?: string;
|
|
1333
1463
|
/**
|
|
1464
|
+
* @public
|
|
1334
1465
|
* <p>The current status of the cluster.</p>
|
|
1335
1466
|
*/
|
|
1336
1467
|
ClusterState?: ClusterState | string;
|
|
1337
1468
|
/**
|
|
1469
|
+
* @public
|
|
1338
1470
|
* <p>The type of job for this cluster. Currently, the only job type supported for clusters
|
|
1339
1471
|
* is <code>LOCAL_USE</code>.</p>
|
|
1340
1472
|
*/
|
|
1341
1473
|
JobType?: JobType | string;
|
|
1342
1474
|
/**
|
|
1475
|
+
* @public
|
|
1343
1476
|
* <p>The type of Snowcone device to use for this cluster.
|
|
1344
1477
|
* </p>
|
|
1345
1478
|
* <note>
|
|
@@ -1349,18 +1482,22 @@ export interface ClusterMetadata {
|
|
|
1349
1482
|
*/
|
|
1350
1483
|
SnowballType?: SnowballType | string;
|
|
1351
1484
|
/**
|
|
1485
|
+
* @public
|
|
1352
1486
|
* <p>The creation date for this cluster.</p>
|
|
1353
1487
|
*/
|
|
1354
1488
|
CreationDate?: Date;
|
|
1355
1489
|
/**
|
|
1490
|
+
* @public
|
|
1356
1491
|
* <p>The arrays of <a>JobResource</a> objects that can include updated <a>S3Resource</a> objects or <a>LambdaResource</a> objects.</p>
|
|
1357
1492
|
*/
|
|
1358
1493
|
Resources?: JobResource;
|
|
1359
1494
|
/**
|
|
1495
|
+
* @public
|
|
1360
1496
|
* <p>The automatically generated ID for a specific address.</p>
|
|
1361
1497
|
*/
|
|
1362
1498
|
AddressId?: string;
|
|
1363
1499
|
/**
|
|
1500
|
+
* @public
|
|
1364
1501
|
* <p>The shipping speed for each node in this cluster. This speed doesn't dictate how soon
|
|
1365
1502
|
* you'll get each device, rather it represents how quickly each device moves to its destination
|
|
1366
1503
|
* while in transit. Regional shipping speeds are as follows:</p>
|
|
@@ -1385,20 +1522,24 @@ export interface ClusterMetadata {
|
|
|
1385
1522
|
*/
|
|
1386
1523
|
ShippingOption?: ShippingOption | string;
|
|
1387
1524
|
/**
|
|
1525
|
+
* @public
|
|
1388
1526
|
* <p>The Amazon Simple Notification Service (Amazon SNS) notification settings for this
|
|
1389
1527
|
* cluster.</p>
|
|
1390
1528
|
*/
|
|
1391
1529
|
Notification?: Notification;
|
|
1392
1530
|
/**
|
|
1531
|
+
* @public
|
|
1393
1532
|
* <p>The ID of the address that you want a cluster shipped to, after it will be
|
|
1394
1533
|
* shipped to its primary address. This field is not supported in most regions.</p>
|
|
1395
1534
|
*/
|
|
1396
1535
|
ForwardingAddressId?: string;
|
|
1397
1536
|
/**
|
|
1537
|
+
* @public
|
|
1398
1538
|
* <p>The tax documents required in your Amazon Web Services Region.</p>
|
|
1399
1539
|
*/
|
|
1400
1540
|
TaxDocuments?: TaxDocuments;
|
|
1401
1541
|
/**
|
|
1542
|
+
* @public
|
|
1402
1543
|
* <p>Represents metadata and configuration settings for services on an Amazon Web Services Snow Family
|
|
1403
1544
|
* device.</p>
|
|
1404
1545
|
*/
|
|
@@ -1409,6 +1550,7 @@ export interface ClusterMetadata {
|
|
|
1409
1550
|
*/
|
|
1410
1551
|
export interface DescribeClusterResult {
|
|
1411
1552
|
/**
|
|
1553
|
+
* @public
|
|
1412
1554
|
* <p>Information about a specific cluster, including shipping information, cluster status,
|
|
1413
1555
|
* and other important metadata.</p>
|
|
1414
1556
|
*/
|
|
@@ -1419,6 +1561,7 @@ export interface DescribeClusterResult {
|
|
|
1419
1561
|
*/
|
|
1420
1562
|
export interface DescribeJobRequest {
|
|
1421
1563
|
/**
|
|
1564
|
+
* @public
|
|
1422
1565
|
* <p>The automatically generated ID for a job, for example
|
|
1423
1566
|
* <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
1424
1567
|
*/
|
|
@@ -1432,19 +1575,23 @@ export interface DescribeJobRequest {
|
|
|
1432
1575
|
*/
|
|
1433
1576
|
export interface DataTransfer {
|
|
1434
1577
|
/**
|
|
1578
|
+
* @public
|
|
1435
1579
|
* <p>The number of bytes transferred between a Snow device and Amazon S3.</p>
|
|
1436
1580
|
*/
|
|
1437
1581
|
BytesTransferred?: number;
|
|
1438
1582
|
/**
|
|
1583
|
+
* @public
|
|
1439
1584
|
* <p>The number of objects transferred between a Snow device and Amazon S3.</p>
|
|
1440
1585
|
*/
|
|
1441
1586
|
ObjectsTransferred?: number;
|
|
1442
1587
|
/**
|
|
1588
|
+
* @public
|
|
1443
1589
|
* <p>The total bytes of data for a transfer between a Snow device and Amazon S3. This value
|
|
1444
1590
|
* is set to 0 (zero) until all the keys that will be transferred have been listed.</p>
|
|
1445
1591
|
*/
|
|
1446
1592
|
TotalBytes?: number;
|
|
1447
1593
|
/**
|
|
1594
|
+
* @public
|
|
1448
1595
|
* <p>The total number of objects for a transfer between a Snow device and Amazon S3. This
|
|
1449
1596
|
* value is set to 0 (zero) until all the keys that will be transferred have been
|
|
1450
1597
|
* listed.</p>
|
|
@@ -1471,15 +1618,18 @@ export interface DataTransfer {
|
|
|
1471
1618
|
*/
|
|
1472
1619
|
export interface JobLogs {
|
|
1473
1620
|
/**
|
|
1621
|
+
* @public
|
|
1474
1622
|
* <p>A link to an Amazon S3 presigned URL where the job completion report is
|
|
1475
1623
|
* located.</p>
|
|
1476
1624
|
*/
|
|
1477
1625
|
JobCompletionReportURI?: string;
|
|
1478
1626
|
/**
|
|
1627
|
+
* @public
|
|
1479
1628
|
* <p>A link to an Amazon S3 presigned URL where the job success log is located.</p>
|
|
1480
1629
|
*/
|
|
1481
1630
|
JobSuccessLogURI?: string;
|
|
1482
1631
|
/**
|
|
1632
|
+
* @public
|
|
1483
1633
|
* <p>A link to an Amazon S3 presigned URL where the job failure log is located.</p>
|
|
1484
1634
|
*/
|
|
1485
1635
|
JobFailureLogURI?: string;
|
|
@@ -1491,10 +1641,12 @@ export interface JobLogs {
|
|
|
1491
1641
|
*/
|
|
1492
1642
|
export interface Shipment {
|
|
1493
1643
|
/**
|
|
1644
|
+
* @public
|
|
1494
1645
|
* <p>Status information for a shipment.</p>
|
|
1495
1646
|
*/
|
|
1496
1647
|
Status?: string;
|
|
1497
1648
|
/**
|
|
1649
|
+
* @public
|
|
1498
1650
|
* <p>The tracking number for this job. Using this tracking number with your region's
|
|
1499
1651
|
* carrier's website, you can track a Snow device as the carrier transports it.</p>
|
|
1500
1652
|
* <p>For India, the carrier is Amazon Logistics. For all other regions, UPS is the
|
|
@@ -1509,6 +1661,7 @@ export interface Shipment {
|
|
|
1509
1661
|
*/
|
|
1510
1662
|
export interface ShippingDetails {
|
|
1511
1663
|
/**
|
|
1664
|
+
* @public
|
|
1512
1665
|
* <p>The shipping speed for a particular job. This speed doesn't dictate how soon you'll get
|
|
1513
1666
|
* the Snow device from the job's creation date. This speed represents how quickly it moves to
|
|
1514
1667
|
* its destination while in transit. Regional shipping speeds are as follows:</p>
|
|
@@ -1534,11 +1687,13 @@ export interface ShippingDetails {
|
|
|
1534
1687
|
*/
|
|
1535
1688
|
ShippingOption?: ShippingOption | string;
|
|
1536
1689
|
/**
|
|
1690
|
+
* @public
|
|
1537
1691
|
* <p>The <code>Status</code> and <code>TrackingNumber</code> values for a Snow device being
|
|
1538
1692
|
* returned to Amazon Web Services for a particular job.</p>
|
|
1539
1693
|
*/
|
|
1540
1694
|
InboundShipment?: Shipment;
|
|
1541
1695
|
/**
|
|
1696
|
+
* @public
|
|
1542
1697
|
* <p>The <code>Status</code> and <code>TrackingNumber</code> values for a Snow device being
|
|
1543
1698
|
* delivered to the address that you specified for a particular job.</p>
|
|
1544
1699
|
*/
|
|
@@ -1552,56 +1707,68 @@ export interface ShippingDetails {
|
|
|
1552
1707
|
*/
|
|
1553
1708
|
export interface JobMetadata {
|
|
1554
1709
|
/**
|
|
1710
|
+
* @public
|
|
1555
1711
|
* <p>The automatically generated ID for a job, for example
|
|
1556
1712
|
* <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
1557
1713
|
*/
|
|
1558
1714
|
JobId?: string;
|
|
1559
1715
|
/**
|
|
1716
|
+
* @public
|
|
1560
1717
|
* <p>The current status of the jobs.</p>
|
|
1561
1718
|
*/
|
|
1562
1719
|
JobState?: JobState | string;
|
|
1563
1720
|
/**
|
|
1721
|
+
* @public
|
|
1564
1722
|
* <p>The type of job.</p>
|
|
1565
1723
|
*/
|
|
1566
1724
|
JobType?: JobType | string;
|
|
1567
1725
|
/**
|
|
1726
|
+
* @public
|
|
1568
1727
|
* <p>The type of device used with this job.</p>
|
|
1569
1728
|
*/
|
|
1570
1729
|
SnowballType?: SnowballType | string;
|
|
1571
1730
|
/**
|
|
1731
|
+
* @public
|
|
1572
1732
|
* <p>The creation date for this job.</p>
|
|
1573
1733
|
*/
|
|
1574
1734
|
CreationDate?: Date;
|
|
1575
1735
|
/**
|
|
1736
|
+
* @public
|
|
1576
1737
|
* <p>An array of <code>S3Resource</code> objects. Each <code>S3Resource</code> object
|
|
1577
1738
|
* represents an Amazon S3 bucket that your transferred data will be exported from or imported
|
|
1578
1739
|
* into.</p>
|
|
1579
1740
|
*/
|
|
1580
1741
|
Resources?: JobResource;
|
|
1581
1742
|
/**
|
|
1743
|
+
* @public
|
|
1582
1744
|
* <p>The description of the job, provided at job creation.</p>
|
|
1583
1745
|
*/
|
|
1584
1746
|
Description?: string;
|
|
1585
1747
|
/**
|
|
1748
|
+
* @public
|
|
1586
1749
|
* <p>The Amazon Resource Name (ARN) for the Key Management Service (KMS) key
|
|
1587
1750
|
* associated with this job. This ARN was created using the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a> API action in KMS.</p>
|
|
1588
1751
|
*/
|
|
1589
1752
|
KmsKeyARN?: string;
|
|
1590
1753
|
/**
|
|
1754
|
+
* @public
|
|
1591
1755
|
* <p>The role ARN associated with this job. This ARN was created using the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a>
|
|
1592
1756
|
* API action in Identity and Access Management.</p>
|
|
1593
1757
|
*/
|
|
1594
1758
|
RoleARN?: string;
|
|
1595
1759
|
/**
|
|
1760
|
+
* @public
|
|
1596
1761
|
* <p>The ID for the address that you want the Snow device shipped to.</p>
|
|
1597
1762
|
*/
|
|
1598
1763
|
AddressId?: string;
|
|
1599
1764
|
/**
|
|
1765
|
+
* @public
|
|
1600
1766
|
* <p>A job's shipping information, including inbound and outbound tracking numbers and
|
|
1601
1767
|
* shipping speed options.</p>
|
|
1602
1768
|
*/
|
|
1603
1769
|
ShippingDetails?: ShippingDetails;
|
|
1604
1770
|
/**
|
|
1771
|
+
* @public
|
|
1605
1772
|
* <p>The Snow device capacity preference for this job, specified at job creation. In US
|
|
1606
1773
|
* regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB
|
|
1607
1774
|
* capacity Snowballs.</p>
|
|
@@ -1613,6 +1780,7 @@ export interface JobMetadata {
|
|
|
1613
1780
|
*/
|
|
1614
1781
|
SnowballCapacityPreference?: SnowballCapacity | string;
|
|
1615
1782
|
/**
|
|
1783
|
+
* @public
|
|
1616
1784
|
* <p>The Amazon Simple Notification Service (Amazon SNS) notification settings associated
|
|
1617
1785
|
* with a specific job. The <code>Notification</code> object is returned as a part of the
|
|
1618
1786
|
* response syntax of the <code>DescribeJob</code> action in the <code>JobMetadata</code> data
|
|
@@ -1620,6 +1788,7 @@ export interface JobMetadata {
|
|
|
1620
1788
|
*/
|
|
1621
1789
|
Notification?: Notification;
|
|
1622
1790
|
/**
|
|
1791
|
+
* @public
|
|
1623
1792
|
* <p>A value that defines the real-time status of a Snow device's data transfer while the
|
|
1624
1793
|
* device is at Amazon Web Services. This data is only available while a job has a
|
|
1625
1794
|
* <code>JobState</code> value of <code>InProgress</code>, for both import and export
|
|
@@ -1627,6 +1796,7 @@ export interface JobMetadata {
|
|
|
1627
1796
|
*/
|
|
1628
1797
|
DataTransferProgress?: DataTransfer;
|
|
1629
1798
|
/**
|
|
1799
|
+
* @public
|
|
1630
1800
|
* <p>Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF
|
|
1631
1801
|
* job report becomes available at the end of the import process. For export jobs, your job
|
|
1632
1802
|
* report typically becomes available while the Snow device for your job part is being delivered
|
|
@@ -1634,24 +1804,29 @@ export interface JobMetadata {
|
|
|
1634
1804
|
*/
|
|
1635
1805
|
JobLogInfo?: JobLogs;
|
|
1636
1806
|
/**
|
|
1807
|
+
* @public
|
|
1637
1808
|
* <p>The 39-character ID for the cluster, for example
|
|
1638
1809
|
* <code>CID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
1639
1810
|
*/
|
|
1640
1811
|
ClusterId?: string;
|
|
1641
1812
|
/**
|
|
1813
|
+
* @public
|
|
1642
1814
|
* <p>The ID of the address that you want a job shipped to, after it will be
|
|
1643
1815
|
* shipped to its primary address. This field is not supported in most regions.</p>
|
|
1644
1816
|
*/
|
|
1645
1817
|
ForwardingAddressId?: string;
|
|
1646
1818
|
/**
|
|
1819
|
+
* @public
|
|
1647
1820
|
* <p>The metadata associated with the tax documents required in your Amazon Web Services Region.</p>
|
|
1648
1821
|
*/
|
|
1649
1822
|
TaxDocuments?: TaxDocuments;
|
|
1650
1823
|
/**
|
|
1824
|
+
* @public
|
|
1651
1825
|
* <p>The container for <code>SnowconeDeviceConfiguration</code>. </p>
|
|
1652
1826
|
*/
|
|
1653
1827
|
DeviceConfiguration?: DeviceConfiguration;
|
|
1654
1828
|
/**
|
|
1829
|
+
* @public
|
|
1655
1830
|
* <p>Allows you to securely operate and manage Snowcone devices remotely from outside of your
|
|
1656
1831
|
* internal network. When set to <code>INSTALLED_AUTOSTART</code>, remote management will
|
|
1657
1832
|
* automatically be available when the device arrives at your location. Otherwise, you need to
|
|
@@ -1659,23 +1834,28 @@ export interface JobMetadata {
|
|
|
1659
1834
|
*/
|
|
1660
1835
|
RemoteManagement?: RemoteManagement | string;
|
|
1661
1836
|
/**
|
|
1837
|
+
* @public
|
|
1662
1838
|
* <p>The ID of the long-term pricing type for the device.</p>
|
|
1663
1839
|
*/
|
|
1664
1840
|
LongTermPricingId?: string;
|
|
1665
1841
|
/**
|
|
1842
|
+
* @public
|
|
1666
1843
|
* <p>Represents metadata and configuration settings for services on an Amazon Web Services Snow Family
|
|
1667
1844
|
* device.</p>
|
|
1668
1845
|
*/
|
|
1669
1846
|
OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration;
|
|
1670
1847
|
/**
|
|
1848
|
+
* @public
|
|
1671
1849
|
* <p>The highest impact level of data that will be stored or processed on the device, provided at job creation.</p>
|
|
1672
1850
|
*/
|
|
1673
1851
|
ImpactLevel?: ImpactLevel | string;
|
|
1674
1852
|
/**
|
|
1853
|
+
* @public
|
|
1675
1854
|
* <p>Information identifying the person picking up the device.</p>
|
|
1676
1855
|
*/
|
|
1677
1856
|
PickupDetails?: PickupDetails;
|
|
1678
1857
|
/**
|
|
1858
|
+
* @public
|
|
1679
1859
|
* <p>Unique ID associated with a device.</p>
|
|
1680
1860
|
*/
|
|
1681
1861
|
SnowballId?: string;
|
|
@@ -1685,11 +1865,13 @@ export interface JobMetadata {
|
|
|
1685
1865
|
*/
|
|
1686
1866
|
export interface DescribeJobResult {
|
|
1687
1867
|
/**
|
|
1868
|
+
* @public
|
|
1688
1869
|
* <p>Information about a specific job, including shipping information, job status, and other
|
|
1689
1870
|
* important metadata.</p>
|
|
1690
1871
|
*/
|
|
1691
1872
|
JobMetadata?: JobMetadata;
|
|
1692
1873
|
/**
|
|
1874
|
+
* @public
|
|
1693
1875
|
* <p>Information about a specific job part (in the case of an export job), including
|
|
1694
1876
|
* shipping information, job status, and other important metadata.</p>
|
|
1695
1877
|
*/
|
|
@@ -1700,6 +1882,7 @@ export interface DescribeJobResult {
|
|
|
1700
1882
|
*/
|
|
1701
1883
|
export interface DescribeReturnShippingLabelRequest {
|
|
1702
1884
|
/**
|
|
1885
|
+
* @public
|
|
1703
1886
|
* <p>The automatically generated ID for a job, for example
|
|
1704
1887
|
* <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
1705
1888
|
*/
|
|
@@ -1710,14 +1893,17 @@ export interface DescribeReturnShippingLabelRequest {
|
|
|
1710
1893
|
*/
|
|
1711
1894
|
export interface DescribeReturnShippingLabelResult {
|
|
1712
1895
|
/**
|
|
1896
|
+
* @public
|
|
1713
1897
|
* <p>The status information of the task on a Snow device that is being returned to Amazon Web Services.</p>
|
|
1714
1898
|
*/
|
|
1715
1899
|
Status?: ShippingLabelStatus | string;
|
|
1716
1900
|
/**
|
|
1901
|
+
* @public
|
|
1717
1902
|
* <p>The expiration date of the current return shipping label.</p>
|
|
1718
1903
|
*/
|
|
1719
1904
|
ExpirationDate?: Date;
|
|
1720
1905
|
/**
|
|
1906
|
+
* @public
|
|
1721
1907
|
* <p>The pre-signed Amazon S3 URI used to download the return shipping label.</p>
|
|
1722
1908
|
*/
|
|
1723
1909
|
ReturnShippingLabelURI?: string;
|
|
@@ -1727,6 +1913,7 @@ export interface DescribeReturnShippingLabelResult {
|
|
|
1727
1913
|
*/
|
|
1728
1914
|
export interface GetJobManifestRequest {
|
|
1729
1915
|
/**
|
|
1916
|
+
* @public
|
|
1730
1917
|
* <p>The ID for a job that you want to get the manifest file for, for example
|
|
1731
1918
|
* <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
1732
1919
|
*/
|
|
@@ -1737,6 +1924,7 @@ export interface GetJobManifestRequest {
|
|
|
1737
1924
|
*/
|
|
1738
1925
|
export interface GetJobManifestResult {
|
|
1739
1926
|
/**
|
|
1927
|
+
* @public
|
|
1740
1928
|
* <p>The Amazon S3 presigned URL for the manifest file associated with the specified
|
|
1741
1929
|
* <code>JobId</code> value.</p>
|
|
1742
1930
|
*/
|
|
@@ -1747,6 +1935,7 @@ export interface GetJobManifestResult {
|
|
|
1747
1935
|
*/
|
|
1748
1936
|
export interface GetJobUnlockCodeRequest {
|
|
1749
1937
|
/**
|
|
1938
|
+
* @public
|
|
1750
1939
|
* <p>The ID for the job that you want to get the <code>UnlockCode</code> value for, for
|
|
1751
1940
|
* example <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
1752
1941
|
*/
|
|
@@ -1757,6 +1946,7 @@ export interface GetJobUnlockCodeRequest {
|
|
|
1757
1946
|
*/
|
|
1758
1947
|
export interface GetJobUnlockCodeResult {
|
|
1759
1948
|
/**
|
|
1949
|
+
* @public
|
|
1760
1950
|
* <p>The <code>UnlockCode</code> value for the specified job. The <code>UnlockCode</code>
|
|
1761
1951
|
* value can be accessed for up to 360 days after the job has been created.</p>
|
|
1762
1952
|
*/
|
|
@@ -1772,11 +1962,13 @@ export interface GetSnowballUsageRequest {
|
|
|
1772
1962
|
*/
|
|
1773
1963
|
export interface GetSnowballUsageResult {
|
|
1774
1964
|
/**
|
|
1965
|
+
* @public
|
|
1775
1966
|
* <p>The service limit for number of Snow devices this account can have at once. The default
|
|
1776
1967
|
* service limit is 1 (one).</p>
|
|
1777
1968
|
*/
|
|
1778
1969
|
SnowballLimit?: number;
|
|
1779
1970
|
/**
|
|
1971
|
+
* @public
|
|
1780
1972
|
* <p>The number of Snow devices that this account is currently using.</p>
|
|
1781
1973
|
*/
|
|
1782
1974
|
SnowballsInUse?: number;
|
|
@@ -1786,6 +1978,7 @@ export interface GetSnowballUsageResult {
|
|
|
1786
1978
|
*/
|
|
1787
1979
|
export interface GetSoftwareUpdatesRequest {
|
|
1788
1980
|
/**
|
|
1981
|
+
* @public
|
|
1789
1982
|
* <p>The ID for a job that you want to get the software update file for, for example
|
|
1790
1983
|
* <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
1791
1984
|
*/
|
|
@@ -1796,6 +1989,7 @@ export interface GetSoftwareUpdatesRequest {
|
|
|
1796
1989
|
*/
|
|
1797
1990
|
export interface GetSoftwareUpdatesResult {
|
|
1798
1991
|
/**
|
|
1992
|
+
* @public
|
|
1799
1993
|
* <p>The Amazon S3 presigned URL for the update file associated with the specified
|
|
1800
1994
|
* <code>JobId</code> value. The software update will be available for 2 days after this
|
|
1801
1995
|
* request is made. To access an update after the 2 days have passed, you'll have to make another
|
|
@@ -1808,15 +2002,18 @@ export interface GetSoftwareUpdatesResult {
|
|
|
1808
2002
|
*/
|
|
1809
2003
|
export interface ListClusterJobsRequest {
|
|
1810
2004
|
/**
|
|
2005
|
+
* @public
|
|
1811
2006
|
* <p>The 39-character ID for the cluster that you want to list, for example
|
|
1812
2007
|
* <code>CID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
1813
2008
|
*/
|
|
1814
2009
|
ClusterId: string | undefined;
|
|
1815
2010
|
/**
|
|
2011
|
+
* @public
|
|
1816
2012
|
* <p>The number of <code>JobListEntry</code> objects to return.</p>
|
|
1817
2013
|
*/
|
|
1818
2014
|
MaxResults?: number;
|
|
1819
2015
|
/**
|
|
2016
|
+
* @public
|
|
1820
2017
|
* <p>HTTP requests are stateless. To identify what object comes "next" in the list of
|
|
1821
2018
|
* <code>JobListEntry</code> objects, you have the option of specifying <code>NextToken</code>
|
|
1822
2019
|
* as the starting point for your returned list.</p>
|
|
@@ -1828,11 +2025,13 @@ export interface ListClusterJobsRequest {
|
|
|
1828
2025
|
*/
|
|
1829
2026
|
export interface ListClusterJobsResult {
|
|
1830
2027
|
/**
|
|
2028
|
+
* @public
|
|
1831
2029
|
* <p>Each <code>JobListEntry</code> object contains a job's state, a job's ID, and a value
|
|
1832
2030
|
* that indicates whether the job is a job part, in the case of export jobs. </p>
|
|
1833
2031
|
*/
|
|
1834
2032
|
JobListEntries?: JobListEntry[];
|
|
1835
2033
|
/**
|
|
2034
|
+
* @public
|
|
1836
2035
|
* <p>HTTP requests are stateless. If you use the automatically generated
|
|
1837
2036
|
* <code>NextToken</code> value in your next <code>ListClusterJobsResult</code> call, your list
|
|
1838
2037
|
* of returned jobs will start from this point in the array.</p>
|
|
@@ -1844,10 +2043,12 @@ export interface ListClusterJobsResult {
|
|
|
1844
2043
|
*/
|
|
1845
2044
|
export interface ListClustersRequest {
|
|
1846
2045
|
/**
|
|
2046
|
+
* @public
|
|
1847
2047
|
* <p>The number of <code>ClusterListEntry</code> objects to return.</p>
|
|
1848
2048
|
*/
|
|
1849
2049
|
MaxResults?: number;
|
|
1850
2050
|
/**
|
|
2051
|
+
* @public
|
|
1851
2052
|
* <p>HTTP requests are stateless. To identify what object comes "next" in the list of
|
|
1852
2053
|
* <code>ClusterListEntry</code> objects, you have the option of specifying
|
|
1853
2054
|
* <code>NextToken</code> as the starting point for your returned list.</p>
|
|
@@ -1860,20 +2061,24 @@ export interface ListClustersRequest {
|
|
|
1860
2061
|
*/
|
|
1861
2062
|
export interface ClusterListEntry {
|
|
1862
2063
|
/**
|
|
2064
|
+
* @public
|
|
1863
2065
|
* <p>The 39-character ID for the cluster that you want to list, for example
|
|
1864
2066
|
* <code>CID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
1865
2067
|
*/
|
|
1866
2068
|
ClusterId?: string;
|
|
1867
2069
|
/**
|
|
2070
|
+
* @public
|
|
1868
2071
|
* <p>The current state of this cluster. For information about the state of a specific node,
|
|
1869
2072
|
* see <a>JobListEntry$JobState</a>.</p>
|
|
1870
2073
|
*/
|
|
1871
2074
|
ClusterState?: ClusterState | string;
|
|
1872
2075
|
/**
|
|
2076
|
+
* @public
|
|
1873
2077
|
* <p>The creation date for this cluster.</p>
|
|
1874
2078
|
*/
|
|
1875
2079
|
CreationDate?: Date;
|
|
1876
2080
|
/**
|
|
2081
|
+
* @public
|
|
1877
2082
|
* <p>Defines an optional description of the cluster, for example <code>Environmental Data
|
|
1878
2083
|
* Cluster-01</code>.</p>
|
|
1879
2084
|
*/
|
|
@@ -1884,11 +2089,13 @@ export interface ClusterListEntry {
|
|
|
1884
2089
|
*/
|
|
1885
2090
|
export interface ListClustersResult {
|
|
1886
2091
|
/**
|
|
2092
|
+
* @public
|
|
1887
2093
|
* <p>Each <code>ClusterListEntry</code> object contains a cluster's state, a cluster's ID,
|
|
1888
2094
|
* and other important status information.</p>
|
|
1889
2095
|
*/
|
|
1890
2096
|
ClusterListEntries?: ClusterListEntry[];
|
|
1891
2097
|
/**
|
|
2098
|
+
* @public
|
|
1892
2099
|
* <p>HTTP requests are stateless. If you use the automatically generated
|
|
1893
2100
|
* <code>NextToken</code> value in your next <code>ClusterListEntry</code> call, your list of
|
|
1894
2101
|
* returned clusters will start from this point in the array.</p>
|
|
@@ -1900,11 +2107,13 @@ export interface ListClustersResult {
|
|
|
1900
2107
|
*/
|
|
1901
2108
|
export interface ListCompatibleImagesRequest {
|
|
1902
2109
|
/**
|
|
2110
|
+
* @public
|
|
1903
2111
|
* <p>The maximum number of results for the list of compatible images. Currently, a Snowball
|
|
1904
2112
|
* Edge device can store 10 AMIs.</p>
|
|
1905
2113
|
*/
|
|
1906
2114
|
MaxResults?: number;
|
|
1907
2115
|
/**
|
|
2116
|
+
* @public
|
|
1908
2117
|
* <p>HTTP requests are stateless. To identify what object comes "next" in the list of
|
|
1909
2118
|
* compatible images, you can specify a value for <code>NextToken</code> as the starting point
|
|
1910
2119
|
* for your list of returned images.</p>
|
|
@@ -1920,10 +2129,12 @@ export interface ListCompatibleImagesRequest {
|
|
|
1920
2129
|
*/
|
|
1921
2130
|
export interface CompatibleImage {
|
|
1922
2131
|
/**
|
|
2132
|
+
* @public
|
|
1923
2133
|
* <p>The unique identifier for an individual Snow device AMI.</p>
|
|
1924
2134
|
*/
|
|
1925
2135
|
AmiId?: string;
|
|
1926
2136
|
/**
|
|
2137
|
+
* @public
|
|
1927
2138
|
* <p>The optional name of a compatible image.</p>
|
|
1928
2139
|
*/
|
|
1929
2140
|
Name?: string;
|
|
@@ -1933,11 +2144,13 @@ export interface CompatibleImage {
|
|
|
1933
2144
|
*/
|
|
1934
2145
|
export interface ListCompatibleImagesResult {
|
|
1935
2146
|
/**
|
|
2147
|
+
* @public
|
|
1936
2148
|
* <p>A JSON-formatted object that describes a compatible AMI, including the ID and name for
|
|
1937
2149
|
* a Snow device AMI.</p>
|
|
1938
2150
|
*/
|
|
1939
2151
|
CompatibleImages?: CompatibleImage[];
|
|
1940
2152
|
/**
|
|
2153
|
+
* @public
|
|
1941
2154
|
* <p>Because HTTP requests are stateless, this is the starting point for your next list of
|
|
1942
2155
|
* returned images.</p>
|
|
1943
2156
|
*/
|
|
@@ -1948,10 +2161,12 @@ export interface ListCompatibleImagesResult {
|
|
|
1948
2161
|
*/
|
|
1949
2162
|
export interface ListJobsRequest {
|
|
1950
2163
|
/**
|
|
2164
|
+
* @public
|
|
1951
2165
|
* <p>The number of <code>JobListEntry</code> objects to return.</p>
|
|
1952
2166
|
*/
|
|
1953
2167
|
MaxResults?: number;
|
|
1954
2168
|
/**
|
|
2169
|
+
* @public
|
|
1955
2170
|
* <p>HTTP requests are stateless. To identify what object comes "next" in the list of
|
|
1956
2171
|
* <code>JobListEntry</code> objects, you have the option of specifying <code>NextToken</code>
|
|
1957
2172
|
* as the starting point for your returned list.</p>
|
|
@@ -1963,11 +2178,13 @@ export interface ListJobsRequest {
|
|
|
1963
2178
|
*/
|
|
1964
2179
|
export interface ListJobsResult {
|
|
1965
2180
|
/**
|
|
2181
|
+
* @public
|
|
1966
2182
|
* <p>Each <code>JobListEntry</code> object contains a job's state, a job's ID, and a value
|
|
1967
2183
|
* that indicates whether the job is a job part, in the case of export jobs. </p>
|
|
1968
2184
|
*/
|
|
1969
2185
|
JobListEntries?: JobListEntry[];
|
|
1970
2186
|
/**
|
|
2187
|
+
* @public
|
|
1971
2188
|
* <p>HTTP requests are stateless. If you use this automatically generated
|
|
1972
2189
|
* <code>NextToken</code> value in your next <code>ListJobs</code> call, your returned
|
|
1973
2190
|
* <code>JobListEntry</code> objects will start from this point in the array.</p>
|
|
@@ -1979,10 +2196,12 @@ export interface ListJobsResult {
|
|
|
1979
2196
|
*/
|
|
1980
2197
|
export interface ListLongTermPricingRequest {
|
|
1981
2198
|
/**
|
|
2199
|
+
* @public
|
|
1982
2200
|
* <p>The maximum number of <code>ListLongTermPricing</code> objects to return.</p>
|
|
1983
2201
|
*/
|
|
1984
2202
|
MaxResults?: number;
|
|
1985
2203
|
/**
|
|
2204
|
+
* @public
|
|
1986
2205
|
* <p>Because HTTP requests are stateless, this is the starting point for your next list of
|
|
1987
2206
|
* <code>ListLongTermPricing</code> to return.</p>
|
|
1988
2207
|
*/
|
|
@@ -1995,43 +2214,53 @@ export interface ListLongTermPricingRequest {
|
|
|
1995
2214
|
*/
|
|
1996
2215
|
export interface LongTermPricingListEntry {
|
|
1997
2216
|
/**
|
|
2217
|
+
* @public
|
|
1998
2218
|
* <p>The ID of the long-term pricing type for the device.</p>
|
|
1999
2219
|
*/
|
|
2000
2220
|
LongTermPricingId?: string;
|
|
2001
2221
|
/**
|
|
2222
|
+
* @public
|
|
2002
2223
|
* <p>The end date the long-term pricing contract.</p>
|
|
2003
2224
|
*/
|
|
2004
2225
|
LongTermPricingEndDate?: Date;
|
|
2005
2226
|
/**
|
|
2227
|
+
* @public
|
|
2006
2228
|
* <p>The start date of the long-term pricing contract.</p>
|
|
2007
2229
|
*/
|
|
2008
2230
|
LongTermPricingStartDate?: Date;
|
|
2009
2231
|
/**
|
|
2232
|
+
* @public
|
|
2010
2233
|
* <p>The type of long-term pricing that was selected for the device.</p>
|
|
2011
2234
|
*/
|
|
2012
2235
|
LongTermPricingType?: LongTermPricingType | string;
|
|
2013
2236
|
/**
|
|
2237
|
+
* @public
|
|
2014
2238
|
* <p>The current active jobs on the device the long-term pricing type.</p>
|
|
2015
2239
|
*/
|
|
2016
2240
|
CurrentActiveJob?: string;
|
|
2017
2241
|
/**
|
|
2242
|
+
* @public
|
|
2018
2243
|
* <p>A new device that replaces a device that is ordered with long-term pricing.</p>
|
|
2019
2244
|
*/
|
|
2020
2245
|
ReplacementJob?: string;
|
|
2021
2246
|
/**
|
|
2247
|
+
* @public
|
|
2022
2248
|
* <p>If set to <code>true</code>, specifies that the current long-term pricing type for the
|
|
2023
2249
|
* device should be automatically renewed before the long-term pricing contract expires.</p>
|
|
2024
2250
|
*/
|
|
2025
2251
|
IsLongTermPricingAutoRenew?: boolean;
|
|
2026
2252
|
/**
|
|
2253
|
+
* @public
|
|
2027
2254
|
* <p>The status of the long-term pricing type.</p>
|
|
2028
2255
|
*/
|
|
2029
2256
|
LongTermPricingStatus?: string;
|
|
2030
2257
|
/**
|
|
2258
|
+
* @public
|
|
2031
2259
|
* <p>The type of Snow Family devices associated with this long-term pricing job.</p>
|
|
2032
2260
|
*/
|
|
2033
2261
|
SnowballType?: SnowballType | string;
|
|
2034
2262
|
/**
|
|
2263
|
+
* @public
|
|
2035
2264
|
* <p>The IDs of the jobs that are associated with a long-term pricing type.</p>
|
|
2036
2265
|
*/
|
|
2037
2266
|
JobIds?: string[];
|
|
@@ -2041,11 +2270,13 @@ export interface LongTermPricingListEntry {
|
|
|
2041
2270
|
*/
|
|
2042
2271
|
export interface ListLongTermPricingResult {
|
|
2043
2272
|
/**
|
|
2273
|
+
* @public
|
|
2044
2274
|
* <p>Each <code>LongTermPricingEntry</code> object contains a status, ID, and other information
|
|
2045
2275
|
* about the <code>LongTermPricing</code> type. </p>
|
|
2046
2276
|
*/
|
|
2047
2277
|
LongTermPricingEntries?: LongTermPricingListEntry[];
|
|
2048
2278
|
/**
|
|
2279
|
+
* @public
|
|
2049
2280
|
* <p>Because HTTP requests are stateless, this is the starting point for your next list of
|
|
2050
2281
|
* returned <code>ListLongTermPricing</code> list.</p>
|
|
2051
2282
|
*/
|
|
@@ -2056,10 +2287,12 @@ export interface ListLongTermPricingResult {
|
|
|
2056
2287
|
*/
|
|
2057
2288
|
export interface ListPickupLocationsRequest {
|
|
2058
2289
|
/**
|
|
2290
|
+
* @public
|
|
2059
2291
|
* <p>The maximum number of locations to list per page.</p>
|
|
2060
2292
|
*/
|
|
2061
2293
|
MaxResults?: number;
|
|
2062
2294
|
/**
|
|
2295
|
+
* @public
|
|
2063
2296
|
* <p>HTTP requests are stateless. To identify what object comes "next" in the list of <code>ListPickupLocationsRequest</code> objects, you have the option of specifying <code>NextToken</code> as the starting point for your returned list.</p>
|
|
2064
2297
|
*/
|
|
2065
2298
|
NextToken?: string;
|
|
@@ -2069,10 +2302,12 @@ export interface ListPickupLocationsRequest {
|
|
|
2069
2302
|
*/
|
|
2070
2303
|
export interface ListPickupLocationsResult {
|
|
2071
2304
|
/**
|
|
2305
|
+
* @public
|
|
2072
2306
|
* <p>Information about the address of pickup locations.</p>
|
|
2073
2307
|
*/
|
|
2074
2308
|
Addresses?: Address[];
|
|
2075
2309
|
/**
|
|
2310
|
+
* @public
|
|
2076
2311
|
* <p>HTTP requests are stateless. To identify what object comes "next" in the list of <code>ListPickupLocationsResult</code> objects, you have the option of specifying <code>NextToken</code> as the starting point for your returned list.</p>
|
|
2077
2312
|
*/
|
|
2078
2313
|
NextToken?: string;
|
|
@@ -2095,6 +2330,7 @@ export type ServiceName = (typeof ServiceName)[keyof typeof ServiceName];
|
|
|
2095
2330
|
*/
|
|
2096
2331
|
export interface ServiceVersion {
|
|
2097
2332
|
/**
|
|
2333
|
+
* @public
|
|
2098
2334
|
* <p>The version number of the requested service.</p>
|
|
2099
2335
|
*/
|
|
2100
2336
|
Version?: string;
|
|
@@ -2105,10 +2341,12 @@ export interface ServiceVersion {
|
|
|
2105
2341
|
*/
|
|
2106
2342
|
export interface DependentService {
|
|
2107
2343
|
/**
|
|
2344
|
+
* @public
|
|
2108
2345
|
* <p>The name of the dependent service.</p>
|
|
2109
2346
|
*/
|
|
2110
2347
|
ServiceName?: ServiceName | string;
|
|
2111
2348
|
/**
|
|
2349
|
+
* @public
|
|
2112
2350
|
* <p>The version of the dependent service.</p>
|
|
2113
2351
|
*/
|
|
2114
2352
|
ServiceVersion?: ServiceVersion;
|
|
@@ -2118,18 +2356,22 @@ export interface DependentService {
|
|
|
2118
2356
|
*/
|
|
2119
2357
|
export interface ListServiceVersionsRequest {
|
|
2120
2358
|
/**
|
|
2359
|
+
* @public
|
|
2121
2360
|
* <p>The name of the service for which you're requesting supported versions.</p>
|
|
2122
2361
|
*/
|
|
2123
2362
|
ServiceName: ServiceName | string | undefined;
|
|
2124
2363
|
/**
|
|
2364
|
+
* @public
|
|
2125
2365
|
* <p>A list of names and versions of dependant services of the requested service.</p>
|
|
2126
2366
|
*/
|
|
2127
2367
|
DependentServices?: DependentService[];
|
|
2128
2368
|
/**
|
|
2369
|
+
* @public
|
|
2129
2370
|
* <p>The maximum number of <code>ListServiceVersions</code> objects to return.</p>
|
|
2130
2371
|
*/
|
|
2131
2372
|
MaxResults?: number;
|
|
2132
2373
|
/**
|
|
2374
|
+
* @public
|
|
2133
2375
|
* <p>Because HTTP requests are stateless, this is the starting point for the next list of returned
|
|
2134
2376
|
* <code>ListServiceVersionsRequest</code> versions.</p>
|
|
2135
2377
|
*/
|
|
@@ -2140,18 +2382,22 @@ export interface ListServiceVersionsRequest {
|
|
|
2140
2382
|
*/
|
|
2141
2383
|
export interface ListServiceVersionsResult {
|
|
2142
2384
|
/**
|
|
2385
|
+
* @public
|
|
2143
2386
|
* <p>A list of supported versions.</p>
|
|
2144
2387
|
*/
|
|
2145
2388
|
ServiceVersions: ServiceVersion[] | undefined;
|
|
2146
2389
|
/**
|
|
2390
|
+
* @public
|
|
2147
2391
|
* <p>The name of the service for which the system provided supported versions.</p>
|
|
2148
2392
|
*/
|
|
2149
2393
|
ServiceName: ServiceName | string | undefined;
|
|
2150
2394
|
/**
|
|
2395
|
+
* @public
|
|
2151
2396
|
* <p>A list of names and versions of dependant services of the service for which the system provided supported versions.</p>
|
|
2152
2397
|
*/
|
|
2153
2398
|
DependentServices?: DependentService[];
|
|
2154
2399
|
/**
|
|
2400
|
+
* @public
|
|
2155
2401
|
* <p>Because HTTP requests are stateless, this is the starting point of the next list of returned
|
|
2156
2402
|
* <code>ListServiceVersionsResult</code> results.</p>
|
|
2157
2403
|
*/
|
|
@@ -2162,44 +2408,53 @@ export interface ListServiceVersionsResult {
|
|
|
2162
2408
|
*/
|
|
2163
2409
|
export interface UpdateClusterRequest {
|
|
2164
2410
|
/**
|
|
2411
|
+
* @public
|
|
2165
2412
|
* <p>The cluster ID of the cluster that you want to update, for example
|
|
2166
2413
|
* <code>CID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
2167
2414
|
*/
|
|
2168
2415
|
ClusterId: string | undefined;
|
|
2169
2416
|
/**
|
|
2417
|
+
* @public
|
|
2170
2418
|
* <p>The new role Amazon Resource Name (ARN) that you want to associate with this cluster.
|
|
2171
2419
|
* To create a role ARN, use the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> API action in Identity and Access Management (IAM).</p>
|
|
2172
2420
|
*/
|
|
2173
2421
|
RoleARN?: string;
|
|
2174
2422
|
/**
|
|
2423
|
+
* @public
|
|
2175
2424
|
* <p>The updated description of this cluster.</p>
|
|
2176
2425
|
*/
|
|
2177
2426
|
Description?: string;
|
|
2178
2427
|
/**
|
|
2428
|
+
* @public
|
|
2179
2429
|
* <p>The updated arrays of <a>JobResource</a> objects that can include updated
|
|
2180
2430
|
* <a>S3Resource</a> objects or <a>LambdaResource</a> objects.</p>
|
|
2181
2431
|
*/
|
|
2182
2432
|
Resources?: JobResource;
|
|
2183
2433
|
/**
|
|
2434
|
+
* @public
|
|
2184
2435
|
* <p>Specifies the service or services on the Snow Family device that your transferred data
|
|
2185
2436
|
* will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS
|
|
2186
2437
|
* (Network File System).</p>
|
|
2187
2438
|
*/
|
|
2188
2439
|
OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration;
|
|
2189
2440
|
/**
|
|
2441
|
+
* @public
|
|
2190
2442
|
* <p>The ID of the updated <a>Address</a> object.</p>
|
|
2191
2443
|
*/
|
|
2192
2444
|
AddressId?: string;
|
|
2193
2445
|
/**
|
|
2446
|
+
* @public
|
|
2194
2447
|
* <p>The updated shipping option value of this cluster's <a>ShippingDetails</a>
|
|
2195
2448
|
* object.</p>
|
|
2196
2449
|
*/
|
|
2197
2450
|
ShippingOption?: ShippingOption | string;
|
|
2198
2451
|
/**
|
|
2452
|
+
* @public
|
|
2199
2453
|
* <p>The new or updated <a>Notification</a> object.</p>
|
|
2200
2454
|
*/
|
|
2201
2455
|
Notification?: Notification;
|
|
2202
2456
|
/**
|
|
2457
|
+
* @public
|
|
2203
2458
|
* <p>The updated ID for the forwarding address for a cluster. This field is not
|
|
2204
2459
|
* supported in most regions.</p>
|
|
2205
2460
|
*/
|
|
@@ -2215,44 +2470,53 @@ export interface UpdateClusterResult {
|
|
|
2215
2470
|
*/
|
|
2216
2471
|
export interface UpdateJobRequest {
|
|
2217
2472
|
/**
|
|
2473
|
+
* @public
|
|
2218
2474
|
* <p>The job ID of the job that you want to update, for example
|
|
2219
2475
|
* <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
2220
2476
|
*/
|
|
2221
2477
|
JobId: string | undefined;
|
|
2222
2478
|
/**
|
|
2479
|
+
* @public
|
|
2223
2480
|
* <p>The new role Amazon Resource Name (ARN) that you want to associate with this job. To
|
|
2224
2481
|
* create a role ARN, use the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a>Identity and Access Management
|
|
2225
2482
|
* (IAM) API action.</p>
|
|
2226
2483
|
*/
|
|
2227
2484
|
RoleARN?: string;
|
|
2228
2485
|
/**
|
|
2486
|
+
* @public
|
|
2229
2487
|
* <p>The new or updated <a>Notification</a> object.</p>
|
|
2230
2488
|
*/
|
|
2231
2489
|
Notification?: Notification;
|
|
2232
2490
|
/**
|
|
2491
|
+
* @public
|
|
2233
2492
|
* <p>The updated <code>JobResource</code> object, or the updated <a>JobResource</a> object. </p>
|
|
2234
2493
|
*/
|
|
2235
2494
|
Resources?: JobResource;
|
|
2236
2495
|
/**
|
|
2496
|
+
* @public
|
|
2237
2497
|
* <p>Specifies the service or services on the Snow Family device that your transferred data
|
|
2238
2498
|
* will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File
|
|
2239
2499
|
* System) and the Amazon Web Services Storage Gateway service Tape Gateway type.</p>
|
|
2240
2500
|
*/
|
|
2241
2501
|
OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration;
|
|
2242
2502
|
/**
|
|
2503
|
+
* @public
|
|
2243
2504
|
* <p>The ID of the updated <a>Address</a> object.</p>
|
|
2244
2505
|
*/
|
|
2245
2506
|
AddressId?: string;
|
|
2246
2507
|
/**
|
|
2508
|
+
* @public
|
|
2247
2509
|
* <p>The updated shipping option value of this job's <a>ShippingDetails</a>
|
|
2248
2510
|
* object.</p>
|
|
2249
2511
|
*/
|
|
2250
2512
|
ShippingOption?: ShippingOption | string;
|
|
2251
2513
|
/**
|
|
2514
|
+
* @public
|
|
2252
2515
|
* <p>The updated description of this job's <a>JobMetadata</a> object.</p>
|
|
2253
2516
|
*/
|
|
2254
2517
|
Description?: string;
|
|
2255
2518
|
/**
|
|
2519
|
+
* @public
|
|
2256
2520
|
* <p>The updated <code>SnowballCapacityPreference</code> of this job's <a>JobMetadata</a> object. The 50 TB Snowballs are only available in the US
|
|
2257
2521
|
* regions.</p>
|
|
2258
2522
|
* <p>For more information, see
|
|
@@ -2263,11 +2527,13 @@ export interface UpdateJobRequest {
|
|
|
2263
2527
|
*/
|
|
2264
2528
|
SnowballCapacityPreference?: SnowballCapacity | string;
|
|
2265
2529
|
/**
|
|
2530
|
+
* @public
|
|
2266
2531
|
* <p>The updated ID for the forwarding address for a job. This field is not
|
|
2267
2532
|
* supported in most regions.</p>
|
|
2268
2533
|
*/
|
|
2269
2534
|
ForwardingAddressId?: string;
|
|
2270
2535
|
/**
|
|
2536
|
+
* @public
|
|
2271
2537
|
* <p>Information identifying the person picking up the device.</p>
|
|
2272
2538
|
*/
|
|
2273
2539
|
PickupDetails?: PickupDetails;
|
|
@@ -2294,11 +2560,13 @@ export type ShipmentState = (typeof ShipmentState)[keyof typeof ShipmentState];
|
|
|
2294
2560
|
*/
|
|
2295
2561
|
export interface UpdateJobShipmentStateRequest {
|
|
2296
2562
|
/**
|
|
2563
|
+
* @public
|
|
2297
2564
|
* <p>The job ID of the job whose shipment date you want to update, for example
|
|
2298
2565
|
* <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
2299
2566
|
*/
|
|
2300
2567
|
JobId: string | undefined;
|
|
2301
2568
|
/**
|
|
2569
|
+
* @public
|
|
2302
2570
|
* <p>The state of a device when it is being shipped. </p>
|
|
2303
2571
|
* <p>Set to <code>RECEIVED</code> when the device arrives at your location.</p>
|
|
2304
2572
|
* <p>Set to <code>RETURNED</code> when you have returned the device to Amazon Web Services.</p>
|
|
@@ -2315,15 +2583,18 @@ export interface UpdateJobShipmentStateResult {
|
|
|
2315
2583
|
*/
|
|
2316
2584
|
export interface UpdateLongTermPricingRequest {
|
|
2317
2585
|
/**
|
|
2586
|
+
* @public
|
|
2318
2587
|
* <p>The ID of the long-term pricing type for the device.</p>
|
|
2319
2588
|
*/
|
|
2320
2589
|
LongTermPricingId: string | undefined;
|
|
2321
2590
|
/**
|
|
2591
|
+
* @public
|
|
2322
2592
|
* <p>Specifies that a device that is ordered with long-term pricing should be replaced with a
|
|
2323
2593
|
* new device.</p>
|
|
2324
2594
|
*/
|
|
2325
2595
|
ReplacementJob?: string;
|
|
2326
2596
|
/**
|
|
2597
|
+
* @public
|
|
2327
2598
|
* <p>If set to <code>true</code>, specifies that the current long-term pricing type for the
|
|
2328
2599
|
* device should be automatically renewed before the long-term pricing contract expires.</p>
|
|
2329
2600
|
*/
|