@aws-sdk/client-snowball 3.43.0 → 3.44.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/CHANGELOG.md +11 -0
- package/README.md +6 -7
- package/dist-cjs/models/models_0.js +9 -2
- package/dist-cjs/protocols/Aws_json1_1.js +20 -0
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/protocols/Aws_json1_1.js +17 -1
- package/dist-types/Snowball.d.ts +31 -32
- package/dist-types/SnowballClient.d.ts +6 -7
- package/dist-types/commands/CreateJobCommand.d.ts +10 -9
- package/dist-types/commands/CreateLongTermPricingCommand.d.ts +1 -2
- package/dist-types/commands/CreateReturnShippingLabelCommand.d.ts +1 -1
- package/dist-types/commands/DescribeReturnShippingLabelCommand.d.ts +1 -1
- package/dist-types/commands/GetJobManifestCommand.d.ts +1 -1
- package/dist-types/commands/GetJobUnlockCodeCommand.d.ts +4 -4
- package/dist-types/commands/GetSnowballUsageCommand.d.ts +2 -2
- package/dist-types/commands/GetSoftwareUpdatesCommand.d.ts +1 -1
- package/dist-types/commands/ListCompatibleImagesCommand.d.ts +4 -4
- package/dist-types/models/models_0.d.ts +192 -147
- package/dist-types/ts3.4/models/models_0.d.ts +15 -0
- package/package.json +1 -1
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
|
|
2
2
|
/**
|
|
3
|
-
* <p>The address that you want the Snow device(s) associated with a specific job to
|
|
4
|
-
*
|
|
5
|
-
*
|
|
3
|
+
* <p>The address that you want the Snow device(s) associated with a specific job to be
|
|
4
|
+
* shipped to. Addresses are validated at the time of creation. The address you provide must be
|
|
5
|
+
* located within the serviceable area of your region. Although no individual elements of the
|
|
6
6
|
* <code>Address</code> are required, if the address is invalid or unsupported, then an
|
|
7
7
|
* exception is thrown.</p>
|
|
8
8
|
*/
|
|
@@ -131,8 +131,8 @@ export declare namespace InvalidResourceException {
|
|
|
131
131
|
const filterSensitiveLog: (obj: InvalidResourceException) => any;
|
|
132
132
|
}
|
|
133
133
|
/**
|
|
134
|
-
* <p>The provided
|
|
135
|
-
*
|
|
134
|
+
* <p>The provided Key Management Service key lacks the permissions to perform the specified
|
|
135
|
+
* <a>CreateJob</a> or <a>UpdateJob</a> action.</p>
|
|
136
136
|
*/
|
|
137
137
|
export interface KMSRequestFailedException extends __SmithyException, $MetadataBearer {
|
|
138
138
|
name: "KMSRequestFailedException";
|
|
@@ -181,7 +181,8 @@ export declare namespace CreateAddressRequest {
|
|
|
181
181
|
export interface CreateAddressResult {
|
|
182
182
|
/**
|
|
183
183
|
* <p>The automatically generated ID for a specific address. You'll use this ID when you
|
|
184
|
-
* create a job to specify which address you want the Snow device for that job shipped
|
|
184
|
+
* create a job to specify which address you want the Snow device for that job shipped
|
|
185
|
+
* to.</p>
|
|
185
186
|
*/
|
|
186
187
|
AddressId?: string;
|
|
187
188
|
}
|
|
@@ -209,7 +210,7 @@ export declare namespace InvalidAddressException {
|
|
|
209
210
|
/**
|
|
210
211
|
* <p>The address is either outside the serviceable area for your region, or an error
|
|
211
212
|
* occurred. Check the address with your region's carrier and try again. If the issue persists,
|
|
212
|
-
* contact
|
|
213
|
+
* contact Amazon Web Services Support.</p>
|
|
213
214
|
*/
|
|
214
215
|
export interface UnsupportedAddressException extends __SmithyException, $MetadataBearer {
|
|
215
216
|
name: "UnsupportedAddressException";
|
|
@@ -259,8 +260,8 @@ export interface Notification {
|
|
|
259
260
|
* 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
|
|
260
261
|
* action.</p>
|
|
261
262
|
*
|
|
262
|
-
* <p>You can subscribe email addresses to an Amazon SNS topic through the
|
|
263
|
-
*
|
|
263
|
+
* <p>You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html">Subscribe</a> Amazon Simple Notification
|
|
264
|
+
* Service (Amazon SNS) API action.</p>
|
|
264
265
|
*/
|
|
265
266
|
SnsTopicARN?: string;
|
|
266
267
|
/**
|
|
@@ -282,11 +283,12 @@ export declare enum StorageUnit {
|
|
|
282
283
|
TB = "TB"
|
|
283
284
|
}
|
|
284
285
|
/**
|
|
285
|
-
* <p>An object that represents metadata and configuration settings for NFS
|
|
286
|
+
* <p>An object that represents the metadata and configuration settings for the NFS (Network
|
|
287
|
+
* File System) service on an Amazon Web Services Snow Family device.</p>
|
|
286
288
|
*/
|
|
287
289
|
export interface NFSOnDeviceServiceConfiguration {
|
|
288
290
|
/**
|
|
289
|
-
* <p>The maximum NFS storage for one
|
|
291
|
+
* <p>The maximum NFS storage for one Snow Family device.</p>
|
|
290
292
|
*/
|
|
291
293
|
StorageLimit?: number;
|
|
292
294
|
/**
|
|
@@ -302,13 +304,39 @@ export declare namespace NFSOnDeviceServiceConfiguration {
|
|
|
302
304
|
const filterSensitiveLog: (obj: NFSOnDeviceServiceConfiguration) => any;
|
|
303
305
|
}
|
|
304
306
|
/**
|
|
305
|
-
* <p>An object that represents metadata and configuration settings for
|
|
307
|
+
* <p>An object that represents the metadata and configuration settings for the Storage Gateway
|
|
308
|
+
* service Tape Gateway type on an Amazon Web Services Snow Family device.</p>
|
|
309
|
+
*/
|
|
310
|
+
export interface TGWOnDeviceServiceConfiguration {
|
|
311
|
+
/**
|
|
312
|
+
* <p>The maximum number of virtual tapes to store on one Snow Family device. Due to physical
|
|
313
|
+
* resource limitations, this value must be set to 80 for Snowball Edge.</p>
|
|
314
|
+
*/
|
|
315
|
+
StorageLimit?: number;
|
|
316
|
+
/**
|
|
317
|
+
* <p>The scale unit of the virtual tapes on the device.</p>
|
|
318
|
+
*/
|
|
319
|
+
StorageUnit?: StorageUnit | string;
|
|
320
|
+
}
|
|
321
|
+
export declare namespace TGWOnDeviceServiceConfiguration {
|
|
322
|
+
/**
|
|
323
|
+
* @internal
|
|
324
|
+
*/
|
|
325
|
+
const filterSensitiveLog: (obj: TGWOnDeviceServiceConfiguration) => any;
|
|
326
|
+
}
|
|
327
|
+
/**
|
|
328
|
+
* <p>An object that represents the metadata and configuration settings for services on an Amazon Web Services
|
|
329
|
+
* Snow Family device.</p>
|
|
306
330
|
*/
|
|
307
331
|
export interface OnDeviceServiceConfiguration {
|
|
308
332
|
/**
|
|
309
|
-
* <p>Represents the NFS service on a Snow Family device.</p>
|
|
333
|
+
* <p>Represents the NFS (Network File System) service on a Snow Family device.</p>
|
|
310
334
|
*/
|
|
311
335
|
NFSOnDeviceService?: NFSOnDeviceServiceConfiguration;
|
|
336
|
+
/**
|
|
337
|
+
* <p>Represents the Storage Gateway service Tape Gateway type on a Snow Family device.</p>
|
|
338
|
+
*/
|
|
339
|
+
TGWOnDeviceService?: TGWOnDeviceServiceConfiguration;
|
|
312
340
|
}
|
|
313
341
|
export declare namespace OnDeviceServiceConfiguration {
|
|
314
342
|
/**
|
|
@@ -323,7 +351,7 @@ export declare enum RemoteManagement {
|
|
|
323
351
|
/**
|
|
324
352
|
* <p>A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI),
|
|
325
353
|
* including the Amazon EC2 AMI ID and the Snow device AMI ID. Each AMI has these two IDs to
|
|
326
|
-
* simplify identifying the AMI in both the
|
|
354
|
+
* simplify identifying the AMI in both the Amazon Web Services Cloud and on the device.</p>
|
|
327
355
|
*/
|
|
328
356
|
export interface Ec2AmiResource {
|
|
329
357
|
/**
|
|
@@ -346,8 +374,7 @@ export declare namespace Ec2AmiResource {
|
|
|
346
374
|
*/
|
|
347
375
|
export interface EventTriggerDefinition {
|
|
348
376
|
/**
|
|
349
|
-
* <p>The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an
|
|
350
|
-
* function's event trigger associated with this job.</p>
|
|
377
|
+
* <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>
|
|
351
378
|
*/
|
|
352
379
|
EventResourceARN?: string;
|
|
353
380
|
}
|
|
@@ -362,8 +389,8 @@ export declare namespace EventTriggerDefinition {
|
|
|
362
389
|
*/
|
|
363
390
|
export interface LambdaResource {
|
|
364
391
|
/**
|
|
365
|
-
* <p>An Amazon Resource Name (ARN) that represents an
|
|
366
|
-
* PUT object actions on the associated local Amazon S3 resource.</p>
|
|
392
|
+
* <p>An Amazon Resource Name (ARN) that represents an Lambda function to be
|
|
393
|
+
* triggered by PUT object actions on the associated local Amazon S3 resource.</p>
|
|
367
394
|
*/
|
|
368
395
|
LambdaArn?: string;
|
|
369
396
|
/**
|
|
@@ -412,16 +439,18 @@ export declare enum TransferOption {
|
|
|
412
439
|
}
|
|
413
440
|
/**
|
|
414
441
|
* <p>An object that represents the service or services on the Snow Family device that your
|
|
415
|
-
* transferred data will be exported from or imported into.
|
|
442
|
+
* transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and
|
|
443
|
+
* NFS (Network File System).</p>
|
|
416
444
|
*/
|
|
417
445
|
export interface TargetOnDeviceService {
|
|
418
446
|
/**
|
|
419
|
-
* <p>Specifies the name of the service on the Snow Family device that your
|
|
420
|
-
*
|
|
447
|
+
* <p>Specifies the name of the service on the Snow Family device that your transferred data
|
|
448
|
+
* will be exported from or imported into.</p>
|
|
421
449
|
*/
|
|
422
450
|
ServiceName?: DeviceServiceName | string;
|
|
423
451
|
/**
|
|
424
|
-
* <p>Specifies whether the data is being imported or exported. You can import or export the
|
|
452
|
+
* <p>Specifies whether the data is being imported or exported. You can import or export the
|
|
453
|
+
* data, or use it locally on the device.</p>
|
|
425
454
|
*/
|
|
426
455
|
TransferOption?: TransferOption | string;
|
|
427
456
|
}
|
|
@@ -451,8 +480,9 @@ export interface S3Resource {
|
|
|
451
480
|
*/
|
|
452
481
|
KeyRange?: KeyRange;
|
|
453
482
|
/**
|
|
454
|
-
* <p>Specifies the service or services on the Snow Family device that your
|
|
455
|
-
*
|
|
483
|
+
* <p>Specifies the service or services on the Snow Family device that your transferred data
|
|
484
|
+
* will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File
|
|
485
|
+
* System).</p>
|
|
456
486
|
*/
|
|
457
487
|
TargetOnDeviceServices?: TargetOnDeviceService[];
|
|
458
488
|
}
|
|
@@ -463,9 +493,9 @@ export declare namespace S3Resource {
|
|
|
463
493
|
const filterSensitiveLog: (obj: S3Resource) => any;
|
|
464
494
|
}
|
|
465
495
|
/**
|
|
466
|
-
* <p>Contains an array of
|
|
467
|
-
* an
|
|
468
|
-
* associated with a particular job.</p>
|
|
496
|
+
* <p>Contains an array of Amazon Web Services resource objects. Each object represents an
|
|
497
|
+
* Amazon S3 bucket, an Lambda function, or an Amazon Machine Image (AMI) based
|
|
498
|
+
* on Amazon EC2 that is associated with a particular job.</p>
|
|
469
499
|
*/
|
|
470
500
|
export interface JobResource {
|
|
471
501
|
/**
|
|
@@ -503,11 +533,12 @@ export declare enum SnowballType {
|
|
|
503
533
|
STANDARD = "STANDARD"
|
|
504
534
|
}
|
|
505
535
|
/**
|
|
506
|
-
* <p>The tax documents required in
|
|
536
|
+
* <p>The tax documents required in Amazon Web Services Region in India.</p>
|
|
507
537
|
*/
|
|
508
538
|
export interface INDTaxDocuments {
|
|
509
539
|
/**
|
|
510
|
-
* <p>The Goods and Services Tax (GST) documents required in
|
|
540
|
+
* <p>The Goods and Services Tax (GST) documents required in Amazon Web Services Region in
|
|
541
|
+
* India.</p>
|
|
511
542
|
*/
|
|
512
543
|
GSTIN?: string;
|
|
513
544
|
}
|
|
@@ -518,11 +549,11 @@ export declare namespace INDTaxDocuments {
|
|
|
518
549
|
const filterSensitiveLog: (obj: INDTaxDocuments) => any;
|
|
519
550
|
}
|
|
520
551
|
/**
|
|
521
|
-
* <p>The tax documents required in your
|
|
552
|
+
* <p>The tax documents required in your Amazon Web Services Region.</p>
|
|
522
553
|
*/
|
|
523
554
|
export interface TaxDocuments {
|
|
524
555
|
/**
|
|
525
|
-
* <p>The tax documents required in
|
|
556
|
+
* <p>The tax documents required in Amazon Web Services Region in India.</p>
|
|
526
557
|
*/
|
|
527
558
|
IND?: INDTaxDocuments;
|
|
528
559
|
}
|
|
@@ -546,12 +577,14 @@ export interface CreateClusterRequest {
|
|
|
546
577
|
JobType: JobType | string | undefined;
|
|
547
578
|
/**
|
|
548
579
|
* <p>The resources associated with the cluster job. These resources include Amazon S3
|
|
549
|
-
* buckets and optional
|
|
580
|
+
* buckets and optional Lambda functions written in the Python language.
|
|
581
|
+
* </p>
|
|
550
582
|
*/
|
|
551
583
|
Resources: JobResource | undefined;
|
|
552
584
|
/**
|
|
553
|
-
* <p>Specifies the service or services on the Snow Family device that your
|
|
554
|
-
*
|
|
585
|
+
* <p>Specifies the service or services on the Snow Family device that your transferred data
|
|
586
|
+
* will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS
|
|
587
|
+
* (Network File System).</p>
|
|
555
588
|
*/
|
|
556
589
|
OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration;
|
|
557
590
|
/**
|
|
@@ -565,21 +598,19 @@ export interface CreateClusterRequest {
|
|
|
565
598
|
AddressId: string | undefined;
|
|
566
599
|
/**
|
|
567
600
|
* <p>The <code>KmsKeyARN</code> value that you want to associate with this cluster.
|
|
568
|
-
* <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
|
|
569
|
-
* Management Service (AWS KMS). </p>
|
|
601
|
+
* <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>
|
|
570
602
|
*/
|
|
571
603
|
KmsKeyARN?: string;
|
|
572
604
|
/**
|
|
573
605
|
* <p>The <code>RoleARN</code> that you want to associate with this cluster.
|
|
574
|
-
* <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
|
|
575
|
-
* Identity and Access Management (IAM).</p>
|
|
606
|
+
* <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>
|
|
576
607
|
*/
|
|
577
608
|
RoleARN: string | undefined;
|
|
578
609
|
/**
|
|
579
|
-
* <p>The type of
|
|
580
|
-
* </p>
|
|
610
|
+
* <p>The type of Snow Family Devices to use for this cluster. </p>
|
|
581
611
|
* <note>
|
|
582
|
-
* <p>For cluster jobs,
|
|
612
|
+
* <p>For cluster jobs, Amazon Web Services Snow Family currently supports only the
|
|
613
|
+
* <code>EDGE</code> device type.</p>
|
|
583
614
|
* </note>
|
|
584
615
|
*
|
|
585
616
|
* <p>For more information, see
|
|
@@ -592,16 +623,15 @@ export interface CreateClusterRequest {
|
|
|
592
623
|
/**
|
|
593
624
|
* <p>The shipping speed for each node in this cluster. This speed doesn't dictate how soon
|
|
594
625
|
* you'll get each Snowball Edge device, rather it represents how quickly each device moves to
|
|
595
|
-
* its destination while in transit. Regional shipping speeds are as follows:
|
|
596
|
-
* </p>
|
|
626
|
+
* its destination while in transit. Regional shipping speeds are as follows: </p>
|
|
597
627
|
* <ul>
|
|
598
628
|
* <li>
|
|
599
629
|
* <p>In Australia, you have access to express shipping. Typically, Snow devices shipped
|
|
600
630
|
* express are delivered in about a day.</p>
|
|
601
631
|
* </li>
|
|
602
632
|
* <li>
|
|
603
|
-
* <p>In the European Union (EU), you have access to express shipping. Typically,
|
|
604
|
-
*
|
|
633
|
+
* <p>In the European Union (EU), you have access to express shipping. Typically, Snow
|
|
634
|
+
* devices shipped express are delivered in about a day. In addition, most countries in the
|
|
605
635
|
* EU have access to standard shipping, which typically takes less than a week, one
|
|
606
636
|
* way.</p>
|
|
607
637
|
* </li>
|
|
@@ -620,9 +650,9 @@ export interface CreateClusterRequest {
|
|
|
620
650
|
* express are delivered in about a day.</p>
|
|
621
651
|
* </li>
|
|
622
652
|
* <li>
|
|
623
|
-
* <p>In the European Union (EU), you have access to express shipping. Typically,
|
|
624
|
-
*
|
|
625
|
-
*
|
|
653
|
+
* <p>In the European Union (EU), you have access to express shipping. Typically, Snow
|
|
654
|
+
* devices shipped express are delivered in about a day. In addition, most countries in the
|
|
655
|
+
* EU have access to standard shipping, which typically takes less than a week, one
|
|
626
656
|
* way.</p>
|
|
627
657
|
* </li>
|
|
628
658
|
* <li>
|
|
@@ -645,7 +675,7 @@ export interface CreateClusterRequest {
|
|
|
645
675
|
*/
|
|
646
676
|
ForwardingAddressId?: string;
|
|
647
677
|
/**
|
|
648
|
-
* <p>The tax documents required in your
|
|
678
|
+
* <p>The tax documents required in your Amazon Web Services Region.</p>
|
|
649
679
|
*/
|
|
650
680
|
TaxDocuments?: TaxDocuments;
|
|
651
681
|
/**
|
|
@@ -690,8 +720,7 @@ export declare namespace Ec2RequestFailedException {
|
|
|
690
720
|
const filterSensitiveLog: (obj: Ec2RequestFailedException) => any;
|
|
691
721
|
}
|
|
692
722
|
/**
|
|
693
|
-
* <p>Job or cluster creation failed. One or more inputs were invalid. Confirm that the
|
|
694
|
-
* <a>CreateClusterRequest$SnowballType</a> value supports your <a>CreateJobRequest$JobType</a>, and try again.</p>
|
|
723
|
+
* <p>Job or cluster creation failed. One or more inputs were invalid. Confirm that the <a>CreateClusterRequest$SnowballType</a> value supports your <a>CreateJobRequest$JobType</a>, and try again.</p>
|
|
695
724
|
*/
|
|
696
725
|
export interface InvalidInputCombinationException extends __SmithyException, $MetadataBearer {
|
|
697
726
|
name: "InvalidInputCombinationException";
|
|
@@ -721,11 +750,11 @@ export declare namespace ClusterLimitExceededException {
|
|
|
721
750
|
const filterSensitiveLog: (obj: ClusterLimitExceededException) => any;
|
|
722
751
|
}
|
|
723
752
|
/**
|
|
724
|
-
* <p>Configures the wireless connection on an
|
|
753
|
+
* <p>Configures the wireless connection on an Snowcone device.</p>
|
|
725
754
|
*/
|
|
726
755
|
export interface WirelessConnection {
|
|
727
756
|
/**
|
|
728
|
-
* <p>Enables the Wi-Fi adapter on an
|
|
757
|
+
* <p>Enables the Wi-Fi adapter on an Snowcone device.</p>
|
|
729
758
|
*/
|
|
730
759
|
IsWifiEnabled?: boolean;
|
|
731
760
|
}
|
|
@@ -736,11 +765,11 @@ export declare namespace WirelessConnection {
|
|
|
736
765
|
const filterSensitiveLog: (obj: WirelessConnection) => any;
|
|
737
766
|
}
|
|
738
767
|
/**
|
|
739
|
-
* <p>Specifies the device configuration for an
|
|
768
|
+
* <p>Specifies the device configuration for an Snowcone job.</p>
|
|
740
769
|
*/
|
|
741
770
|
export interface SnowconeDeviceConfiguration {
|
|
742
771
|
/**
|
|
743
|
-
* <p>Configures the wireless connection for the
|
|
772
|
+
* <p>Configures the wireless connection for the Snowcone device.</p>
|
|
744
773
|
*/
|
|
745
774
|
WirelessConnection?: WirelessConnection;
|
|
746
775
|
}
|
|
@@ -755,7 +784,8 @@ export declare namespace SnowconeDeviceConfiguration {
|
|
|
755
784
|
*/
|
|
756
785
|
export interface DeviceConfiguration {
|
|
757
786
|
/**
|
|
758
|
-
* <p>Returns information about the device configuration for an
|
|
787
|
+
* <p>Returns information about the device configuration for an Snowcone
|
|
788
|
+
* job.</p>
|
|
759
789
|
*/
|
|
760
790
|
SnowconeDeviceConfiguration?: SnowconeDeviceConfiguration;
|
|
761
791
|
}
|
|
@@ -795,8 +825,9 @@ export interface CreateJobRequest {
|
|
|
795
825
|
*/
|
|
796
826
|
Resources?: JobResource;
|
|
797
827
|
/**
|
|
798
|
-
* <p>Specifies the service or services on the Snow Family device that your
|
|
799
|
-
*
|
|
828
|
+
* <p>Specifies the service or services on the Snow Family device that your transferred data
|
|
829
|
+
* will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File
|
|
830
|
+
* System) and the Amazon Web Services Storage Gateway service Tape Gateway type.</p>
|
|
800
831
|
*/
|
|
801
832
|
OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration;
|
|
802
833
|
/**
|
|
@@ -810,14 +841,14 @@ export interface CreateJobRequest {
|
|
|
810
841
|
AddressId?: string;
|
|
811
842
|
/**
|
|
812
843
|
* <p>The <code>KmsKeyARN</code> that you want to associate with this job.
|
|
813
|
-
* <code>KmsKeyARN</code>s are created using the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a>
|
|
814
|
-
* Service (KMS) API action.</p>
|
|
844
|
+
* <code>KmsKeyARN</code>s are created using the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a>
|
|
845
|
+
* Key Management Service (KMS) API action.</p>
|
|
815
846
|
*/
|
|
816
847
|
KmsKeyARN?: string;
|
|
817
848
|
/**
|
|
818
849
|
* <p>The <code>RoleARN</code> that you want to associate with this job.
|
|
819
|
-
* <code>RoleArn</code>s are created using the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a>
|
|
820
|
-
* Access Management (IAM) API action.</p>
|
|
850
|
+
* <code>RoleArn</code>s are created using the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a>
|
|
851
|
+
* Identity and Access Management (IAM) API action.</p>
|
|
821
852
|
*/
|
|
822
853
|
RoleARN?: string;
|
|
823
854
|
/**
|
|
@@ -834,8 +865,8 @@ export interface CreateJobRequest {
|
|
|
834
865
|
SnowballCapacityPreference?: SnowballCapacity | string;
|
|
835
866
|
/**
|
|
836
867
|
* <p>The shipping speed for this job. This speed doesn't dictate how soon you'll get the
|
|
837
|
-
* Snow device, rather it represents how quickly the Snow device moves to its destination while
|
|
838
|
-
* transit. Regional shipping speeds are as follows:</p>
|
|
868
|
+
* Snow device, rather it represents how quickly the Snow device moves to its destination while
|
|
869
|
+
* in transit. Regional shipping speeds are as follows:</p>
|
|
839
870
|
*
|
|
840
871
|
* <ul>
|
|
841
872
|
* <li>
|
|
@@ -843,8 +874,8 @@ export interface CreateJobRequest {
|
|
|
843
874
|
* express are delivered in about a day.</p>
|
|
844
875
|
* </li>
|
|
845
876
|
* <li>
|
|
846
|
-
* <p>In the European Union (EU), you have access to express shipping. Typically,
|
|
847
|
-
*
|
|
877
|
+
* <p>In the European Union (EU), you have access to express shipping. Typically, Snow
|
|
878
|
+
* devices shipped express are delivered in about a day. In addition, most countries in the
|
|
848
879
|
* EU have access to standard shipping, which typically takes less than a week, one
|
|
849
880
|
* way.</p>
|
|
850
881
|
* </li>
|
|
@@ -869,15 +900,16 @@ export interface CreateJobRequest {
|
|
|
869
900
|
*/
|
|
870
901
|
ClusterId?: string;
|
|
871
902
|
/**
|
|
872
|
-
* <p>The type of
|
|
903
|
+
* <p>The type of Snow Family Devices to use for this job.
|
|
873
904
|
* </p>
|
|
874
905
|
* <note>
|
|
875
|
-
* <p>For cluster jobs,
|
|
906
|
+
* <p>For cluster jobs, Amazon Web Services Snow Family currently supports only the
|
|
907
|
+
* <code>EDGE</code> device type.</p>
|
|
876
908
|
* </note>
|
|
877
|
-
* <p>The type of
|
|
878
|
-
* device type for cluster jobs is <code>EDGE</code>.</p>
|
|
909
|
+
* <p>The type of Amazon Web Services Snow device to use for this job. Currently, the only
|
|
910
|
+
* supported device type for cluster jobs is <code>EDGE</code>.</p>
|
|
879
911
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/snowball/latest/developer-guide/device-differences.html">Snowball Edge Device
|
|
880
|
-
*
|
|
912
|
+
* Options</a> in the Snowball Edge Developer Guide.</p>
|
|
881
913
|
*
|
|
882
914
|
* <p>For more information, see
|
|
883
915
|
* "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow
|
|
@@ -892,11 +924,11 @@ export interface CreateJobRequest {
|
|
|
892
924
|
*/
|
|
893
925
|
ForwardingAddressId?: string;
|
|
894
926
|
/**
|
|
895
|
-
* <p>The tax documents required in your
|
|
927
|
+
* <p>The tax documents required in your Amazon Web Services Region.</p>
|
|
896
928
|
*/
|
|
897
929
|
TaxDocuments?: TaxDocuments;
|
|
898
930
|
/**
|
|
899
|
-
* <p>Defines the device configuration for an
|
|
931
|
+
* <p>Defines the device configuration for an Snowcone job.</p>
|
|
900
932
|
*
|
|
901
933
|
* <p>For more information, see
|
|
902
934
|
* "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow
|
|
@@ -947,11 +979,12 @@ export interface CreateLongTermPricingRequest {
|
|
|
947
979
|
*/
|
|
948
980
|
LongTermPricingType: LongTermPricingType | string | undefined;
|
|
949
981
|
/**
|
|
950
|
-
* <p>Specifies whether the current long-term pricing type for the device should be
|
|
982
|
+
* <p>Specifies whether the current long-term pricing type for the device should be
|
|
983
|
+
* renewed.</p>
|
|
951
984
|
*/
|
|
952
985
|
IsLongTermPricingAutoRenew?: boolean;
|
|
953
986
|
/**
|
|
954
|
-
* <p>The type of
|
|
987
|
+
* <p>The type of Snow Family Devices to use for the long-term pricing job.</p>
|
|
955
988
|
*/
|
|
956
989
|
SnowballType?: SnowballType | string;
|
|
957
990
|
}
|
|
@@ -974,7 +1007,8 @@ export declare namespace CreateLongTermPricingResult {
|
|
|
974
1007
|
const filterSensitiveLog: (obj: CreateLongTermPricingResult) => any;
|
|
975
1008
|
}
|
|
976
1009
|
/**
|
|
977
|
-
* <p>You get this exception when you call <code>CreateReturnShippingLabel</code> more than once
|
|
1010
|
+
* <p>You get this exception when you call <code>CreateReturnShippingLabel</code> more than once
|
|
1011
|
+
* when other requests are not completed.</p>
|
|
978
1012
|
*/
|
|
979
1013
|
export interface ConflictException extends __SmithyException, $MetadataBearer {
|
|
980
1014
|
name: "ConflictException";
|
|
@@ -995,8 +1029,8 @@ export interface CreateReturnShippingLabelRequest {
|
|
|
995
1029
|
*/
|
|
996
1030
|
JobId: string | undefined;
|
|
997
1031
|
/**
|
|
998
|
-
* <p>The shipping speed for a particular job. This speed doesn't dictate how soon the device
|
|
999
|
-
* This speed represents how quickly it moves to its
|
|
1032
|
+
* <p>The shipping speed for a particular job. This speed doesn't dictate how soon the device
|
|
1033
|
+
* is returned to Amazon Web Services. This speed represents how quickly it moves to its
|
|
1000
1034
|
* destination while in transit. Regional shipping speeds are as follows:</p>
|
|
1001
1035
|
*/
|
|
1002
1036
|
ShippingOption?: ShippingOption | string;
|
|
@@ -1015,7 +1049,7 @@ export declare enum ShippingLabelStatus {
|
|
|
1015
1049
|
}
|
|
1016
1050
|
export interface CreateReturnShippingLabelResult {
|
|
1017
1051
|
/**
|
|
1018
|
-
* <p>The status information of the task on a Snow device that is being returned to
|
|
1052
|
+
* <p>The status information of the task on a Snow device that is being returned to Amazon Web Services.</p>
|
|
1019
1053
|
*/
|
|
1020
1054
|
Status?: ShippingLabelStatus | string;
|
|
1021
1055
|
}
|
|
@@ -1026,9 +1060,9 @@ export declare namespace CreateReturnShippingLabelResult {
|
|
|
1026
1060
|
const filterSensitiveLog: (obj: CreateReturnShippingLabelResult) => any;
|
|
1027
1061
|
}
|
|
1028
1062
|
/**
|
|
1029
|
-
* <p>You get this exception if you call <code>CreateReturnShippingLabel</code> and a valid
|
|
1030
|
-
* shipping label already exists. In this case, use
|
|
1031
|
-
* <code>DescribeReturnShippingLabel</code> to get the
|
|
1063
|
+
* <p>You get this exception if you call <code>CreateReturnShippingLabel</code> and a valid
|
|
1064
|
+
* return shipping label already exists. In this case, use
|
|
1065
|
+
* <code>DescribeReturnShippingLabel</code> to get the URL.</p>
|
|
1032
1066
|
*/
|
|
1033
1067
|
export interface ReturnShippingLabelAlreadyExistsException extends __SmithyException, $MetadataBearer {
|
|
1034
1068
|
name: "ReturnShippingLabelAlreadyExistsException";
|
|
@@ -1055,8 +1089,8 @@ export declare namespace DescribeAddressRequest {
|
|
|
1055
1089
|
}
|
|
1056
1090
|
export interface DescribeAddressResult {
|
|
1057
1091
|
/**
|
|
1058
|
-
* <p>The address that you want the Snow device(s) associated with a specific job to
|
|
1059
|
-
*
|
|
1092
|
+
* <p>The address that you want the Snow device(s) associated with a specific job to be
|
|
1093
|
+
* shipped to.</p>
|
|
1060
1094
|
*/
|
|
1061
1095
|
Address?: Address;
|
|
1062
1096
|
}
|
|
@@ -1151,13 +1185,12 @@ export interface ClusterMetadata {
|
|
|
1151
1185
|
Description?: string;
|
|
1152
1186
|
/**
|
|
1153
1187
|
* <p>The <code>KmsKeyARN</code> Amazon Resource Name (ARN) associated with this cluster.
|
|
1154
|
-
* This ARN was created using the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a> API action in
|
|
1155
|
-
* Management Service (AWS KMS).</p>
|
|
1188
|
+
* 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>
|
|
1156
1189
|
*/
|
|
1157
1190
|
KmsKeyARN?: string;
|
|
1158
1191
|
/**
|
|
1159
1192
|
* <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>
|
|
1160
|
-
* API action in
|
|
1193
|
+
* API action in Identity and Access Management (IAM).</p>
|
|
1161
1194
|
*/
|
|
1162
1195
|
RoleARN?: string;
|
|
1163
1196
|
/**
|
|
@@ -1170,10 +1203,11 @@ export interface ClusterMetadata {
|
|
|
1170
1203
|
*/
|
|
1171
1204
|
JobType?: JobType | string;
|
|
1172
1205
|
/**
|
|
1173
|
-
* <p>The type of
|
|
1206
|
+
* <p>The type of Snowcone device to use for this cluster.
|
|
1174
1207
|
* </p>
|
|
1175
1208
|
* <note>
|
|
1176
|
-
* <p>For cluster jobs,
|
|
1209
|
+
* <p>For cluster jobs, Amazon Web Services Snow Family currently supports only the
|
|
1210
|
+
* <code>EDGE</code> device type.</p>
|
|
1177
1211
|
* </note>
|
|
1178
1212
|
*/
|
|
1179
1213
|
SnowballType?: SnowballType | string;
|
|
@@ -1191,8 +1225,8 @@ export interface ClusterMetadata {
|
|
|
1191
1225
|
AddressId?: string;
|
|
1192
1226
|
/**
|
|
1193
1227
|
* <p>The shipping speed for each node in this cluster. This speed doesn't dictate how soon
|
|
1194
|
-
* you'll get each device, rather it represents how quickly each device moves to
|
|
1195
|
-
*
|
|
1228
|
+
* you'll get each device, rather it represents how quickly each device moves to its destination
|
|
1229
|
+
* while in transit. Regional shipping speeds are as follows:</p>
|
|
1196
1230
|
*
|
|
1197
1231
|
* <ul>
|
|
1198
1232
|
* <li>
|
|
@@ -1200,9 +1234,9 @@ export interface ClusterMetadata {
|
|
|
1200
1234
|
* express are delivered in about a day.</p>
|
|
1201
1235
|
* </li>
|
|
1202
1236
|
* <li>
|
|
1203
|
-
* <p>In the European Union (EU), you have access to express shipping. Typically,
|
|
1204
|
-
*
|
|
1205
|
-
*
|
|
1237
|
+
* <p>In the European Union (EU), you have access to express shipping. Typically, Snow
|
|
1238
|
+
* devices shipped express are delivered in about a day. In addition, most countries in the
|
|
1239
|
+
* EU have access to standard shipping, which typically takes less than a week, one
|
|
1206
1240
|
* way.</p>
|
|
1207
1241
|
* </li>
|
|
1208
1242
|
* <li>
|
|
@@ -1225,11 +1259,12 @@ export interface ClusterMetadata {
|
|
|
1225
1259
|
*/
|
|
1226
1260
|
ForwardingAddressId?: string;
|
|
1227
1261
|
/**
|
|
1228
|
-
* <p>The tax documents required in your
|
|
1262
|
+
* <p>The tax documents required in your Amazon Web Services Region.</p>
|
|
1229
1263
|
*/
|
|
1230
1264
|
TaxDocuments?: TaxDocuments;
|
|
1231
1265
|
/**
|
|
1232
|
-
* <p>Represents metadata and configuration settings for services on an
|
|
1266
|
+
* <p>Represents metadata and configuration settings for services on an Amazon Web Services Snow Family
|
|
1267
|
+
* device.</p>
|
|
1233
1268
|
*/
|
|
1234
1269
|
OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration;
|
|
1235
1270
|
}
|
|
@@ -1266,9 +1301,9 @@ export declare namespace DescribeJobRequest {
|
|
|
1266
1301
|
const filterSensitiveLog: (obj: DescribeJobRequest) => any;
|
|
1267
1302
|
}
|
|
1268
1303
|
/**
|
|
1269
|
-
* <p>Defines the real-time status of a Snow device's data transfer while the device is at
|
|
1270
|
-
*
|
|
1271
|
-
*
|
|
1304
|
+
* <p>Defines the real-time status of a Snow device's data transfer while the device is at
|
|
1305
|
+
* Amazon Web Services. This data is only available while a job has a <code>JobState</code>
|
|
1306
|
+
* value of <code>InProgress</code>, for both import and export jobs.</p>
|
|
1272
1307
|
*/
|
|
1273
1308
|
export interface DataTransfer {
|
|
1274
1309
|
/**
|
|
@@ -1280,13 +1315,14 @@ export interface DataTransfer {
|
|
|
1280
1315
|
*/
|
|
1281
1316
|
ObjectsTransferred?: number;
|
|
1282
1317
|
/**
|
|
1283
|
-
* <p>The total bytes of data for a transfer between a Snow device and Amazon S3. This value
|
|
1284
|
-
* set to 0 (zero) until all the keys that will be transferred have been listed.</p>
|
|
1318
|
+
* <p>The total bytes of data for a transfer between a Snow device and Amazon S3. This value
|
|
1319
|
+
* is set to 0 (zero) until all the keys that will be transferred have been listed.</p>
|
|
1285
1320
|
*/
|
|
1286
1321
|
TotalBytes?: number;
|
|
1287
1322
|
/**
|
|
1288
|
-
* <p>The total number of objects for a transfer between a Snow device and Amazon S3. This
|
|
1289
|
-
* is set to 0 (zero) until all the keys that will be transferred have been
|
|
1323
|
+
* <p>The total number of objects for a transfer between a Snow device and Amazon S3. This
|
|
1324
|
+
* value is set to 0 (zero) until all the keys that will be transferred have been
|
|
1325
|
+
* listed.</p>
|
|
1290
1326
|
*/
|
|
1291
1327
|
TotalObjects?: number;
|
|
1292
1328
|
}
|
|
@@ -1297,16 +1333,16 @@ export declare namespace DataTransfer {
|
|
|
1297
1333
|
const filterSensitiveLog: (obj: DataTransfer) => any;
|
|
1298
1334
|
}
|
|
1299
1335
|
/**
|
|
1300
|
-
* <p>Contains job logs. Whenever a Snow device is used to import data into or export data
|
|
1301
|
-
* Amazon S3, you'll have the option of downloading a PDF job report. Job logs are
|
|
1302
|
-
* part of the response syntax of the <code>DescribeJob</code> action in the
|
|
1336
|
+
* <p>Contains job logs. Whenever a Snow device is used to import data into or export data
|
|
1337
|
+
* out of Amazon S3, you'll have the option of downloading a PDF job report. Job logs are
|
|
1338
|
+
* returned as a part of the response syntax of the <code>DescribeJob</code> action in the
|
|
1303
1339
|
* <code>JobMetadata</code> data type. The job logs can be accessed for up to 60 minutes after
|
|
1304
1340
|
* this request has been made. To access any of the job logs after 60 minutes have passed, you'll
|
|
1305
1341
|
* have to make another call to the <code>DescribeJob</code> action.</p>
|
|
1306
1342
|
*
|
|
1307
1343
|
* <p>For import jobs, the PDF job report becomes available at the end of the import process.
|
|
1308
|
-
* For export jobs, your job report typically becomes available while the Snow device for your
|
|
1309
|
-
* part is being delivered to you.</p>
|
|
1344
|
+
* For export jobs, your job report typically becomes available while the Snow device for your
|
|
1345
|
+
* job part is being delivered to you.</p>
|
|
1310
1346
|
*
|
|
1311
1347
|
* <p>The job report provides you insight into the state of your Amazon S3 data transfer. The
|
|
1312
1348
|
* report includes details about your job or job part for your records.</p>
|
|
@@ -1367,8 +1403,8 @@ export declare namespace Shipment {
|
|
|
1367
1403
|
export interface ShippingDetails {
|
|
1368
1404
|
/**
|
|
1369
1405
|
* <p>The shipping speed for a particular job. This speed doesn't dictate how soon you'll get
|
|
1370
|
-
* the Snow device from the job's creation date. This speed represents how quickly it moves to
|
|
1371
|
-
* destination while in transit. Regional shipping speeds are as follows:</p>
|
|
1406
|
+
* the Snow device from the job's creation date. This speed represents how quickly it moves to
|
|
1407
|
+
* its destination while in transit. Regional shipping speeds are as follows:</p>
|
|
1372
1408
|
*
|
|
1373
1409
|
* <ul>
|
|
1374
1410
|
* <li>
|
|
@@ -1376,8 +1412,8 @@ export interface ShippingDetails {
|
|
|
1376
1412
|
* express are delivered in about a day.</p>
|
|
1377
1413
|
* </li>
|
|
1378
1414
|
* <li>
|
|
1379
|
-
* <p>In the European Union (EU), you have access to express shipping. Typically,
|
|
1380
|
-
*
|
|
1415
|
+
* <p>In the European Union (EU), you have access to express shipping. Typically, Snow
|
|
1416
|
+
* devices shipped express are delivered in about a day. In addition, most countries in the
|
|
1381
1417
|
* EU have access to standard shipping, which typically takes less than a week, one
|
|
1382
1418
|
* way.</p>
|
|
1383
1419
|
* </li>
|
|
@@ -1393,7 +1429,7 @@ export interface ShippingDetails {
|
|
|
1393
1429
|
ShippingOption?: ShippingOption | string;
|
|
1394
1430
|
/**
|
|
1395
1431
|
* <p>The <code>Status</code> and <code>TrackingNumber</code> values for a Snow device being
|
|
1396
|
-
* returned to
|
|
1432
|
+
* returned to Amazon Web Services for a particular job.</p>
|
|
1397
1433
|
*/
|
|
1398
1434
|
InboundShipment?: Shipment;
|
|
1399
1435
|
/**
|
|
@@ -1446,14 +1482,13 @@ export interface JobMetadata {
|
|
|
1446
1482
|
*/
|
|
1447
1483
|
Description?: string;
|
|
1448
1484
|
/**
|
|
1449
|
-
* <p>The Amazon Resource Name (ARN) for the
|
|
1450
|
-
* 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
|
|
1451
|
-
* KMS.</p>
|
|
1485
|
+
* <p>The Amazon Resource Name (ARN) for the Key Management Service (KMS) key
|
|
1486
|
+
* 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>
|
|
1452
1487
|
*/
|
|
1453
1488
|
KmsKeyARN?: string;
|
|
1454
1489
|
/**
|
|
1455
1490
|
* <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>
|
|
1456
|
-
* API action in
|
|
1491
|
+
* API action in Identity and Access Management.</p>
|
|
1457
1492
|
*/
|
|
1458
1493
|
RoleARN?: string;
|
|
1459
1494
|
/**
|
|
@@ -1486,15 +1521,16 @@ export interface JobMetadata {
|
|
|
1486
1521
|
Notification?: Notification;
|
|
1487
1522
|
/**
|
|
1488
1523
|
* <p>A value that defines the real-time status of a Snow device's data transfer while the
|
|
1489
|
-
* device is at
|
|
1490
|
-
* <code>InProgress</code>, for both import and export
|
|
1524
|
+
* device is at Amazon Web Services. This data is only available while a job has a
|
|
1525
|
+
* <code>JobState</code> value of <code>InProgress</code>, for both import and export
|
|
1526
|
+
* jobs.</p>
|
|
1491
1527
|
*/
|
|
1492
1528
|
DataTransferProgress?: DataTransfer;
|
|
1493
1529
|
/**
|
|
1494
1530
|
* <p>Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF
|
|
1495
1531
|
* job report becomes available at the end of the import process. For export jobs, your job
|
|
1496
|
-
* report typically becomes available while the Snow device for your job part is being delivered
|
|
1497
|
-
* you.</p>
|
|
1532
|
+
* report typically becomes available while the Snow device for your job part is being delivered
|
|
1533
|
+
* to you.</p>
|
|
1498
1534
|
*/
|
|
1499
1535
|
JobLogInfo?: JobLogs;
|
|
1500
1536
|
/**
|
|
@@ -1508,7 +1544,7 @@ export interface JobMetadata {
|
|
|
1508
1544
|
*/
|
|
1509
1545
|
ForwardingAddressId?: string;
|
|
1510
1546
|
/**
|
|
1511
|
-
* <p>The metadata associated with the tax documents required in your
|
|
1547
|
+
* <p>The metadata associated with the tax documents required in your Amazon Web Services Region.</p>
|
|
1512
1548
|
*/
|
|
1513
1549
|
TaxDocuments?: TaxDocuments;
|
|
1514
1550
|
/**
|
|
@@ -1527,7 +1563,8 @@ export interface JobMetadata {
|
|
|
1527
1563
|
*/
|
|
1528
1564
|
LongTermPricingId?: string;
|
|
1529
1565
|
/**
|
|
1530
|
-
* <p>Represents metadata and configuration settings for services on an
|
|
1566
|
+
* <p>Represents metadata and configuration settings for services on an Amazon Web Services Snow Family
|
|
1567
|
+
* device.</p>
|
|
1531
1568
|
*/
|
|
1532
1569
|
OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration;
|
|
1533
1570
|
}
|
|
@@ -1558,7 +1595,7 @@ export declare namespace DescribeJobResult {
|
|
|
1558
1595
|
export interface DescribeReturnShippingLabelRequest {
|
|
1559
1596
|
/**
|
|
1560
1597
|
* <p>The automatically generated ID for a job, for example
|
|
1561
|
-
*
|
|
1598
|
+
* <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
1562
1599
|
*/
|
|
1563
1600
|
JobId: string | undefined;
|
|
1564
1601
|
}
|
|
@@ -1570,13 +1607,17 @@ export declare namespace DescribeReturnShippingLabelRequest {
|
|
|
1570
1607
|
}
|
|
1571
1608
|
export interface DescribeReturnShippingLabelResult {
|
|
1572
1609
|
/**
|
|
1573
|
-
* <p>The status information of the task on a Snow device that is being returned to
|
|
1610
|
+
* <p>The status information of the task on a Snow device that is being returned to Amazon Web Services.</p>
|
|
1574
1611
|
*/
|
|
1575
1612
|
Status?: ShippingLabelStatus | string;
|
|
1576
1613
|
/**
|
|
1577
1614
|
* <p>The expiration date of the current return shipping label.</p>
|
|
1578
1615
|
*/
|
|
1579
1616
|
ExpirationDate?: Date;
|
|
1617
|
+
/**
|
|
1618
|
+
* <p>The pre-signed Amazon S3 URI used to download the return shipping label.</p>
|
|
1619
|
+
*/
|
|
1620
|
+
ReturnShippingLabelURI?: string;
|
|
1580
1621
|
}
|
|
1581
1622
|
export declare namespace DescribeReturnShippingLabelResult {
|
|
1582
1623
|
/**
|
|
@@ -1664,7 +1705,7 @@ export declare namespace GetSnowballUsageResult {
|
|
|
1664
1705
|
export interface GetSoftwareUpdatesRequest {
|
|
1665
1706
|
/**
|
|
1666
1707
|
* <p>The ID for a job that you want to get the software update file for, for example
|
|
1667
|
-
*
|
|
1708
|
+
* <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
1668
1709
|
*/
|
|
1669
1710
|
JobId: string | undefined;
|
|
1670
1711
|
}
|
|
@@ -1677,8 +1718,9 @@ export declare namespace GetSoftwareUpdatesRequest {
|
|
|
1677
1718
|
export interface GetSoftwareUpdatesResult {
|
|
1678
1719
|
/**
|
|
1679
1720
|
* <p>The Amazon S3 presigned URL for the update file associated with the specified
|
|
1680
|
-
*
|
|
1681
|
-
* To access an update after the 2 days have passed, you'll have to make another
|
|
1721
|
+
* <code>JobId</code> value. The software update will be available for 2 days after this
|
|
1722
|
+
* request is made. To access an update after the 2 days have passed, you'll have to make another
|
|
1723
|
+
* call to <code>GetSoftwareUpdates</code>.</p>
|
|
1682
1724
|
*/
|
|
1683
1725
|
UpdatesURI?: string;
|
|
1684
1726
|
}
|
|
@@ -1726,11 +1768,11 @@ export interface JobListEntry {
|
|
|
1726
1768
|
*/
|
|
1727
1769
|
JobState?: JobState | string;
|
|
1728
1770
|
/**
|
|
1729
|
-
* <p>A value that indicates that this job is a main job. A main job represents a
|
|
1730
|
-
*
|
|
1731
|
-
*
|
|
1732
|
-
*
|
|
1733
|
-
*
|
|
1771
|
+
* <p>A value that indicates that this job is a main job. A main job represents a successful
|
|
1772
|
+
* request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each
|
|
1773
|
+
* main job will have at least one job part, and each job part is associated with a Snowball. It
|
|
1774
|
+
* might take some time before the job parts associated with a particular main job are listed,
|
|
1775
|
+
* because they are created after the main job is created.</p>
|
|
1734
1776
|
*/
|
|
1735
1777
|
IsMaster?: boolean;
|
|
1736
1778
|
/**
|
|
@@ -1946,7 +1988,7 @@ export interface ListLongTermPricingRequest {
|
|
|
1946
1988
|
MaxResults?: number;
|
|
1947
1989
|
/**
|
|
1948
1990
|
* <p>Because HTTP requests are stateless, this is the starting point for your next list of
|
|
1949
|
-
*
|
|
1991
|
+
* <code>ListLongTermPricing</code> to return.</p>
|
|
1950
1992
|
*/
|
|
1951
1993
|
NextToken?: string;
|
|
1952
1994
|
}
|
|
@@ -1957,7 +1999,8 @@ export declare namespace ListLongTermPricingRequest {
|
|
|
1957
1999
|
const filterSensitiveLog: (obj: ListLongTermPricingRequest) => any;
|
|
1958
2000
|
}
|
|
1959
2001
|
/**
|
|
1960
|
-
* <p>Each <code>LongTermPricingListEntry</code> object contains information about a long-term
|
|
2002
|
+
* <p>Each <code>LongTermPricingListEntry</code> object contains information about a long-term
|
|
2003
|
+
* pricing type.</p>
|
|
1961
2004
|
*/
|
|
1962
2005
|
export interface LongTermPricingListEntry {
|
|
1963
2006
|
/**
|
|
@@ -1994,7 +2037,7 @@ export interface LongTermPricingListEntry {
|
|
|
1994
2037
|
*/
|
|
1995
2038
|
LongTermPricingStatus?: string;
|
|
1996
2039
|
/**
|
|
1997
|
-
* <p>The type of
|
|
2040
|
+
* <p>The type of Snow Family Devices associated with this long-term pricing job.</p>
|
|
1998
2041
|
*/
|
|
1999
2042
|
SnowballType?: SnowballType | string;
|
|
2000
2043
|
/**
|
|
@@ -2034,8 +2077,7 @@ export interface UpdateClusterRequest {
|
|
|
2034
2077
|
ClusterId: string | undefined;
|
|
2035
2078
|
/**
|
|
2036
2079
|
* <p>The new role Amazon Resource Name (ARN) that you want to associate with this cluster.
|
|
2037
|
-
* 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
|
|
2038
|
-
* Identity and Access Management (IAM).</p>
|
|
2080
|
+
* 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>
|
|
2039
2081
|
*/
|
|
2040
2082
|
RoleARN?: string;
|
|
2041
2083
|
/**
|
|
@@ -2048,8 +2090,9 @@ export interface UpdateClusterRequest {
|
|
|
2048
2090
|
*/
|
|
2049
2091
|
Resources?: JobResource;
|
|
2050
2092
|
/**
|
|
2051
|
-
* <p>Specifies the service or services on the Snow Family device that your
|
|
2052
|
-
*
|
|
2093
|
+
* <p>Specifies the service or services on the Snow Family device that your transferred data
|
|
2094
|
+
* will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS
|
|
2095
|
+
* (Network File System).</p>
|
|
2053
2096
|
*/
|
|
2054
2097
|
OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration;
|
|
2055
2098
|
/**
|
|
@@ -2093,8 +2136,8 @@ export interface UpdateJobRequest {
|
|
|
2093
2136
|
JobId: string | undefined;
|
|
2094
2137
|
/**
|
|
2095
2138
|
* <p>The new role Amazon Resource Name (ARN) that you want to associate with this job. To
|
|
2096
|
-
* create a role ARN, use the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a>
|
|
2097
|
-
*
|
|
2139
|
+
* 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
|
|
2140
|
+
* (IAM) API action.</p>
|
|
2098
2141
|
*/
|
|
2099
2142
|
RoleARN?: string;
|
|
2100
2143
|
/**
|
|
@@ -2106,8 +2149,9 @@ export interface UpdateJobRequest {
|
|
|
2106
2149
|
*/
|
|
2107
2150
|
Resources?: JobResource;
|
|
2108
2151
|
/**
|
|
2109
|
-
* <p>Specifies the service or services on the Snow Family device that your
|
|
2110
|
-
*
|
|
2152
|
+
* <p>Specifies the service or services on the Snow Family device that your transferred data
|
|
2153
|
+
* will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File
|
|
2154
|
+
* System) and the Amazon Web Services Storage Gateway service Tape Gateway type.</p>
|
|
2111
2155
|
*/
|
|
2112
2156
|
OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration;
|
|
2113
2157
|
/**
|
|
@@ -2161,13 +2205,13 @@ export declare enum ShipmentState {
|
|
|
2161
2205
|
export interface UpdateJobShipmentStateRequest {
|
|
2162
2206
|
/**
|
|
2163
2207
|
* <p>The job ID of the job whose shipment date you want to update, for example
|
|
2164
|
-
*
|
|
2208
|
+
* <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>
|
|
2165
2209
|
*/
|
|
2166
2210
|
JobId: string | undefined;
|
|
2167
2211
|
/**
|
|
2168
2212
|
* <p>The state of a device when it is being shipped. </p>
|
|
2169
2213
|
* <p>Set to <code>RECEIVED</code> when the device arrives at your location.</p>
|
|
2170
|
-
* <p>Set to <code>RETURNED</code> when you have returned the device to
|
|
2214
|
+
* <p>Set to <code>RETURNED</code> when you have returned the device to Amazon Web Services.</p>
|
|
2171
2215
|
*/
|
|
2172
2216
|
ShipmentState: ShipmentState | string | undefined;
|
|
2173
2217
|
}
|
|
@@ -2191,7 +2235,8 @@ export interface UpdateLongTermPricingRequest {
|
|
|
2191
2235
|
*/
|
|
2192
2236
|
LongTermPricingId: string | undefined;
|
|
2193
2237
|
/**
|
|
2194
|
-
* <p>Specifies that a device that is ordered with long-term pricing should be replaced with a
|
|
2238
|
+
* <p>Specifies that a device that is ordered with long-term pricing should be replaced with a
|
|
2239
|
+
* new device.</p>
|
|
2195
2240
|
*/
|
|
2196
2241
|
ReplacementJob?: string;
|
|
2197
2242
|
/**
|