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