@aws-sdk/client-snowball 3.315.0 → 3.317.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.
@@ -84,11 +84,17 @@ export interface UpdateJobCommandOutput extends UpdateJobResult, __MetadataBeare
84
84
  * KubernetesVersion: "STRING_VALUE",
85
85
  * EKSAnywhereVersion: "STRING_VALUE",
86
86
  * },
87
+ * S3OnDeviceService: { // S3OnDeviceServiceConfiguration
88
+ * StorageLimit: Number("double"),
89
+ * StorageUnit: "TB",
90
+ * ServiceSize: Number("int"),
91
+ * FaultTolerance: Number("int"),
92
+ * },
87
93
  * },
88
94
  * AddressId: "STRING_VALUE",
89
95
  * ShippingOption: "SECOND_DAY" || "NEXT_DAY" || "EXPRESS" || "STANDARD",
90
96
  * Description: "STRING_VALUE",
91
- * SnowballCapacityPreference: "T50" || "T80" || "T100" || "T42" || "T98" || "T8" || "T14" || "T32" || "NoPreference",
97
+ * SnowballCapacityPreference: "T50" || "T80" || "T100" || "T42" || "T98" || "T8" || "T14" || "T32" || "NoPreference" || "T240",
92
98
  * ForwardingAddressId: "STRING_VALUE",
93
99
  * };
94
100
  * const command = new UpdateJobCommand(input);
@@ -107,7 +113,7 @@ export interface UpdateJobCommandOutput extends UpdateJobResult, __MetadataBeare
107
113
  * create jobs until your cluster has exactly five nodes.</p>
108
114
  *
109
115
  * @throws {@link Ec2RequestFailedException} (client fault)
110
- * <p>Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted
116
+ * <p>Your user lacks the necessary Amazon EC2 permissions to perform the attempted
111
117
  * action.</p>
112
118
  *
113
119
  * @throws {@link InvalidInputCombinationException} (client fault)
@@ -302,6 +302,30 @@ export interface NFSOnDeviceServiceConfiguration {
302
302
  */
303
303
  StorageUnit?: StorageUnit | string;
304
304
  }
305
+ /**
306
+ * @public
307
+ * <p>Amazon S3 compatible storage on Snow family devices configuration items.</p>
308
+ */
309
+ export interface S3OnDeviceServiceConfiguration {
310
+ /**
311
+ * <p>If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used.
312
+ * If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has
313
+ * the same storage limit as specified, the other input need to be provided.</p>
314
+ */
315
+ StorageLimit?: number;
316
+ /**
317
+ * <p>Storage unit. Currently the only supported unit is TB.</p>
318
+ */
319
+ StorageUnit?: StorageUnit | string;
320
+ /**
321
+ * <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>
322
+ */
323
+ ServiceSize?: number;
324
+ /**
325
+ * <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>
326
+ */
327
+ FaultTolerance?: number;
328
+ }
305
329
  /**
306
330
  * @public
307
331
  * <p>An object that represents the metadata and configuration settings for the Storage Gateway
@@ -336,6 +360,10 @@ export interface OnDeviceServiceConfiguration {
336
360
  * <p>The configuration of EKS Anywhere on the Snow Family device.</p>
337
361
  */
338
362
  EKSOnDeviceService?: EKSOnDeviceServiceConfiguration;
363
+ /**
364
+ * <p>Configuration for Amazon S3 compatible storage on Snow family devices.</p>
365
+ */
366
+ S3OnDeviceService?: S3OnDeviceServiceConfiguration;
339
367
  }
340
368
  /**
341
369
  * @public
@@ -513,6 +541,26 @@ export declare const ShippingOption: {
513
541
  * @public
514
542
  */
515
543
  export type ShippingOption = (typeof ShippingOption)[keyof typeof ShippingOption];
544
+ /**
545
+ * @public
546
+ * @enum
547
+ */
548
+ export declare const SnowballCapacity: {
549
+ readonly NO_PREFERENCE: "NoPreference";
550
+ readonly T100: "T100";
551
+ readonly T14: "T14";
552
+ readonly T240: "T240";
553
+ readonly T32: "T32";
554
+ readonly T42: "T42";
555
+ readonly T50: "T50";
556
+ readonly T8: "T8";
557
+ readonly T80: "T80";
558
+ readonly T98: "T98";
559
+ };
560
+ /**
561
+ * @public
562
+ */
563
+ export type SnowballCapacity = (typeof SnowballCapacity)[keyof typeof SnowballCapacity];
516
564
  /**
517
565
  * @public
518
566
  * @enum
@@ -526,6 +574,7 @@ export declare const SnowballType: {
526
574
  readonly SNC1_SSD: "SNC1_SSD";
527
575
  readonly STANDARD: "STANDARD";
528
576
  readonly V3_5C: "V3_5C";
577
+ readonly V3_5S: "V3_5S";
529
578
  };
530
579
  /**
531
580
  * @public
@@ -571,7 +620,7 @@ export interface CreateClusterRequest {
571
620
  * buckets and optional Lambda functions written in the Python language.
572
621
  * </p>
573
622
  */
574
- Resources: JobResource | undefined;
623
+ Resources?: JobResource;
575
624
  /**
576
625
  * <p>Specifies the service or services on the Snow Family device that your transferred data
577
626
  * will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS
@@ -596,7 +645,7 @@ export interface CreateClusterRequest {
596
645
  * <p>The <code>RoleARN</code> that you want to associate with this cluster.
597
646
  * <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>
598
647
  */
599
- RoleARN: string | undefined;
648
+ RoleARN?: string;
600
649
  /**
601
650
  * <p>The type of Snow Family devices to use for this cluster. </p>
602
651
  * <note>
@@ -674,6 +723,71 @@ export interface CreateClusterRequest {
674
723
  * use the Snowball Client to manage the device.</p>
675
724
  */
676
725
  RemoteManagement?: RemoteManagement | string;
726
+ /**
727
+ * <p>If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.</p>
728
+ */
729
+ InitialClusterSize?: number;
730
+ /**
731
+ * <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
732
+ * needed to meet capacity requirement specified with <code>OnDeviceServiceConfiguration</code>.</p>
733
+ */
734
+ ForceCreateJobs?: boolean;
735
+ /**
736
+ * <p>Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.</p>
737
+ */
738
+ LongTermPricingIds?: string[];
739
+ /**
740
+ * <p>If your job is being created in one of the US regions, you have the option of
741
+ * specifying what size Snow device you'd like for this job. In all other regions, Snowballs come
742
+ * with 80 TB in storage capacity.</p>
743
+ * <p>For more information, see
744
+ * "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow
745
+ * Family Devices and Capacity) in the <i>Snowcone User Guide</i> or
746
+ * "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow
747
+ * Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
748
+ */
749
+ SnowballCapacityPreference?: SnowballCapacity | string;
750
+ }
751
+ /**
752
+ * @public
753
+ * <p>Each <code>JobListEntry</code> object contains a job's state, a job's ID, and a value
754
+ * that indicates whether the job is a job part, in the case of an export job.</p>
755
+ */
756
+ export interface JobListEntry {
757
+ /**
758
+ * <p>The automatically generated ID for a job, for example
759
+ * <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>
760
+ */
761
+ JobId?: string;
762
+ /**
763
+ * <p>The current state of this job.</p>
764
+ */
765
+ JobState?: JobState | string;
766
+ /**
767
+ * <p>A value that indicates that this job is a main job. A main job represents a successful
768
+ * request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each
769
+ * main job will have at least one job part, and each job part is associated with a Snowball. It
770
+ * might take some time before the job parts associated with a particular main job are listed,
771
+ * because they are created after the main job is created.</p>
772
+ */
773
+ IsMaster?: boolean;
774
+ /**
775
+ * <p>The type of job.</p>
776
+ */
777
+ JobType?: JobType | string;
778
+ /**
779
+ * <p>The type of device used with this job.</p>
780
+ */
781
+ SnowballType?: SnowballType | string;
782
+ /**
783
+ * <p>The creation date for this job.</p>
784
+ */
785
+ CreationDate?: Date;
786
+ /**
787
+ * <p>The optional description of this specific job, for example <code>Important Photos
788
+ * 2016-08-11</code>.</p>
789
+ */
790
+ Description?: string;
677
791
  }
678
792
  /**
679
793
  * @public
@@ -683,10 +797,14 @@ export interface CreateClusterResult {
683
797
  * <p>The automatically generated ID for a cluster.</p>
684
798
  */
685
799
  ClusterId?: string;
800
+ /**
801
+ * <p>List of jobs created for this cluster. For syntax, see <a href="https://docs.aws.amazon.com/snowball/latest/api-reference/API_ListJobs.html#API_ListJobs_ResponseSyntax">ListJobsResult$JobListEntries</a> in this guide.</p>
802
+ */
803
+ JobListEntries?: JobListEntry[];
686
804
  }
687
805
  /**
688
806
  * @public
689
- * <p>Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted
807
+ * <p>Your user lacks the necessary Amazon EC2 permissions to perform the attempted
690
808
  * action.</p>
691
809
  */
692
810
  export declare class Ec2RequestFailedException extends __BaseException {
@@ -757,25 +875,6 @@ export interface DeviceConfiguration {
757
875
  */
758
876
  SnowconeDeviceConfiguration?: SnowconeDeviceConfiguration;
759
877
  }
760
- /**
761
- * @public
762
- * @enum
763
- */
764
- export declare const SnowballCapacity: {
765
- readonly NO_PREFERENCE: "NoPreference";
766
- readonly T100: "T100";
767
- readonly T14: "T14";
768
- readonly T32: "T32";
769
- readonly T42: "T42";
770
- readonly T50: "T50";
771
- readonly T8: "T8";
772
- readonly T80: "T80";
773
- readonly T98: "T98";
774
- };
775
- /**
776
- * @public
777
- */
778
- export type SnowballCapacity = (typeof SnowballCapacity)[keyof typeof SnowballCapacity];
779
878
  /**
780
879
  * @public
781
880
  */
@@ -932,6 +1031,7 @@ export interface CreateJobResult {
932
1031
  * @enum
933
1032
  */
934
1033
  export declare const LongTermPricingType: {
1034
+ readonly ONE_MONTH: "OneMonth";
935
1035
  readonly ONE_YEAR: "OneYear";
936
1036
  readonly THREE_YEAR: "ThreeYear";
937
1037
  };
@@ -1631,47 +1731,6 @@ export interface ListClusterJobsRequest {
1631
1731
  */
1632
1732
  NextToken?: string;
1633
1733
  }
1634
- /**
1635
- * @public
1636
- * <p>Each <code>JobListEntry</code> object contains a job's state, a job's ID, and a value
1637
- * that indicates whether the job is a job part, in the case of an export job.</p>
1638
- */
1639
- export interface JobListEntry {
1640
- /**
1641
- * <p>The automatically generated ID for a job, for example
1642
- * <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>
1643
- */
1644
- JobId?: string;
1645
- /**
1646
- * <p>The current state of this job.</p>
1647
- */
1648
- JobState?: JobState | string;
1649
- /**
1650
- * <p>A value that indicates that this job is a main job. A main job represents a successful
1651
- * request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each
1652
- * main job will have at least one job part, and each job part is associated with a Snowball. It
1653
- * might take some time before the job parts associated with a particular main job are listed,
1654
- * because they are created after the main job is created.</p>
1655
- */
1656
- IsMaster?: boolean;
1657
- /**
1658
- * <p>The type of job.</p>
1659
- */
1660
- JobType?: JobType | string;
1661
- /**
1662
- * <p>The type of device used with this job.</p>
1663
- */
1664
- SnowballType?: SnowballType | string;
1665
- /**
1666
- * <p>The creation date for this job.</p>
1667
- */
1668
- CreationDate?: Date;
1669
- /**
1670
- * <p>The optional description of this specific job, for example <code>Important Photos
1671
- * 2016-08-11</code>.</p>
1672
- */
1673
- Description?: string;
1674
- }
1675
1734
  /**
1676
1735
  * @public
1677
1736
  */
@@ -104,7 +104,7 @@ import {
104
104
  UpdateLongTermPricingCommandOutput,
105
105
  } from "./commands/UpdateLongTermPricingCommand";
106
106
  import { SnowballClient } from "./SnowballClient";
107
- export declare class Snowball extends SnowballClient {
107
+ export interface Snowball {
108
108
  cancelCluster(
109
109
  args: CancelClusterCommandInput,
110
110
  options?: __HttpHandlerOptions
@@ -444,3 +444,4 @@ export declare class Snowball extends SnowballClient {
444
444
  cb: (err: any, data?: UpdateLongTermPricingCommandOutput) => void
445
445
  ): void;
446
446
  }
447
+ export declare class Snowball extends SnowballClient implements Snowball {}
@@ -110,6 +110,12 @@ export interface NFSOnDeviceServiceConfiguration {
110
110
  StorageLimit?: number;
111
111
  StorageUnit?: StorageUnit | string;
112
112
  }
113
+ export interface S3OnDeviceServiceConfiguration {
114
+ StorageLimit?: number;
115
+ StorageUnit?: StorageUnit | string;
116
+ ServiceSize?: number;
117
+ FaultTolerance?: number;
118
+ }
113
119
  export interface TGWOnDeviceServiceConfiguration {
114
120
  StorageLimit?: number;
115
121
  StorageUnit?: StorageUnit | string;
@@ -118,6 +124,7 @@ export interface OnDeviceServiceConfiguration {
118
124
  NFSOnDeviceService?: NFSOnDeviceServiceConfiguration;
119
125
  TGWOnDeviceService?: TGWOnDeviceServiceConfiguration;
120
126
  EKSOnDeviceService?: EKSOnDeviceServiceConfiguration;
127
+ S3OnDeviceService?: S3OnDeviceServiceConfiguration;
121
128
  }
122
129
  export declare const RemoteManagement: {
123
130
  readonly INSTALLED_AUTOSTART: "INSTALLED_AUTOSTART";
@@ -175,6 +182,20 @@ export declare const ShippingOption: {
175
182
  };
176
183
  export type ShippingOption =
177
184
  (typeof ShippingOption)[keyof typeof ShippingOption];
185
+ export declare const SnowballCapacity: {
186
+ readonly NO_PREFERENCE: "NoPreference";
187
+ readonly T100: "T100";
188
+ readonly T14: "T14";
189
+ readonly T240: "T240";
190
+ readonly T32: "T32";
191
+ readonly T42: "T42";
192
+ readonly T50: "T50";
193
+ readonly T8: "T8";
194
+ readonly T80: "T80";
195
+ readonly T98: "T98";
196
+ };
197
+ export type SnowballCapacity =
198
+ (typeof SnowballCapacity)[keyof typeof SnowballCapacity];
178
199
  export declare const SnowballType: {
179
200
  readonly EDGE: "EDGE";
180
201
  readonly EDGE_C: "EDGE_C";
@@ -184,6 +205,7 @@ export declare const SnowballType: {
184
205
  readonly SNC1_SSD: "SNC1_SSD";
185
206
  readonly STANDARD: "STANDARD";
186
207
  readonly V3_5C: "V3_5C";
208
+ readonly V3_5S: "V3_5S";
187
209
  };
188
210
  export type SnowballType = (typeof SnowballType)[keyof typeof SnowballType];
189
211
  export interface INDTaxDocuments {
@@ -194,21 +216,35 @@ export interface TaxDocuments {
194
216
  }
195
217
  export interface CreateClusterRequest {
196
218
  JobType: JobType | string | undefined;
197
- Resources: JobResource | undefined;
219
+ Resources?: JobResource;
198
220
  OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration;
199
221
  Description?: string;
200
222
  AddressId: string | undefined;
201
223
  KmsKeyARN?: string;
202
- RoleARN: string | undefined;
224
+ RoleARN?: string;
203
225
  SnowballType: SnowballType | string | undefined;
204
226
  ShippingOption: ShippingOption | string | undefined;
205
227
  Notification?: Notification;
206
228
  ForwardingAddressId?: string;
207
229
  TaxDocuments?: TaxDocuments;
208
230
  RemoteManagement?: RemoteManagement | string;
231
+ InitialClusterSize?: number;
232
+ ForceCreateJobs?: boolean;
233
+ LongTermPricingIds?: string[];
234
+ SnowballCapacityPreference?: SnowballCapacity | string;
235
+ }
236
+ export interface JobListEntry {
237
+ JobId?: string;
238
+ JobState?: JobState | string;
239
+ IsMaster?: boolean;
240
+ JobType?: JobType | string;
241
+ SnowballType?: SnowballType | string;
242
+ CreationDate?: Date;
243
+ Description?: string;
209
244
  }
210
245
  export interface CreateClusterResult {
211
246
  ClusterId?: string;
247
+ JobListEntries?: JobListEntry[];
212
248
  }
213
249
  export declare class Ec2RequestFailedException extends __BaseException {
214
250
  readonly name: "Ec2RequestFailedException";
@@ -246,19 +282,6 @@ export interface SnowconeDeviceConfiguration {
246
282
  export interface DeviceConfiguration {
247
283
  SnowconeDeviceConfiguration?: SnowconeDeviceConfiguration;
248
284
  }
249
- export declare const SnowballCapacity: {
250
- readonly NO_PREFERENCE: "NoPreference";
251
- readonly T100: "T100";
252
- readonly T14: "T14";
253
- readonly T32: "T32";
254
- readonly T42: "T42";
255
- readonly T50: "T50";
256
- readonly T8: "T8";
257
- readonly T80: "T80";
258
- readonly T98: "T98";
259
- };
260
- export type SnowballCapacity =
261
- (typeof SnowballCapacity)[keyof typeof SnowballCapacity];
262
285
  export interface CreateJobRequest {
263
286
  JobType?: JobType | string;
264
287
  Resources?: JobResource;
@@ -282,6 +305,7 @@ export interface CreateJobResult {
282
305
  JobId?: string;
283
306
  }
284
307
  export declare const LongTermPricingType: {
308
+ readonly ONE_MONTH: "OneMonth";
285
309
  readonly ONE_YEAR: "OneYear";
286
310
  readonly THREE_YEAR: "ThreeYear";
287
311
  };
@@ -468,15 +492,6 @@ export interface ListClusterJobsRequest {
468
492
  MaxResults?: number;
469
493
  NextToken?: string;
470
494
  }
471
- export interface JobListEntry {
472
- JobId?: string;
473
- JobState?: JobState | string;
474
- IsMaster?: boolean;
475
- JobType?: JobType | string;
476
- SnowballType?: SnowballType | string;
477
- CreationDate?: Date;
478
- Description?: string;
479
- }
480
495
  export interface ListClusterJobsResult {
481
496
  JobListEntries?: JobListEntry[];
482
497
  NextToken?: string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-snowball",
3
3
  "description": "AWS SDK for JavaScript Snowball Client for Node.js, Browser and React Native",
4
- "version": "3.315.0",
4
+ "version": "3.317.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.315.0",
24
+ "@aws-sdk/client-sts": "3.316.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.315.0",
26
+ "@aws-sdk/credential-provider-node": "3.316.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -40,14 +40,14 @@
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.310.0",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.315.0",
43
+ "@aws-sdk/smithy-client": "3.316.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.315.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.315.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.316.0",
51
51
  "@aws-sdk/util-endpoints": "3.310.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",