@aws-sdk/client-snowball 3.296.0 → 3.297.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.
Files changed (38) hide show
  1. package/dist-types/Snowball.d.ts +27 -0
  2. package/dist-types/SnowballClient.d.ts +24 -4
  3. package/dist-types/commands/CancelClusterCommand.d.ts +16 -0
  4. package/dist-types/commands/CancelJobCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateAddressCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateClusterCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateJobCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateLongTermPricingCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateReturnShippingLabelCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeAddressCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeAddressesCommand.d.ts +16 -0
  12. package/dist-types/commands/DescribeClusterCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeJobCommand.d.ts +16 -0
  14. package/dist-types/commands/DescribeReturnShippingLabelCommand.d.ts +16 -0
  15. package/dist-types/commands/GetJobManifestCommand.d.ts +16 -0
  16. package/dist-types/commands/GetJobUnlockCodeCommand.d.ts +16 -0
  17. package/dist-types/commands/GetSnowballUsageCommand.d.ts +16 -0
  18. package/dist-types/commands/GetSoftwareUpdatesCommand.d.ts +16 -0
  19. package/dist-types/commands/ListClusterJobsCommand.d.ts +16 -0
  20. package/dist-types/commands/ListClustersCommand.d.ts +16 -0
  21. package/dist-types/commands/ListCompatibleImagesCommand.d.ts +16 -0
  22. package/dist-types/commands/ListJobsCommand.d.ts +16 -0
  23. package/dist-types/commands/ListLongTermPricingCommand.d.ts +16 -0
  24. package/dist-types/commands/ListServiceVersionsCommand.d.ts +16 -0
  25. package/dist-types/commands/UpdateClusterCommand.d.ts +16 -0
  26. package/dist-types/commands/UpdateJobCommand.d.ts +16 -0
  27. package/dist-types/commands/UpdateJobShipmentStateCommand.d.ts +16 -0
  28. package/dist-types/commands/UpdateLongTermPricingCommand.d.ts +16 -0
  29. package/dist-types/models/SnowballServiceException.d.ts +2 -0
  30. package/dist-types/models/models_0.d.ts +239 -0
  31. package/dist-types/pagination/DescribeAddressesPaginator.d.ts +3 -0
  32. package/dist-types/pagination/Interfaces.d.ts +3 -0
  33. package/dist-types/pagination/ListClusterJobsPaginator.d.ts +3 -0
  34. package/dist-types/pagination/ListClustersPaginator.d.ts +3 -0
  35. package/dist-types/pagination/ListCompatibleImagesPaginator.d.ts +3 -0
  36. package/dist-types/pagination/ListJobsPaginator.d.ts +3 -0
  37. package/dist-types/pagination/ListLongTermPricingPaginator.d.ts +3 -0
  38. package/package.json +3 -3
@@ -27,6 +27,7 @@ import { UpdateJobShipmentStateCommandInput, UpdateJobShipmentStateCommandOutput
27
27
  import { UpdateLongTermPricingCommandInput, UpdateLongTermPricingCommandOutput } from "./commands/UpdateLongTermPricingCommand";
28
28
  import { SnowballClient } from "./SnowballClient";
29
29
  /**
30
+ * @public
30
31
  * <p>The Amazon Web Services Snow Family provides a petabyte-scale data transport solution that uses
31
32
  * secure devices to transfer large amounts of data between your on-premises data centers and
32
33
  * Amazon Simple Storage Service (Amazon S3). The Snow Family commands described here provide access to the same
@@ -36,6 +37,7 @@ import { SnowballClient } from "./SnowballClient";
36
37
  */
37
38
  export declare class Snowball extends SnowballClient {
38
39
  /**
40
+ * @public
39
41
  * <p>Cancels a cluster job. You can only cancel a cluster job while it's in the
40
42
  * <code>AwaitingQuorum</code> status. You'll have at least an hour after creating a cluster
41
43
  * job to cancel it.</p>
@@ -44,6 +46,7 @@ export declare class Snowball extends SnowballClient {
44
46
  cancelCluster(args: CancelClusterCommandInput, cb: (err: any, data?: CancelClusterCommandOutput) => void): void;
45
47
  cancelCluster(args: CancelClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelClusterCommandOutput) => void): void;
46
48
  /**
49
+ * @public
47
50
  * <p>Cancels the specified job. You can only cancel a job before its <code>JobState</code>
48
51
  * value changes to <code>PreparingAppliance</code>. Requesting the <code>ListJobs</code> or
49
52
  * <code>DescribeJob</code> action returns a job's <code>JobState</code> as part of the
@@ -53,6 +56,7 @@ export declare class Snowball extends SnowballClient {
53
56
  cancelJob(args: CancelJobCommandInput, cb: (err: any, data?: CancelJobCommandOutput) => void): void;
54
57
  cancelJob(args: CancelJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelJobCommandOutput) => void): void;
55
58
  /**
59
+ * @public
56
60
  * <p>Creates an address for a Snow device to be shipped to. In most regions,
57
61
  * addresses are validated at the time of creation. The address you provide must be located
58
62
  * within the serviceable area of your region. If the address is invalid or unsupported, then an
@@ -62,6 +66,7 @@ export declare class Snowball extends SnowballClient {
62
66
  createAddress(args: CreateAddressCommandInput, cb: (err: any, data?: CreateAddressCommandOutput) => void): void;
63
67
  createAddress(args: CreateAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAddressCommandOutput) => void): void;
64
68
  /**
69
+ * @public
65
70
  * <p>Creates an empty cluster. Each cluster supports five nodes. You use the <a>CreateJob</a> action separately to create the jobs for each of these nodes. The
66
71
  * cluster does not ship until these five node jobs have been created.</p>
67
72
  */
@@ -69,6 +74,7 @@ export declare class Snowball extends SnowballClient {
69
74
  createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void;
70
75
  createCluster(args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void): void;
71
76
  /**
77
+ * @public
72
78
  * <p>Creates a job to import or export data between Amazon S3 and your on-premises data
73
79
  * center. Your Amazon Web Services account must have the right trust policies and permissions in
74
80
  * place to create a job for a Snow device. If you're creating a job for a node in a cluster, you
@@ -202,6 +208,7 @@ export declare class Snowball extends SnowballClient {
202
208
  createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void;
203
209
  createJob(args: CreateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateJobCommandOutput) => void): void;
204
210
  /**
211
+ * @public
205
212
  * <p>Creates a job with the long-term usage option for a device. The long-term usage is a
206
213
  * 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing.
207
214
  * </p>
@@ -210,12 +217,14 @@ export declare class Snowball extends SnowballClient {
210
217
  createLongTermPricing(args: CreateLongTermPricingCommandInput, cb: (err: any, data?: CreateLongTermPricingCommandOutput) => void): void;
211
218
  createLongTermPricing(args: CreateLongTermPricingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLongTermPricingCommandOutput) => void): void;
212
219
  /**
220
+ * @public
213
221
  * <p>Creates a shipping label that will be used to return the Snow device to Amazon Web Services.</p>
214
222
  */
215
223
  createReturnShippingLabel(args: CreateReturnShippingLabelCommandInput, options?: __HttpHandlerOptions): Promise<CreateReturnShippingLabelCommandOutput>;
216
224
  createReturnShippingLabel(args: CreateReturnShippingLabelCommandInput, cb: (err: any, data?: CreateReturnShippingLabelCommandOutput) => void): void;
217
225
  createReturnShippingLabel(args: CreateReturnShippingLabelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReturnShippingLabelCommandOutput) => void): void;
218
226
  /**
227
+ * @public
219
228
  * <p>Takes an <code>AddressId</code> and returns specific details about that address in the
220
229
  * form of an <code>Address</code> object.</p>
221
230
  */
@@ -223,6 +232,7 @@ export declare class Snowball extends SnowballClient {
223
232
  describeAddress(args: DescribeAddressCommandInput, cb: (err: any, data?: DescribeAddressCommandOutput) => void): void;
224
233
  describeAddress(args: DescribeAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAddressCommandOutput) => void): void;
225
234
  /**
235
+ * @public
226
236
  * <p>Returns a specified number of <code>ADDRESS</code> objects. Calling this API in one of
227
237
  * the US regions will return addresses from the list of all addresses associated with this
228
238
  * account in all US regions.</p>
@@ -231,6 +241,7 @@ export declare class Snowball extends SnowballClient {
231
241
  describeAddresses(args: DescribeAddressesCommandInput, cb: (err: any, data?: DescribeAddressesCommandOutput) => void): void;
232
242
  describeAddresses(args: DescribeAddressesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAddressesCommandOutput) => void): void;
233
243
  /**
244
+ * @public
234
245
  * <p>Returns information about a specific cluster including shipping information, cluster
235
246
  * status, and other important metadata.</p>
236
247
  */
@@ -238,6 +249,7 @@ export declare class Snowball extends SnowballClient {
238
249
  describeCluster(args: DescribeClusterCommandInput, cb: (err: any, data?: DescribeClusterCommandOutput) => void): void;
239
250
  describeCluster(args: DescribeClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClusterCommandOutput) => void): void;
240
251
  /**
252
+ * @public
241
253
  * <p>Returns information about a specific job including shipping information, job status,
242
254
  * and other important metadata. </p>
243
255
  */
@@ -245,12 +257,14 @@ export declare class Snowball extends SnowballClient {
245
257
  describeJob(args: DescribeJobCommandInput, cb: (err: any, data?: DescribeJobCommandOutput) => void): void;
246
258
  describeJob(args: DescribeJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobCommandOutput) => void): void;
247
259
  /**
260
+ * @public
248
261
  * <p>Information on the shipping label of a Snow device that is being returned to Amazon Web Services.</p>
249
262
  */
250
263
  describeReturnShippingLabel(args: DescribeReturnShippingLabelCommandInput, options?: __HttpHandlerOptions): Promise<DescribeReturnShippingLabelCommandOutput>;
251
264
  describeReturnShippingLabel(args: DescribeReturnShippingLabelCommandInput, cb: (err: any, data?: DescribeReturnShippingLabelCommandOutput) => void): void;
252
265
  describeReturnShippingLabel(args: DescribeReturnShippingLabelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReturnShippingLabelCommandOutput) => void): void;
253
266
  /**
267
+ * @public
254
268
  * <p>Returns a link to an Amazon S3 presigned URL for the manifest file associated with the
255
269
  * specified <code>JobId</code> value. You can access the manifest file for up to 60 minutes
256
270
  * after this request has been made. To access the manifest file after 60 minutes have passed,
@@ -272,6 +286,7 @@ export declare class Snowball extends SnowballClient {
272
286
  getJobManifest(args: GetJobManifestCommandInput, cb: (err: any, data?: GetJobManifestCommandOutput) => void): void;
273
287
  getJobManifest(args: GetJobManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobManifestCommandOutput) => void): void;
274
288
  /**
289
+ * @public
275
290
  * <p>Returns the <code>UnlockCode</code> code value for the specified job. A particular
276
291
  * <code>UnlockCode</code> value can be accessed for up to 360 days after the associated job
277
292
  * has been created.</p>
@@ -290,6 +305,7 @@ export declare class Snowball extends SnowballClient {
290
305
  getJobUnlockCode(args: GetJobUnlockCodeCommandInput, cb: (err: any, data?: GetJobUnlockCodeCommandOutput) => void): void;
291
306
  getJobUnlockCode(args: GetJobUnlockCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobUnlockCodeCommandOutput) => void): void;
292
307
  /**
308
+ * @public
293
309
  * <p>Returns information about the Snow Family service limit for your account, and also the
294
310
  * number of Snow devices your account has in use.</p>
295
311
  * <p>The default service limit for the number of Snow devices that you can have at one time
@@ -299,6 +315,7 @@ export declare class Snowball extends SnowballClient {
299
315
  getSnowballUsage(args: GetSnowballUsageCommandInput, cb: (err: any, data?: GetSnowballUsageCommandOutput) => void): void;
300
316
  getSnowballUsage(args: GetSnowballUsageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSnowballUsageCommandOutput) => void): void;
301
317
  /**
318
+ * @public
302
319
  * <p>Returns an Amazon S3 presigned URL for an update file associated with a specified
303
320
  * <code>JobId</code>.</p>
304
321
  */
@@ -306,6 +323,7 @@ export declare class Snowball extends SnowballClient {
306
323
  getSoftwareUpdates(args: GetSoftwareUpdatesCommandInput, cb: (err: any, data?: GetSoftwareUpdatesCommandOutput) => void): void;
307
324
  getSoftwareUpdates(args: GetSoftwareUpdatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSoftwareUpdatesCommandOutput) => void): void;
308
325
  /**
326
+ * @public
309
327
  * <p>Returns an array of <code>JobListEntry</code> objects of the specified length. Each
310
328
  * <code>JobListEntry</code> object is for a job in the specified cluster and contains a job's
311
329
  * state, a job's ID, and other information.</p>
@@ -314,6 +332,7 @@ export declare class Snowball extends SnowballClient {
314
332
  listClusterJobs(args: ListClusterJobsCommandInput, cb: (err: any, data?: ListClusterJobsCommandOutput) => void): void;
315
333
  listClusterJobs(args: ListClusterJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClusterJobsCommandOutput) => void): void;
316
334
  /**
335
+ * @public
317
336
  * <p>Returns an array of <code>ClusterListEntry</code> objects of the specified length. Each
318
337
  * <code>ClusterListEntry</code> object contains a cluster's state, a cluster's ID, and other
319
338
  * important status information.</p>
@@ -322,6 +341,7 @@ export declare class Snowball extends SnowballClient {
322
341
  listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void;
323
342
  listClusters(args: ListClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClustersCommandOutput) => void): void;
324
343
  /**
344
+ * @public
325
345
  * <p>This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs)
326
346
  * that are owned by your Amazon Web Services accountthat would be supported for use on a Snow
327
347
  * device. Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM,
@@ -332,6 +352,7 @@ export declare class Snowball extends SnowballClient {
332
352
  listCompatibleImages(args: ListCompatibleImagesCommandInput, cb: (err: any, data?: ListCompatibleImagesCommandOutput) => void): void;
333
353
  listCompatibleImages(args: ListCompatibleImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCompatibleImagesCommandOutput) => void): void;
334
354
  /**
355
+ * @public
335
356
  * <p>Returns an array of <code>JobListEntry</code> objects of the specified length. Each
336
357
  * <code>JobListEntry</code> object contains a job's state, a job's ID, and a value that
337
358
  * indicates whether the job is a job part, in the case of export jobs. Calling this API action
@@ -342,12 +363,14 @@ export declare class Snowball extends SnowballClient {
342
363
  listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void;
343
364
  listJobs(args: ListJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobsCommandOutput) => void): void;
344
365
  /**
366
+ * @public
345
367
  * <p>Lists all long-term pricing types.</p>
346
368
  */
347
369
  listLongTermPricing(args: ListLongTermPricingCommandInput, options?: __HttpHandlerOptions): Promise<ListLongTermPricingCommandOutput>;
348
370
  listLongTermPricing(args: ListLongTermPricingCommandInput, cb: (err: any, data?: ListLongTermPricingCommandOutput) => void): void;
349
371
  listLongTermPricing(args: ListLongTermPricingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLongTermPricingCommandOutput) => void): void;
350
372
  /**
373
+ * @public
351
374
  * <p>Lists all supported versions for Snow on-device services. Returns an
352
375
  * array of <code>ServiceVersion</code> object containing the supported versions for a particular service.</p>
353
376
  */
@@ -355,6 +378,7 @@ export declare class Snowball extends SnowballClient {
355
378
  listServiceVersions(args: ListServiceVersionsCommandInput, cb: (err: any, data?: ListServiceVersionsCommandOutput) => void): void;
356
379
  listServiceVersions(args: ListServiceVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceVersionsCommandOutput) => void): void;
357
380
  /**
381
+ * @public
358
382
  * <p>While a cluster's <code>ClusterState</code> value is in the <code>AwaitingQuorum</code>
359
383
  * state, you can update some of the information associated with a cluster. Once the cluster
360
384
  * changes to a different job state, usually 60 minutes after the cluster being created, this
@@ -364,6 +388,7 @@ export declare class Snowball extends SnowballClient {
364
388
  updateCluster(args: UpdateClusterCommandInput, cb: (err: any, data?: UpdateClusterCommandOutput) => void): void;
365
389
  updateCluster(args: UpdateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClusterCommandOutput) => void): void;
366
390
  /**
391
+ * @public
367
392
  * <p>While a job's <code>JobState</code> value is <code>New</code>, you can update some of
368
393
  * the information associated with a job. Once the job changes to a different job state, usually
369
394
  * within 60 minutes of the job being created, this action is no longer available.</p>
@@ -372,12 +397,14 @@ export declare class Snowball extends SnowballClient {
372
397
  updateJob(args: UpdateJobCommandInput, cb: (err: any, data?: UpdateJobCommandOutput) => void): void;
373
398
  updateJob(args: UpdateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateJobCommandOutput) => void): void;
374
399
  /**
400
+ * @public
375
401
  * <p>Updates the state when a shipment state changes to a different state.</p>
376
402
  */
377
403
  updateJobShipmentState(args: UpdateJobShipmentStateCommandInput, options?: __HttpHandlerOptions): Promise<UpdateJobShipmentStateCommandOutput>;
378
404
  updateJobShipmentState(args: UpdateJobShipmentStateCommandInput, cb: (err: any, data?: UpdateJobShipmentStateCommandOutput) => void): void;
379
405
  updateJobShipmentState(args: UpdateJobShipmentStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateJobShipmentStateCommandOutput) => void): void;
380
406
  /**
407
+ * @public
381
408
  * <p>Updates the long-term pricing type.</p>
382
409
  */
383
410
  updateLongTermPricing(args: UpdateLongTermPricingCommandInput, options?: __HttpHandlerOptions): Promise<UpdateLongTermPricingCommandOutput>;
@@ -34,15 +34,24 @@ import { UpdateJobCommandInput, UpdateJobCommandOutput } from "./commands/Update
34
34
  import { UpdateJobShipmentStateCommandInput, UpdateJobShipmentStateCommandOutput } from "./commands/UpdateJobShipmentStateCommand";
35
35
  import { UpdateLongTermPricingCommandInput, UpdateLongTermPricingCommandOutput } from "./commands/UpdateLongTermPricingCommand";
36
36
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
37
+ /**
38
+ * @public
39
+ */
37
40
  export type ServiceInputTypes = CancelClusterCommandInput | CancelJobCommandInput | CreateAddressCommandInput | CreateClusterCommandInput | CreateJobCommandInput | CreateLongTermPricingCommandInput | CreateReturnShippingLabelCommandInput | DescribeAddressCommandInput | DescribeAddressesCommandInput | DescribeClusterCommandInput | DescribeJobCommandInput | DescribeReturnShippingLabelCommandInput | GetJobManifestCommandInput | GetJobUnlockCodeCommandInput | GetSnowballUsageCommandInput | GetSoftwareUpdatesCommandInput | ListClusterJobsCommandInput | ListClustersCommandInput | ListCompatibleImagesCommandInput | ListJobsCommandInput | ListLongTermPricingCommandInput | ListServiceVersionsCommandInput | UpdateClusterCommandInput | UpdateJobCommandInput | UpdateJobShipmentStateCommandInput | UpdateLongTermPricingCommandInput;
41
+ /**
42
+ * @public
43
+ */
38
44
  export type ServiceOutputTypes = CancelClusterCommandOutput | CancelJobCommandOutput | CreateAddressCommandOutput | CreateClusterCommandOutput | CreateJobCommandOutput | CreateLongTermPricingCommandOutput | CreateReturnShippingLabelCommandOutput | DescribeAddressCommandOutput | DescribeAddressesCommandOutput | DescribeClusterCommandOutput | DescribeJobCommandOutput | DescribeReturnShippingLabelCommandOutput | GetJobManifestCommandOutput | GetJobUnlockCodeCommandOutput | GetSnowballUsageCommandOutput | GetSoftwareUpdatesCommandOutput | ListClusterJobsCommandOutput | ListClustersCommandOutput | ListCompatibleImagesCommandOutput | ListJobsCommandOutput | ListLongTermPricingCommandOutput | ListServiceVersionsCommandOutput | UpdateClusterCommandOutput | UpdateJobCommandOutput | UpdateJobShipmentStateCommandOutput | UpdateLongTermPricingCommandOutput;
45
+ /**
46
+ * @public
47
+ */
39
48
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
40
49
  /**
41
50
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
42
51
  */
43
52
  requestHandler?: __HttpHandler;
44
53
  /**
45
- * A constructor for a class implementing the {@link __Checksum} interface
54
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
46
55
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
47
56
  * @internal
48
57
  */
@@ -132,23 +141,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
132
141
  */
133
142
  logger?: __Logger;
134
143
  /**
135
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
144
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
136
145
  */
137
146
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
138
147
  }
148
+ /**
149
+ * @public
150
+ */
139
151
  type SnowballClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
140
152
  /**
141
- * The configuration interface of SnowballClient class constructor that set the region, credentials and other options.
153
+ * @public
154
+ *
155
+ * The configuration interface of SnowballClient class constructor that set the region, credentials and other options.
142
156
  */
143
157
  export interface SnowballClientConfig extends SnowballClientConfigType {
144
158
  }
159
+ /**
160
+ * @public
161
+ */
145
162
  type SnowballClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
146
163
  /**
147
- * The resolved configuration interface of SnowballClient class. This is resolved and normalized from the {@link SnowballClientConfig | constructor configuration interface}.
164
+ * @public
165
+ *
166
+ * The resolved configuration interface of SnowballClient class. This is resolved and normalized from the {@link SnowballClientConfig | constructor configuration interface}.
148
167
  */
149
168
  export interface SnowballClientResolvedConfig extends SnowballClientResolvedConfigType {
150
169
  }
151
170
  /**
171
+ * @public
152
172
  * <p>The Amazon Web Services Snow Family provides a petabyte-scale data transport solution that uses
153
173
  * secure devices to transfer large amounts of data between your on-premises data centers and
154
174
  * Amazon Simple Storage Service (Amazon S3). The Snow Family commands described here provide access to the same
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CancelClusterRequest, CancelClusterResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SnowballClientResolvedConfig } from "../SnowballClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CancelClusterCommand}.
8
10
  */
9
11
  export interface CancelClusterCommandInput extends CancelClusterRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CancelClusterCommand}.
13
17
  */
14
18
  export interface CancelClusterCommandOutput extends CancelClusterResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Cancels a cluster job. You can only cancel a cluster job while it's in the
18
23
  * <code>AwaitingQuorum</code> status. You'll have at least an hour after creating a cluster
19
24
  * job to cancel it.</p>
@@ -27,6 +32,8 @@ export interface CancelClusterCommandOutput extends CancelClusterResult, __Metad
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param CancelClusterCommandInput - {@link CancelClusterCommandInput}
36
+ * @returns {@link CancelClusterCommandOutput}
30
37
  * @see {@link CancelClusterCommandInput} for command's `input` shape.
31
38
  * @see {@link CancelClusterCommandOutput} for command's `response` shape.
32
39
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
@@ -59,11 +66,20 @@ export interface CancelClusterCommandOutput extends CancelClusterResult, __Metad
59
66
  export declare class CancelClusterCommand extends $Command<CancelClusterCommandInput, CancelClusterCommandOutput, SnowballClientResolvedConfig> {
60
67
  readonly input: CancelClusterCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: CancelClusterCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SnowballClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CancelClusterCommandInput, CancelClusterCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CancelJobRequest, CancelJobResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SnowballClientResolvedConfig } from "../SnowballClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CancelJobCommand}.
8
10
  */
9
11
  export interface CancelJobCommandInput extends CancelJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CancelJobCommand}.
13
17
  */
14
18
  export interface CancelJobCommandOutput extends CancelJobResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Cancels the specified job. You can only cancel a job before its <code>JobState</code>
18
23
  * value changes to <code>PreparingAppliance</code>. Requesting the <code>ListJobs</code> or
19
24
  * <code>DescribeJob</code> action returns a job's <code>JobState</code> as part of the
@@ -28,6 +33,8 @@ export interface CancelJobCommandOutput extends CancelJobResult, __MetadataBeare
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param CancelJobCommandInput - {@link CancelJobCommandInput}
37
+ * @returns {@link CancelJobCommandOutput}
31
38
  * @see {@link CancelJobCommandInput} for command's `input` shape.
32
39
  * @see {@link CancelJobCommandOutput} for command's `response` shape.
33
40
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
@@ -60,11 +67,20 @@ export interface CancelJobCommandOutput extends CancelJobResult, __MetadataBeare
60
67
  export declare class CancelJobCommand extends $Command<CancelJobCommandInput, CancelJobCommandOutput, SnowballClientResolvedConfig> {
61
68
  readonly input: CancelJobCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: CancelJobCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SnowballClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CancelJobCommandInput, CancelJobCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateAddressRequest, CreateAddressResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SnowballClientResolvedConfig } from "../SnowballClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateAddressCommand}.
8
10
  */
9
11
  export interface CreateAddressCommandInput extends CreateAddressRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateAddressCommand}.
13
17
  */
14
18
  export interface CreateAddressCommandOutput extends CreateAddressResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an address for a Snow device to be shipped to. In most regions,
18
23
  * addresses are validated at the time of creation. The address you provide must be located
19
24
  * within the serviceable area of your region. If the address is invalid or unsupported, then an
@@ -28,6 +33,8 @@ export interface CreateAddressCommandOutput extends CreateAddressResult, __Metad
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param CreateAddressCommandInput - {@link CreateAddressCommandInput}
37
+ * @returns {@link CreateAddressCommandOutput}
31
38
  * @see {@link CreateAddressCommandInput} for command's `input` shape.
32
39
  * @see {@link CreateAddressCommandOutput} for command's `response` shape.
33
40
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
@@ -71,11 +78,20 @@ export interface CreateAddressCommandOutput extends CreateAddressResult, __Metad
71
78
  export declare class CreateAddressCommand extends $Command<CreateAddressCommandInput, CreateAddressCommandOutput, SnowballClientResolvedConfig> {
72
79
  readonly input: CreateAddressCommandInput;
73
80
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
81
+ /**
82
+ * @public
83
+ */
74
84
  constructor(input: CreateAddressCommandInput);
75
85
  /**
76
86
  * @internal
77
87
  */
78
88
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SnowballClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAddressCommandInput, CreateAddressCommandOutput>;
89
+ /**
90
+ * @internal
91
+ */
79
92
  private serialize;
93
+ /**
94
+ * @internal
95
+ */
80
96
  private deserialize;
81
97
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateClusterRequest, CreateClusterResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SnowballClientResolvedConfig } from "../SnowballClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateClusterCommand}.
8
10
  */
9
11
  export interface CreateClusterCommandInput extends CreateClusterRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateClusterCommand}.
13
17
  */
14
18
  export interface CreateClusterCommandOutput extends CreateClusterResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an empty cluster. Each cluster supports five nodes. You use the <a>CreateJob</a> action separately to create the jobs for each of these nodes. The
18
23
  * cluster does not ship until these five node jobs have been created.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateClusterCommandOutput extends CreateClusterResult, __Metad
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateClusterCommandInput - {@link CreateClusterCommandInput}
35
+ * @returns {@link CreateClusterCommandOutput}
29
36
  * @see {@link CreateClusterCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateClusterCommandOutput} for command's `response` shape.
31
38
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
@@ -84,11 +91,20 @@ export interface CreateClusterCommandOutput extends CreateClusterResult, __Metad
84
91
  export declare class CreateClusterCommand extends $Command<CreateClusterCommandInput, CreateClusterCommandOutput, SnowballClientResolvedConfig> {
85
92
  readonly input: CreateClusterCommandInput;
86
93
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
94
+ /**
95
+ * @public
96
+ */
87
97
  constructor(input: CreateClusterCommandInput);
88
98
  /**
89
99
  * @internal
90
100
  */
91
101
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SnowballClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateClusterCommandInput, CreateClusterCommandOutput>;
102
+ /**
103
+ * @internal
104
+ */
92
105
  private serialize;
106
+ /**
107
+ * @internal
108
+ */
93
109
  private deserialize;
94
110
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateJobRequest, CreateJobResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SnowballClientResolvedConfig } from "../SnowballClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateJobCommand}.
8
10
  */
9
11
  export interface CreateJobCommandInput extends CreateJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateJobCommand}.
13
17
  */
14
18
  export interface CreateJobCommandOutput extends CreateJobResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a job to import or export data between Amazon S3 and your on-premises data
18
23
  * center. Your Amazon Web Services account must have the right trust policies and permissions in
19
24
  * place to create a job for a Snow device. If you're creating a job for a node in a cluster, you
@@ -152,6 +157,8 @@ export interface CreateJobCommandOutput extends CreateJobResult, __MetadataBeare
152
157
  * const response = await client.send(command);
153
158
  * ```
154
159
  *
160
+ * @param CreateJobCommandInput - {@link CreateJobCommandInput}
161
+ * @returns {@link CreateJobCommandOutput}
155
162
  * @see {@link CreateJobCommandInput} for command's `input` shape.
156
163
  * @see {@link CreateJobCommandOutput} for command's `response` shape.
157
164
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
@@ -216,11 +223,20 @@ export interface CreateJobCommandOutput extends CreateJobResult, __MetadataBeare
216
223
  export declare class CreateJobCommand extends $Command<CreateJobCommandInput, CreateJobCommandOutput, SnowballClientResolvedConfig> {
217
224
  readonly input: CreateJobCommandInput;
218
225
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
226
+ /**
227
+ * @public
228
+ */
219
229
  constructor(input: CreateJobCommandInput);
220
230
  /**
221
231
  * @internal
222
232
  */
223
233
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SnowballClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateJobCommandInput, CreateJobCommandOutput>;
234
+ /**
235
+ * @internal
236
+ */
224
237
  private serialize;
238
+ /**
239
+ * @internal
240
+ */
225
241
  private deserialize;
226
242
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateLongTermPricingRequest, CreateLongTermPricingResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SnowballClientResolvedConfig } from "../SnowballClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateLongTermPricingCommand}.
8
10
  */
9
11
  export interface CreateLongTermPricingCommandInput extends CreateLongTermPricingRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateLongTermPricingCommand}.
13
17
  */
14
18
  export interface CreateLongTermPricingCommandOutput extends CreateLongTermPricingResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a job with the long-term usage option for a device. The long-term usage is a
18
23
  * 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing.
19
24
  * </p>
@@ -27,6 +32,8 @@ export interface CreateLongTermPricingCommandOutput extends CreateLongTermPricin
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param CreateLongTermPricingCommandInput - {@link CreateLongTermPricingCommandInput}
36
+ * @returns {@link CreateLongTermPricingCommandOutput}
30
37
  * @see {@link CreateLongTermPricingCommandInput} for command's `input` shape.
31
38
  * @see {@link CreateLongTermPricingCommandOutput} for command's `response` shape.
32
39
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
@@ -40,11 +47,20 @@ export interface CreateLongTermPricingCommandOutput extends CreateLongTermPricin
40
47
  export declare class CreateLongTermPricingCommand extends $Command<CreateLongTermPricingCommandInput, CreateLongTermPricingCommandOutput, SnowballClientResolvedConfig> {
41
48
  readonly input: CreateLongTermPricingCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: CreateLongTermPricingCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SnowballClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateLongTermPricingCommandInput, CreateLongTermPricingCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateReturnShippingLabelRequest, CreateReturnShippingLabelResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SnowballClientResolvedConfig } from "../SnowballClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateReturnShippingLabelCommand}.
8
10
  */
9
11
  export interface CreateReturnShippingLabelCommandInput extends CreateReturnShippingLabelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateReturnShippingLabelCommand}.
13
17
  */
14
18
  export interface CreateReturnShippingLabelCommandOutput extends CreateReturnShippingLabelResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a shipping label that will be used to return the Snow device to Amazon Web Services.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateReturnShippingLabelCommandOutput extends CreateReturnShip
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateReturnShippingLabelCommandInput - {@link CreateReturnShippingLabelCommandInput}
34
+ * @returns {@link CreateReturnShippingLabelCommandOutput}
28
35
  * @see {@link CreateReturnShippingLabelCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateReturnShippingLabelCommandOutput} for command's `response` shape.
30
37
  * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape.
@@ -54,11 +61,20 @@ export interface CreateReturnShippingLabelCommandOutput extends CreateReturnShip
54
61
  export declare class CreateReturnShippingLabelCommand extends $Command<CreateReturnShippingLabelCommandInput, CreateReturnShippingLabelCommandOutput, SnowballClientResolvedConfig> {
55
62
  readonly input: CreateReturnShippingLabelCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: CreateReturnShippingLabelCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SnowballClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateReturnShippingLabelCommandInput, CreateReturnShippingLabelCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }