@aws-sdk/client-snowball 3.775.0 → 3.782.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 (28) hide show
  1. package/dist-types/commands/CancelClusterCommand.d.ts +7 -4
  2. package/dist-types/commands/CancelJobCommand.d.ts +7 -4
  3. package/dist-types/commands/CreateAddressCommand.d.ts +13 -13
  4. package/dist-types/commands/CreateClusterCommand.d.ts +18 -18
  5. package/dist-types/commands/CreateJobCommand.d.ts +19 -19
  6. package/dist-types/commands/CreateLongTermPricingCommand.d.ts +1 -0
  7. package/dist-types/commands/CreateReturnShippingLabelCommand.d.ts +1 -0
  8. package/dist-types/commands/DescribeAddressCommand.d.ts +14 -14
  9. package/dist-types/commands/DescribeAddressesCommand.d.ts +14 -14
  10. package/dist-types/commands/DescribeClusterCommand.d.ts +1 -38
  11. package/dist-types/commands/DescribeJobCommand.d.ts +1 -42
  12. package/dist-types/commands/DescribeReturnShippingLabelCommand.d.ts +1 -0
  13. package/dist-types/commands/GetJobManifestCommand.d.ts +11 -11
  14. package/dist-types/commands/GetJobUnlockCodeCommand.d.ts +9 -9
  15. package/dist-types/commands/GetSnowballUsageCommand.d.ts +8 -8
  16. package/dist-types/commands/GetSoftwareUpdatesCommand.d.ts +1 -0
  17. package/dist-types/commands/ListClusterJobsCommand.d.ts +2 -63
  18. package/dist-types/commands/ListClustersCommand.d.ts +1 -21
  19. package/dist-types/commands/ListCompatibleImagesCommand.d.ts +1 -0
  20. package/dist-types/commands/ListJobsCommand.d.ts +1 -24
  21. package/dist-types/commands/ListLongTermPricingCommand.d.ts +1 -0
  22. package/dist-types/commands/ListPickupLocationsCommand.d.ts +14 -14
  23. package/dist-types/commands/ListServiceVersionsCommand.d.ts +1 -0
  24. package/dist-types/commands/UpdateClusterCommand.d.ts +9 -6
  25. package/dist-types/commands/UpdateJobCommand.d.ts +11 -8
  26. package/dist-types/commands/UpdateJobShipmentStateCommand.d.ts +1 -0
  27. package/dist-types/commands/UpdateLongTermPricingCommand.d.ts +1 -0
  28. package/package.json +5 -5
@@ -66,18 +66,21 @@ declare const CancelClusterCommand_base: {
66
66
  * @throws {@link SnowballServiceException}
67
67
  * <p>Base exception class for all service exceptions from Snowball service.</p>
68
68
  *
69
- * @public
69
+ *
70
70
  * @example To cancel a cluster job
71
71
  * ```javascript
72
72
  * // This operation cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status.
73
73
  * const input = {
74
- * "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000"
74
+ * ClusterId: "CID123e4567-e89b-12d3-a456-426655440000"
75
75
  * };
76
76
  * const command = new CancelClusterCommand(input);
77
- * await client.send(command);
78
- * // example id: to-cancel-a-cluster-job-1482533760554
77
+ * const response = await client.send(command);
78
+ * /* response is
79
+ * { /* metadata only *\/ }
80
+ * *\/
79
81
  * ```
80
82
  *
83
+ * @public
81
84
  */
82
85
  export declare class CancelClusterCommand extends CancelClusterCommand_base {
83
86
  /** @internal type navigation helper, not in runtime. */
@@ -67,18 +67,21 @@ declare const CancelJobCommand_base: {
67
67
  * @throws {@link SnowballServiceException}
68
68
  * <p>Base exception class for all service exceptions from Snowball service.</p>
69
69
  *
70
- * @public
70
+ *
71
71
  * @example To cancel a job for a Snowball device
72
72
  * ```javascript
73
73
  * // This operation cancels a job. You can only cancel a job before its JobState value changes to PreparingAppliance.
74
74
  * const input = {
75
- * "JobId": "JID123e4567-e89b-12d3-a456-426655440000"
75
+ * JobId: "JID123e4567-e89b-12d3-a456-426655440000"
76
76
  * };
77
77
  * const command = new CancelJobCommand(input);
78
- * await client.send(command);
79
- * // example id: to-cancel-a-job-for-a-snowball-device-1482534699477
78
+ * const response = await client.send(command);
79
+ * /* response is
80
+ * { /* metadata only *\/ }
81
+ * *\/
80
82
  * ```
81
83
  *
84
+ * @public
82
85
  */
83
86
  export declare class CancelJobCommand extends CancelJobCommand_base {
84
87
  /** @internal type navigation helper, not in runtime. */
@@ -82,32 +82,32 @@ declare const CreateAddressCommand_base: {
82
82
  * @throws {@link SnowballServiceException}
83
83
  * <p>Base exception class for all service exceptions from Snowball service.</p>
84
84
  *
85
- * @public
85
+ *
86
86
  * @example To create an address for a job
87
87
  * ```javascript
88
88
  * // This operation creates an address for a job. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.
89
89
  * const input = {
90
- * "Address": {
91
- * "City": "Seattle",
92
- * "Company": "My Company's Name",
93
- * "Country": "USA",
94
- * "Name": "My Name",
95
- * "PhoneNumber": "425-555-5555",
96
- * "PostalCode": "98101",
97
- * "StateOrProvince": "WA",
98
- * "Street1": "123 Main Street"
90
+ * Address: {
91
+ * City: "Seattle",
92
+ * Company: "My Company's Name",
93
+ * Country: "USA",
94
+ * Name: "My Name",
95
+ * PhoneNumber: "425-555-5555",
96
+ * PostalCode: "98101",
97
+ * StateOrProvince: "WA",
98
+ * Street1: "123 Main Street"
99
99
  * }
100
100
  * };
101
101
  * const command = new CreateAddressCommand(input);
102
102
  * const response = await client.send(command);
103
- * /* response ==
103
+ * /* response is
104
104
  * {
105
- * "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b"
105
+ * AddressId: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b"
106
106
  * }
107
107
  * *\/
108
- * // example id: to-create-an-address-for-a-job-1482535416294
109
108
  * ```
110
109
  *
110
+ * @public
111
111
  */
112
112
  export declare class CreateAddressCommand extends CreateAddressCommand_base {
113
113
  /** @internal type navigation helper, not in runtime. */
@@ -161,41 +161,41 @@ declare const CreateClusterCommand_base: {
161
161
  * @throws {@link SnowballServiceException}
162
162
  * <p>Base exception class for all service exceptions from Snowball service.</p>
163
163
  *
164
- * @public
164
+ *
165
165
  * @example To create a cluster
166
166
  * ```javascript
167
167
  * // Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.
168
168
  * const input = {
169
- * "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
170
- * "Description": "MyCluster",
171
- * "JobType": "LOCAL_USE",
172
- * "KmsKeyARN": "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456",
173
- * "Notification": {
174
- * "JobStatesToNotify": [],
175
- * "NotifyAll": false
169
+ * AddressId: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
170
+ * Description: "MyCluster",
171
+ * JobType: "LOCAL_USE",
172
+ * KmsKeyARN: "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456",
173
+ * Notification: {
174
+ * JobStatesToNotify: [],
175
+ * NotifyAll: false
176
176
  * },
177
- * "Resources": {
178
- * "S3Resources": [
177
+ * Resources: {
178
+ * S3Resources: [
179
179
  * {
180
- * "BucketArn": "arn:aws:s3:::MyBucket",
181
- * "KeyRange": {}
180
+ * BucketArn: "arn:aws:s3:::MyBucket",
181
+ * KeyRange: { /* empty *\/ }
182
182
  * }
183
183
  * ]
184
184
  * },
185
- * "RoleARN": "arn:aws:iam::123456789012:role/snowball-import-S3-role",
186
- * "ShippingOption": "SECOND_DAY",
187
- * "SnowballType": "EDGE"
185
+ * RoleARN: "arn:aws:iam::123456789012:role/snowball-import-S3-role",
186
+ * ShippingOption: "SECOND_DAY",
187
+ * SnowballType: "EDGE"
188
188
  * };
189
189
  * const command = new CreateClusterCommand(input);
190
190
  * const response = await client.send(command);
191
- * /* response ==
191
+ * /* response is
192
192
  * {
193
- * "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000"
193
+ * ClusterId: "CID123e4567-e89b-12d3-a456-426655440000"
194
194
  * }
195
195
  * *\/
196
- * // example id: to-create-a-cluster-1482864724077
197
196
  * ```
198
197
  *
198
+ * @public
199
199
  */
200
200
  export declare class CreateClusterCommand extends CreateClusterCommand_base {
201
201
  /** @internal type navigation helper, not in runtime. */
@@ -322,42 +322,42 @@ declare const CreateJobCommand_base: {
322
322
  * @throws {@link SnowballServiceException}
323
323
  * <p>Base exception class for all service exceptions from Snowball service.</p>
324
324
  *
325
- * @public
325
+ *
326
326
  * @example To create a job
327
327
  * ```javascript
328
328
  * // Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for Snowball. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.
329
329
  * const input = {
330
- * "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
331
- * "Description": "My Job",
332
- * "JobType": "IMPORT",
333
- * "KmsKeyARN": "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456",
334
- * "Notification": {
335
- * "JobStatesToNotify": [],
336
- * "NotifyAll": false
330
+ * AddressId: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
331
+ * Description: "My Job",
332
+ * JobType: "IMPORT",
333
+ * KmsKeyARN: "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456",
334
+ * Notification: {
335
+ * JobStatesToNotify: [],
336
+ * NotifyAll: false
337
337
  * },
338
- * "Resources": {
339
- * "S3Resources": [
338
+ * Resources: {
339
+ * S3Resources: [
340
340
  * {
341
- * "BucketArn": "arn:aws:s3:::MyBucket",
342
- * "KeyRange": {}
341
+ * BucketArn: "arn:aws:s3:::MyBucket",
342
+ * KeyRange: { /* empty *\/ }
343
343
  * }
344
344
  * ]
345
345
  * },
346
- * "RoleARN": "arn:aws:iam::123456789012:role/snowball-import-S3-role",
347
- * "ShippingOption": "SECOND_DAY",
348
- * "SnowballCapacityPreference": "T80",
349
- * "SnowballType": "STANDARD"
346
+ * RoleARN: "arn:aws:iam::123456789012:role/snowball-import-S3-role",
347
+ * ShippingOption: "SECOND_DAY",
348
+ * SnowballCapacityPreference: "T80",
349
+ * SnowballType: "STANDARD"
350
350
  * };
351
351
  * const command = new CreateJobCommand(input);
352
352
  * const response = await client.send(command);
353
- * /* response ==
353
+ * /* response is
354
354
  * {
355
- * "JobId": "JID123e4567-e89b-12d3-a456-426655440000"
355
+ * JobId: "JID123e4567-e89b-12d3-a456-426655440000"
356
356
  * }
357
357
  * *\/
358
- * // example id: to-create-a-job-1482864834886
359
358
  * ```
360
359
  *
360
+ * @public
361
361
  */
362
362
  export declare class CreateJobCommand extends CreateJobCommand_base {
363
363
  /** @internal type navigation helper, not in runtime. */
@@ -62,6 +62,7 @@ declare const CreateLongTermPricingCommand_base: {
62
62
  * @throws {@link SnowballServiceException}
63
63
  * <p>Base exception class for all service exceptions from Snowball service.</p>
64
64
  *
65
+ *
65
66
  * @public
66
67
  */
67
68
  export declare class CreateLongTermPricingCommand extends CreateLongTermPricingCommand_base {
@@ -75,6 +75,7 @@ declare const CreateReturnShippingLabelCommand_base: {
75
75
  * @throws {@link SnowballServiceException}
76
76
  * <p>Base exception class for all service exceptions from Snowball service.</p>
77
77
  *
78
+ *
78
79
  * @public
79
80
  */
80
81
  export declare class CreateReturnShippingLabelCommand extends CreateReturnShippingLabelCommand_base {
@@ -75,33 +75,33 @@ declare const DescribeAddressCommand_base: {
75
75
  * @throws {@link SnowballServiceException}
76
76
  * <p>Base exception class for all service exceptions from Snowball service.</p>
77
77
  *
78
- * @public
78
+ *
79
79
  * @example To describe an address for a job
80
80
  * ```javascript
81
81
  * // This operation describes an address for a job.
82
82
  * const input = {
83
- * "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b"
83
+ * AddressId: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b"
84
84
  * };
85
85
  * const command = new DescribeAddressCommand(input);
86
86
  * const response = await client.send(command);
87
- * /* response ==
87
+ * /* response is
88
88
  * {
89
- * "Address": {
90
- * "AddressId": "ADID5643ec50-3eec-4eb3-9be6-9374c10eb51b",
91
- * "City": "Seattle",
92
- * "Company": "My Company",
93
- * "Country": "US",
94
- * "Name": "My Name",
95
- * "PhoneNumber": "425-555-5555",
96
- * "PostalCode": "98101",
97
- * "StateOrProvince": "WA",
98
- * "Street1": "123 Main Street"
89
+ * Address: {
90
+ * AddressId: "ADID5643ec50-3eec-4eb3-9be6-9374c10eb51b",
91
+ * City: "Seattle",
92
+ * Company: "My Company",
93
+ * Country: "US",
94
+ * Name: "My Name",
95
+ * PhoneNumber: "425-555-5555",
96
+ * PostalCode: "98101",
97
+ * StateOrProvince: "WA",
98
+ * Street1: "123 Main Street"
99
99
  * }
100
100
  * }
101
101
  * *\/
102
- * // example id: to-describe-an-address-for-a-job-1482538608745
103
102
  * ```
104
103
  *
104
+ * @public
105
105
  */
106
106
  export declare class DescribeAddressCommand extends DescribeAddressCommand_base {
107
107
  /** @internal type navigation helper, not in runtime. */
@@ -85,33 +85,33 @@ declare const DescribeAddressesCommand_base: {
85
85
  * @throws {@link SnowballServiceException}
86
86
  * <p>Base exception class for all service exceptions from Snowball service.</p>
87
87
  *
88
- * @public
88
+ *
89
89
  * @example To describe all the addresses you've created for AWS Snowball
90
90
  * ```javascript
91
91
  * // This operation describes all the addresses that you've created for AWS Snowball. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.
92
- * const input = {};
92
+ * const input = { /* empty *\/ };
93
93
  * const command = new DescribeAddressesCommand(input);
94
94
  * const response = await client.send(command);
95
- * /* response ==
95
+ * /* response is
96
96
  * {
97
- * "Addresses": [
97
+ * Addresses: [
98
98
  * {
99
- * "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
100
- * "City": "Seattle",
101
- * "Company": "My Company",
102
- * "Country": "US",
103
- * "Name": "My Name",
104
- * "PhoneNumber": "425-555-5555",
105
- * "PostalCode": "98101",
106
- * "StateOrProvince": "WA",
107
- * "Street1": "123 Main Street"
99
+ * AddressId: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
100
+ * City: "Seattle",
101
+ * Company: "My Company",
102
+ * Country: "US",
103
+ * Name: "My Name",
104
+ * PhoneNumber: "425-555-5555",
105
+ * PostalCode: "98101",
106
+ * StateOrProvince: "WA",
107
+ * Street1: "123 Main Street"
108
108
  * }
109
109
  * ]
110
110
  * }
111
111
  * *\/
112
- * // example id: to-describe-all-the-addresses-youve-created-for-aws-snowball-1482538936603
113
112
  * ```
114
113
  *
114
+ * @public
115
115
  */
116
116
  export declare class DescribeAddressesCommand extends DescribeAddressesCommand_base {
117
117
  /** @internal type navigation helper, not in runtime. */
@@ -137,45 +137,8 @@ declare const DescribeClusterCommand_base: {
137
137
  * @throws {@link SnowballServiceException}
138
138
  * <p>Base exception class for all service exceptions from Snowball service.</p>
139
139
  *
140
- * @public
141
- * @example To describe a cluster
142
- * ```javascript
143
- * // Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
144
- * const input = {
145
- * "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000"
146
- * };
147
- * const command = new DescribeClusterCommand(input);
148
- * const response = await client.send(command);
149
- * /* response ==
150
- * {
151
- * "ClusterMetadata": {
152
- * "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
153
- * "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000",
154
- * "ClusterState": "Pending",
155
- * "CreationDate": "1480475517.0",
156
- * "Description": "MyCluster",
157
- * "JobType": "LOCAL_USE",
158
- * "KmsKeyARN": "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456",
159
- * "Notification": {
160
- * "JobStatesToNotify": [],
161
- * "NotifyAll": false
162
- * },
163
- * "Resources": {
164
- * "S3Resources": [
165
- * {
166
- * "BucketArn": "arn:aws:s3:::MyBucket",
167
- * "KeyRange": {}
168
- * }
169
- * ]
170
- * },
171
- * "RoleARN": "arn:aws:iam::123456789012:role/snowball-import-S3-role",
172
- * "ShippingOption": "SECOND_DAY"
173
- * }
174
- * }
175
- * *\/
176
- * // example id: to-describe-a-cluster-1482864218396
177
- * ```
178
140
  *
141
+ * @public
179
142
  */
180
143
  export declare class DescribeClusterCommand extends DescribeClusterCommand_base {
181
144
  /** @internal type navigation helper, not in runtime. */
@@ -304,49 +304,8 @@ declare const DescribeJobCommand_base: {
304
304
  * @throws {@link SnowballServiceException}
305
305
  * <p>Base exception class for all service exceptions from Snowball service.</p>
306
306
  *
307
- * @public
308
- * @example To describe a job you've created for AWS Snowball
309
- * ```javascript
310
- * // This operation describes a job you've created for AWS Snowball.
311
- * const input = {
312
- * "JobId": "JID123e4567-e89b-12d3-a456-426655440000"
313
- * };
314
- * const command = new DescribeJobCommand(input);
315
- * const response = await client.send(command);
316
- * /* response ==
317
- * {
318
- * "JobMetadata": {
319
- * "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
320
- * "CreationDate": "1475626164",
321
- * "Description": "My Job",
322
- * "JobId": "JID123e4567-e89b-12d3-a456-426655440000",
323
- * "JobState": "New",
324
- * "JobType": "IMPORT",
325
- * "KmsKeyARN": "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456",
326
- * "Notification": {
327
- * "JobStatesToNotify": [],
328
- * "NotifyAll": false
329
- * },
330
- * "Resources": {
331
- * "S3Resources": [
332
- * {
333
- * "BucketArn": "arn:aws:s3:::MyBucket",
334
- * "KeyRange": {}
335
- * }
336
- * ]
337
- * },
338
- * "RoleARN": "arn:aws:iam::123456789012:role/snowball-import-S3-role",
339
- * "ShippingDetails": {
340
- * "ShippingOption": "SECOND_DAY"
341
- * },
342
- * "SnowballCapacityPreference": "T80",
343
- * "SnowballType": "STANDARD"
344
- * }
345
- * }
346
- * *\/
347
- * // example id: to-describe-a-job-youve-created-for-aws-snowball-1482539500180
348
- * ```
349
307
  *
308
+ * @public
350
309
  */
351
310
  export declare class DescribeJobCommand extends DescribeJobCommand_base {
352
311
  /** @internal type navigation helper, not in runtime. */
@@ -68,6 +68,7 @@ declare const DescribeReturnShippingLabelCommand_base: {
68
68
  * @throws {@link SnowballServiceException}
69
69
  * <p>Base exception class for all service exceptions from Snowball service.</p>
70
70
  *
71
+ *
71
72
  * @public
72
73
  */
73
74
  export declare class DescribeReturnShippingLabelCommand extends DescribeReturnShippingLabelCommand_base {
@@ -77,29 +77,29 @@ declare const GetJobManifestCommand_base: {
77
77
  * @throws {@link SnowballServiceException}
78
78
  * <p>Base exception class for all service exceptions from Snowball service.</p>
79
79
  *
80
- * @public
80
+ *
81
81
  * @example To get the manifest for a job you've created for AWS Snowball
82
82
  * ```javascript
83
83
  * // Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action.
84
- * //
85
- * // The manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time.
86
- * //
87
- * // As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.
88
- * //
89
- * // The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.
84
+ *
85
+ * The manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time.
86
+ *
87
+ * As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.
88
+ *
89
+ * The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.
90
90
  * const input = {
91
- * "JobId": "JID123e4567-e89b-12d3-a456-426655440000"
91
+ * JobId: "JID123e4567-e89b-12d3-a456-426655440000"
92
92
  * };
93
93
  * const command = new GetJobManifestCommand(input);
94
94
  * const response = await client.send(command);
95
- * /* response ==
95
+ * /* response is
96
96
  * {
97
- * "ManifestURI": "https://awsie-frosty-manifests-prod.s3.amazonaws.com/JID123e4567-e89b-12d3-a456-426655440000_manifest.bin?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20161224T005115Z&X-Amz-SignedHeaders=..."
97
+ * ManifestURI: "https://awsie-frosty-manifests-prod.s3.amazonaws.com/JID123e4567-e89b-12d3-a456-426655440000_manifest.bin?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20161224T005115Z&X-Amz-SignedHeaders=..."
98
98
  * }
99
99
  * *\/
100
- * // example id: to-get-the-manifest-for-a-job-youve-created-for-aws-snowball-1482540389246
101
100
  * ```
102
101
  *
102
+ * @public
103
103
  */
104
104
  export declare class GetJobManifestCommand extends GetJobManifestCommand_base {
105
105
  /** @internal type navigation helper, not in runtime. */
@@ -74,27 +74,27 @@ declare const GetJobUnlockCodeCommand_base: {
74
74
  * @throws {@link SnowballServiceException}
75
75
  * <p>Base exception class for all service exceptions from Snowball service.</p>
76
76
  *
77
- * @public
77
+ *
78
78
  * @example To get the unlock code for a job you've created for AWS Snowball
79
79
  * ```javascript
80
80
  * // Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created.
81
- * //
82
- * // The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time.
83
- * //
84
- * // As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.
81
+ *
82
+ * The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time.
83
+ *
84
+ * As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.
85
85
  * const input = {
86
- * "JobId": "JID123e4567-e89b-12d3-a456-426655440000"
86
+ * JobId: "JID123e4567-e89b-12d3-a456-426655440000"
87
87
  * };
88
88
  * const command = new GetJobUnlockCodeCommand(input);
89
89
  * const response = await client.send(command);
90
- * /* response ==
90
+ * /* response is
91
91
  * {
92
- * "UnlockCode": "12345-abcde-56789-fghij-01234"
92
+ * UnlockCode: "12345-abcde-56789-fghij-01234"
93
93
  * }
94
94
  * *\/
95
- * // example id: to-get-the-unlock-code-for-a-job-youve-created-for-aws-snowball-1482541987286
96
95
  * ```
97
96
  *
97
+ * @public
98
98
  */
99
99
  export declare class GetJobUnlockCodeCommand extends GetJobUnlockCodeCommand_base {
100
100
  /** @internal type navigation helper, not in runtime. */
@@ -56,24 +56,24 @@ declare const GetSnowballUsageCommand_base: {
56
56
  * @throws {@link SnowballServiceException}
57
57
  * <p>Base exception class for all service exceptions from Snowball service.</p>
58
58
  *
59
- * @public
59
+ *
60
60
  * @example To see your Snowball service limit and the number of Snowballs you have in use
61
61
  * ```javascript
62
62
  * // Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.
63
- * //
64
- * // The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support.
65
- * const input = {};
63
+ *
64
+ * The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support.
65
+ * const input = { /* empty *\/ };
66
66
  * const command = new GetSnowballUsageCommand(input);
67
67
  * const response = await client.send(command);
68
- * /* response ==
68
+ * /* response is
69
69
  * {
70
- * "SnowballLimit": 1,
71
- * "SnowballsInUse": 0
70
+ * SnowballLimit: 1,
71
+ * SnowballsInUse: 0
72
72
  * }
73
73
  * *\/
74
- * // example id: to-see-your-snowball-service-limit-and-the-number-of-snowballs-you-have-in-use-1482863394588
75
74
  * ```
76
75
  *
76
+ * @public
77
77
  */
78
78
  export declare class GetSnowballUsageCommand extends GetSnowballUsageCommand_base {
79
79
  /** @internal type navigation helper, not in runtime. */
@@ -63,6 +63,7 @@ declare const GetSoftwareUpdatesCommand_base: {
63
63
  * @throws {@link SnowballServiceException}
64
64
  * <p>Base exception class for all service exceptions from Snowball service.</p>
65
65
  *
66
+ *
66
67
  * @public
67
68
  */
68
69
  export declare class GetSoftwareUpdatesCommand extends GetSoftwareUpdatesCommand_base {
@@ -24,7 +24,7 @@ export interface ListClusterJobsCommandOutput extends ListClusterJobsResult, __M
24
24
  declare const ListClusterJobsCommand_base: {
25
25
  new (input: ListClusterJobsCommandInput): import("@smithy/smithy-client").CommandImpl<ListClusterJobsCommandInput, ListClusterJobsCommandOutput, SnowballClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
26
  new (__0_0: ListClusterJobsCommandInput): import("@smithy/smithy-client").CommandImpl<ListClusterJobsCommandInput, ListClusterJobsCommandOutput, SnowballClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
- getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; /** @internal type navigation helper, not in runtime. */
28
28
  };
29
29
  /**
30
30
  * <p>Returns an array of <code>JobListEntry</code> objects of the specified length. Each
@@ -78,69 +78,8 @@ declare const ListClusterJobsCommand_base: {
78
78
  * @throws {@link SnowballServiceException}
79
79
  * <p>Base exception class for all service exceptions from Snowball service.</p>
80
80
  *
81
- * @public
82
- * @example To get a list of jobs in a cluster that you've created for AWS Snowball
83
- * ```javascript
84
- * // Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.
85
- * const input = {
86
- * "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000"
87
- * };
88
- * const command = new ListClusterJobsCommand(input);
89
- * const response = await client.send(command);
90
- * /* response ==
91
- * {
92
- * "JobListEntries": [
93
- * {
94
- * "CreationDate": "1480475524.0",
95
- * "Description": "MyClustrer-node-001",
96
- * "IsMaster": false,
97
- * "JobId": "JID123e4567-e89b-12d3-a456-426655440000",
98
- * "JobState": "New",
99
- * "JobType": "LOCAL_USE",
100
- * "SnowballType": "EDGE"
101
- * },
102
- * {
103
- * "CreationDate": "1480475525.0",
104
- * "Description": "MyClustrer-node-002",
105
- * "IsMaster": false,
106
- * "JobId": "JID123e4567-e89b-12d3-a456-426655440001",
107
- * "JobState": "New",
108
- * "JobType": "LOCAL_USE",
109
- * "SnowballType": "EDGE"
110
- * },
111
- * {
112
- * "CreationDate": "1480475525.0",
113
- * "Description": "MyClustrer-node-003",
114
- * "IsMaster": false,
115
- * "JobId": "JID123e4567-e89b-12d3-a456-426655440002",
116
- * "JobState": "New",
117
- * "JobType": "LOCAL_USE",
118
- * "SnowballType": "EDGE"
119
- * },
120
- * {
121
- * "CreationDate": "1480475525.0",
122
- * "Description": "MyClustrer-node-004",
123
- * "IsMaster": false,
124
- * "JobId": "JID123e4567-e89b-12d3-a456-426655440003",
125
- * "JobState": "New",
126
- * "JobType": "LOCAL_USE",
127
- * "SnowballType": "EDGE"
128
- * },
129
- * {
130
- * "CreationDate": "1480475525.0",
131
- * "Description": "MyClustrer-node-005",
132
- * "IsMaster": false,
133
- * "JobId": "JID123e4567-e89b-12d3-a456-426655440004",
134
- * "JobState": "New",
135
- * "JobType": "LOCAL_USE",
136
- * "SnowballType": "EDGE"
137
- * }
138
- * ]
139
- * }
140
- * *\/
141
- * // example id: to-get-a-list-of-jobs-in-a-cluster-that-youve-created-for-aws-snowball-1482863105773
142
- * ```
143
81
  *
82
+ * @public
144
83
  */
145
84
  export declare class ListClusterJobsCommand extends ListClusterJobsCommand_base {
146
85
  /** @internal type navigation helper, not in runtime. */
@@ -70,28 +70,8 @@ declare const ListClustersCommand_base: {
70
70
  * @throws {@link SnowballServiceException}
71
71
  * <p>Base exception class for all service exceptions from Snowball service.</p>
72
72
  *
73
- * @public
74
- * @example To get a list of clusters that you've created for AWS Snowball
75
- * ```javascript
76
- * // Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.
77
- * const input = {};
78
- * const command = new ListClustersCommand(input);
79
- * const response = await client.send(command);
80
- * /* response ==
81
- * {
82
- * "ClusterListEntries": [
83
- * {
84
- * "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000",
85
- * "ClusterState": "Pending",
86
- * "CreationDate": "1480475517.0",
87
- * "Description": "MyCluster"
88
- * }
89
- * ]
90
- * }
91
- * *\/
92
- * // example id: to-get-a-list-of-clusters-that-youve-created-for-aws-snowball-1482862223003
93
- * ```
94
73
  *
74
+ * @public
95
75
  */
96
76
  export declare class ListClustersCommand extends ListClustersCommand_base {
97
77
  /** @internal type navigation helper, not in runtime. */
@@ -73,6 +73,7 @@ declare const ListCompatibleImagesCommand_base: {
73
73
  * @throws {@link SnowballServiceException}
74
74
  * <p>Base exception class for all service exceptions from Snowball service.</p>
75
75
  *
76
+ *
76
77
  * @public
77
78
  */
78
79
  export declare class ListCompatibleImagesCommand extends ListCompatibleImagesCommand_base {
@@ -75,31 +75,8 @@ declare const ListJobsCommand_base: {
75
75
  * @throws {@link SnowballServiceException}
76
76
  * <p>Base exception class for all service exceptions from Snowball service.</p>
77
77
  *
78
- * @public
79
- * @example To get a list of jobs that you've created for AWS Snowball
80
- * ```javascript
81
- * // Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.
82
- * const input = {};
83
- * const command = new ListJobsCommand(input);
84
- * const response = await client.send(command);
85
- * /* response ==
86
- * {
87
- * "JobListEntries": [
88
- * {
89
- * "CreationDate": "1460678186.0",
90
- * "Description": "MyJob",
91
- * "IsMaster": false,
92
- * "JobId": "JID123e4567-e89b-12d3-a456-426655440000",
93
- * "JobState": "New",
94
- * "JobType": "IMPORT",
95
- * "SnowballType": "STANDARD"
96
- * }
97
- * ]
98
- * }
99
- * *\/
100
- * // example id: to-get-a-list-of-jobs-that-youve-created-for-aws-snowball-1482542167627
101
- * ```
102
78
  *
79
+ * @public
103
80
  */
104
81
  export declare class ListJobsCommand extends ListJobsCommand_base {
105
82
  /** @internal type navigation helper, not in runtime. */
@@ -80,6 +80,7 @@ declare const ListLongTermPricingCommand_base: {
80
80
  * @throws {@link SnowballServiceException}
81
81
  * <p>Base exception class for all service exceptions from Snowball service.</p>
82
82
  *
83
+ *
83
84
  * @public
84
85
  */
85
86
  export declare class ListLongTermPricingCommand extends ListLongTermPricingCommand_base {
@@ -78,33 +78,33 @@ declare const ListPickupLocationsCommand_base: {
78
78
  * @throws {@link SnowballServiceException}
79
79
  * <p>Base exception class for all service exceptions from Snowball service.</p>
80
80
  *
81
- * @public
81
+ *
82
82
  * @example To get a list of locations from which the customer can choose to pickup a device.
83
83
  * ```javascript
84
84
  * // Returns a specified number of Address objects. Each Address is a pickup location address for Snow Family devices.
85
- * const input = {};
85
+ * const input = { /* empty *\/ };
86
86
  * const command = new ListPickupLocationsCommand(input);
87
87
  * const response = await client.send(command);
88
- * /* response ==
88
+ * /* response is
89
89
  * {
90
- * "Addresses": [
90
+ * Addresses: [
91
91
  * {
92
- * "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
93
- * "City": "Seattle",
94
- * "Company": "My Company",
95
- * "Country": "US",
96
- * "Name": "My Name",
97
- * "PhoneNumber": "425-555-5555",
98
- * "PostalCode": "98101",
99
- * "StateOrProvince": "WA",
100
- * "Street1": "123 Main Street"
92
+ * AddressId: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
93
+ * City: "Seattle",
94
+ * Company: "My Company",
95
+ * Country: "US",
96
+ * Name: "My Name",
97
+ * PhoneNumber: "425-555-5555",
98
+ * PostalCode: "98101",
99
+ * StateOrProvince: "WA",
100
+ * Street1: "123 Main Street"
101
101
  * }
102
102
  * ]
103
103
  * }
104
104
  * *\/
105
- * // example id: to-get-a-list-of-locations-from-which-the-customer-can-choose-to-pickup-a-device-1482542167627
106
105
  * ```
107
106
  *
107
+ * @public
108
108
  */
109
109
  export declare class ListPickupLocationsCommand extends ListPickupLocationsCommand_base {
110
110
  /** @internal type navigation helper, not in runtime. */
@@ -88,6 +88,7 @@ declare const ListServiceVersionsCommand_base: {
88
88
  * @throws {@link SnowballServiceException}
89
89
  * <p>Base exception class for all service exceptions from Snowball service.</p>
90
90
  *
91
+ *
91
92
  * @public
92
93
  */
93
94
  export declare class ListServiceVersionsCommand extends ListServiceVersionsCommand_base {
@@ -140,20 +140,23 @@ declare const UpdateClusterCommand_base: {
140
140
  * @throws {@link SnowballServiceException}
141
141
  * <p>Base exception class for all service exceptions from Snowball service.</p>
142
142
  *
143
- * @public
143
+ *
144
144
  * @example To update a cluster
145
145
  * ```javascript
146
146
  * // This action allows you to update certain parameters for a cluster. Once the cluster changes to a different state, usually within 60 minutes of it being created, this action is no longer available.
147
147
  * const input = {
148
- * "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
149
- * "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000",
150
- * "Description": "updated-cluster-name"
148
+ * AddressId: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
149
+ * ClusterId: "CID123e4567-e89b-12d3-a456-426655440000",
150
+ * Description: "updated-cluster-name"
151
151
  * };
152
152
  * const command = new UpdateClusterCommand(input);
153
- * await client.send(command);
154
- * // example id: to-update-a-cluster-1482863900595
153
+ * const response = await client.send(command);
154
+ * /* response is
155
+ * { /* metadata only *\/ }
156
+ * *\/
155
157
  * ```
156
158
  *
159
+ * @public
157
160
  */
158
161
  export declare class UpdateClusterCommand extends UpdateClusterCommand_base {
159
162
  /** @internal type navigation helper, not in runtime. */
@@ -154,22 +154,25 @@ declare const UpdateJobCommand_base: {
154
154
  * @throws {@link SnowballServiceException}
155
155
  * <p>Base exception class for all service exceptions from Snowball service.</p>
156
156
  *
157
- * @public
157
+ *
158
158
  * @example To update a job
159
159
  * ```javascript
160
160
  * // This action allows you to update certain parameters for a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.
161
161
  * const input = {
162
- * "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
163
- * "Description": "updated-job-name",
164
- * "JobId": "JID123e4567-e89b-12d3-a456-426655440000",
165
- * "ShippingOption": "NEXT_DAY",
166
- * "SnowballCapacityPreference": "T100"
162
+ * AddressId: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
163
+ * Description: "updated-job-name",
164
+ * JobId: "JID123e4567-e89b-12d3-a456-426655440000",
165
+ * ShippingOption: "NEXT_DAY",
166
+ * SnowballCapacityPreference: "T100"
167
167
  * };
168
168
  * const command = new UpdateJobCommand(input);
169
- * await client.send(command);
170
- * // example id: to-update-a-job-1482863556886
169
+ * const response = await client.send(command);
170
+ * /* response is
171
+ * { /* metadata only *\/ }
172
+ * *\/
171
173
  * ```
172
174
  *
175
+ * @public
173
176
  */
174
177
  export declare class UpdateJobCommand extends UpdateJobCommand_base {
175
178
  /** @internal type navigation helper, not in runtime. */
@@ -61,6 +61,7 @@ declare const UpdateJobShipmentStateCommand_base: {
61
61
  * @throws {@link SnowballServiceException}
62
62
  * <p>Base exception class for all service exceptions from Snowball service.</p>
63
63
  *
64
+ *
64
65
  * @public
65
66
  */
66
67
  export declare class UpdateJobShipmentStateCommand extends UpdateJobShipmentStateCommand_base {
@@ -58,6 +58,7 @@ declare const UpdateLongTermPricingCommand_base: {
58
58
  * @throws {@link SnowballServiceException}
59
59
  * <p>Base exception class for all service exceptions from Snowball service.</p>
60
60
  *
61
+ *
61
62
  * @public
62
63
  */
63
64
  export declare class UpdateLongTermPricingCommand extends UpdateLongTermPricingCommand_base {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-snowball",
3
3
  "description": "AWS SDK for JavaScript Snowball Client for Node.js, Browser and React Native",
4
- "version": "3.775.0",
4
+ "version": "3.782.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-snowball",
@@ -21,16 +21,16 @@
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
23
  "@aws-sdk/core": "3.775.0",
24
- "@aws-sdk/credential-provider-node": "3.775.0",
24
+ "@aws-sdk/credential-provider-node": "3.782.0",
25
25
  "@aws-sdk/middleware-host-header": "3.775.0",
26
26
  "@aws-sdk/middleware-logger": "3.775.0",
27
27
  "@aws-sdk/middleware-recursion-detection": "3.775.0",
28
- "@aws-sdk/middleware-user-agent": "3.775.0",
28
+ "@aws-sdk/middleware-user-agent": "3.782.0",
29
29
  "@aws-sdk/region-config-resolver": "3.775.0",
30
30
  "@aws-sdk/types": "3.775.0",
31
- "@aws-sdk/util-endpoints": "3.775.0",
31
+ "@aws-sdk/util-endpoints": "3.782.0",
32
32
  "@aws-sdk/util-user-agent-browser": "3.775.0",
33
- "@aws-sdk/util-user-agent-node": "3.775.0",
33
+ "@aws-sdk/util-user-agent-node": "3.782.0",
34
34
  "@smithy/config-resolver": "^4.1.0",
35
35
  "@smithy/core": "^3.2.0",
36
36
  "@smithy/fetch-http-handler": "^5.0.2",