@aws-sdk/client-glacier 3.289.0 → 3.292.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 (34) hide show
  1. package/dist-types/commands/AbortMultipartUploadCommand.d.ts +14 -0
  2. package/dist-types/commands/AbortVaultLockCommand.d.ts +14 -0
  3. package/dist-types/commands/AddTagsToVaultCommand.d.ts +17 -0
  4. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +14 -0
  5. package/dist-types/commands/CompleteVaultLockCommand.d.ts +14 -0
  6. package/dist-types/commands/CreateVaultCommand.d.ts +13 -0
  7. package/dist-types/commands/DeleteArchiveCommand.d.ts +14 -0
  8. package/dist-types/commands/DeleteVaultAccessPolicyCommand.d.ts +14 -0
  9. package/dist-types/commands/DeleteVaultCommand.d.ts +14 -0
  10. package/dist-types/commands/DeleteVaultNotificationsCommand.d.ts +14 -0
  11. package/dist-types/commands/DescribeJobCommand.d.ts +14 -0
  12. package/dist-types/commands/DescribeVaultCommand.d.ts +14 -0
  13. package/dist-types/commands/GetDataRetrievalPolicyCommand.d.ts +10 -0
  14. package/dist-types/commands/GetJobOutputCommand.d.ts +14 -0
  15. package/dist-types/commands/GetVaultAccessPolicyCommand.d.ts +14 -0
  16. package/dist-types/commands/GetVaultLockCommand.d.ts +14 -0
  17. package/dist-types/commands/GetVaultNotificationsCommand.d.ts +14 -0
  18. package/dist-types/commands/InitiateJobCommand.d.ts +23 -0
  19. package/dist-types/commands/InitiateMultipartUploadCommand.d.ts +14 -0
  20. package/dist-types/commands/InitiateVaultLockCommand.d.ts +14 -0
  21. package/dist-types/commands/ListJobsCommand.d.ts +14 -0
  22. package/dist-types/commands/ListMultipartUploadsCommand.d.ts +14 -0
  23. package/dist-types/commands/ListPartsCommand.d.ts +14 -0
  24. package/dist-types/commands/ListProvisionedCapacityCommand.d.ts +10 -0
  25. package/dist-types/commands/ListTagsForVaultCommand.d.ts +14 -0
  26. package/dist-types/commands/ListVaultsCommand.d.ts +14 -0
  27. package/dist-types/commands/PurchaseProvisionedCapacityCommand.d.ts +13 -0
  28. package/dist-types/commands/RemoveTagsFromVaultCommand.d.ts +14 -0
  29. package/dist-types/commands/SetDataRetrievalPolicyCommand.d.ts +10 -0
  30. package/dist-types/commands/SetVaultAccessPolicyCommand.d.ts +14 -0
  31. package/dist-types/commands/SetVaultNotificationsCommand.d.ts +14 -0
  32. package/dist-types/commands/UploadArchiveCommand.d.ts +18 -0
  33. package/dist-types/commands/UploadMultipartPartCommand.d.ts +18 -0
  34. package/package.json +41 -46
@@ -46,6 +46,20 @@ export interface AbortMultipartUploadCommandOutput extends __MetadataBearer {
46
46
  * @see {@link AbortMultipartUploadCommandOutput} for command's `response` shape.
47
47
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
48
48
  *
49
+ * @throws {@link InvalidParameterValueException} (client fault)
50
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
51
+ *
52
+ * @throws {@link MissingParameterValueException} (client fault)
53
+ * <p>Returned if a required header or parameter is missing from the request.</p>
54
+ *
55
+ * @throws {@link ResourceNotFoundException} (client fault)
56
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
57
+ * exist.</p>
58
+ *
59
+ * @throws {@link ServiceUnavailableException} (server fault)
60
+ * <p>Returned if the service cannot complete the request.</p>
61
+ *
62
+ *
49
63
  * @example To abort a multipart upload identified by the upload ID
50
64
  * ```javascript
51
65
  * // The example deletes an in-progress multipart upload to a vault named my-vault:
@@ -42,6 +42,20 @@ export interface AbortVaultLockCommandOutput extends __MetadataBearer {
42
42
  * @see {@link AbortVaultLockCommandOutput} for command's `response` shape.
43
43
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
44
44
  *
45
+ * @throws {@link InvalidParameterValueException} (client fault)
46
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
47
+ *
48
+ * @throws {@link MissingParameterValueException} (client fault)
49
+ * <p>Returned if a required header or parameter is missing from the request.</p>
50
+ *
51
+ * @throws {@link ResourceNotFoundException} (client fault)
52
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
53
+ * exist.</p>
54
+ *
55
+ * @throws {@link ServiceUnavailableException} (server fault)
56
+ * <p>Returned if the service cannot complete the request.</p>
57
+ *
58
+ *
45
59
  * @example To abort a vault lock
46
60
  * ```javascript
47
61
  * // The example aborts the vault locking process if the vault lock is not in the Locked state for the vault named examplevault.
@@ -34,6 +34,23 @@ export interface AddTagsToVaultCommandOutput extends __MetadataBearer {
34
34
  * @see {@link AddTagsToVaultCommandOutput} for command's `response` shape.
35
35
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
36
36
  *
37
+ * @throws {@link InvalidParameterValueException} (client fault)
38
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
39
+ *
40
+ * @throws {@link LimitExceededException} (client fault)
41
+ * <p>Returned if the request results in a vault or account limit being exceeded.</p>
42
+ *
43
+ * @throws {@link MissingParameterValueException} (client fault)
44
+ * <p>Returned if a required header or parameter is missing from the request.</p>
45
+ *
46
+ * @throws {@link ResourceNotFoundException} (client fault)
47
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
48
+ * exist.</p>
49
+ *
50
+ * @throws {@link ServiceUnavailableException} (server fault)
51
+ * <p>Returned if the service cannot complete the request.</p>
52
+ *
53
+ *
37
54
  * @example To add tags to a vault
38
55
  * ```javascript
39
56
  * // The example adds two tags to a my-vault.
@@ -66,6 +66,20 @@ export interface CompleteMultipartUploadCommandOutput extends ArchiveCreationOut
66
66
  * @see {@link CompleteMultipartUploadCommandOutput} for command's `response` shape.
67
67
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
68
68
  *
69
+ * @throws {@link InvalidParameterValueException} (client fault)
70
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
71
+ *
72
+ * @throws {@link MissingParameterValueException} (client fault)
73
+ * <p>Returned if a required header or parameter is missing from the request.</p>
74
+ *
75
+ * @throws {@link ResourceNotFoundException} (client fault)
76
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
77
+ * exist.</p>
78
+ *
79
+ * @throws {@link ServiceUnavailableException} (server fault)
80
+ * <p>Returned if the service cannot complete the request.</p>
81
+ *
82
+ *
69
83
  * @example To complete a multipart upload
70
84
  * ```javascript
71
85
  * // The example completes a multipart upload for a 3 MiB archive.
@@ -42,6 +42,20 @@ export interface CompleteVaultLockCommandOutput extends __MetadataBearer {
42
42
  * @see {@link CompleteVaultLockCommandOutput} for command's `response` shape.
43
43
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
44
44
  *
45
+ * @throws {@link InvalidParameterValueException} (client fault)
46
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
47
+ *
48
+ * @throws {@link MissingParameterValueException} (client fault)
49
+ * <p>Returned if a required header or parameter is missing from the request.</p>
50
+ *
51
+ * @throws {@link ResourceNotFoundException} (client fault)
52
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
53
+ * exist.</p>
54
+ *
55
+ * @throws {@link ServiceUnavailableException} (server fault)
56
+ * <p>Returned if the service cannot complete the request.</p>
57
+ *
58
+ *
45
59
  * @example To complete a vault lock
46
60
  * ```javascript
47
61
  * // The example completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state.
@@ -52,6 +52,19 @@ export interface CreateVaultCommandOutput extends CreateVaultOutput, __MetadataB
52
52
  * @see {@link CreateVaultCommandOutput} for command's `response` shape.
53
53
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
54
54
  *
55
+ * @throws {@link InvalidParameterValueException} (client fault)
56
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
57
+ *
58
+ * @throws {@link LimitExceededException} (client fault)
59
+ * <p>Returned if the request results in a vault or account limit being exceeded.</p>
60
+ *
61
+ * @throws {@link MissingParameterValueException} (client fault)
62
+ * <p>Returned if a required header or parameter is missing from the request.</p>
63
+ *
64
+ * @throws {@link ServiceUnavailableException} (server fault)
65
+ * <p>Returned if the service cannot complete the request.</p>
66
+ *
67
+ *
55
68
  * @example To create a new vault
56
69
  * ```javascript
57
70
  * // The following example creates a new vault named my-vault.
@@ -55,6 +55,20 @@ export interface DeleteArchiveCommandOutput extends __MetadataBearer {
55
55
  * @see {@link DeleteArchiveCommandOutput} for command's `response` shape.
56
56
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
57
57
  *
58
+ * @throws {@link InvalidParameterValueException} (client fault)
59
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
60
+ *
61
+ * @throws {@link MissingParameterValueException} (client fault)
62
+ * <p>Returned if a required header or parameter is missing from the request.</p>
63
+ *
64
+ * @throws {@link ResourceNotFoundException} (client fault)
65
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
66
+ * exist.</p>
67
+ *
68
+ * @throws {@link ServiceUnavailableException} (server fault)
69
+ * <p>Returned if the service cannot complete the request.</p>
70
+ *
71
+ *
58
72
  * @example To delete an archive
59
73
  * ```javascript
60
74
  * // The example deletes the archive specified by the archive ID.
@@ -35,6 +35,20 @@ export interface DeleteVaultAccessPolicyCommandOutput extends __MetadataBearer {
35
35
  * @see {@link DeleteVaultAccessPolicyCommandOutput} for command's `response` shape.
36
36
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
37
37
  *
38
+ * @throws {@link InvalidParameterValueException} (client fault)
39
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
40
+ *
41
+ * @throws {@link MissingParameterValueException} (client fault)
42
+ * <p>Returned if a required header or parameter is missing from the request.</p>
43
+ *
44
+ * @throws {@link ResourceNotFoundException} (client fault)
45
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
46
+ * exist.</p>
47
+ *
48
+ * @throws {@link ServiceUnavailableException} (server fault)
49
+ * <p>Returned if the service cannot complete the request.</p>
50
+ *
51
+ *
38
52
  * @example To delete the vault access policy
39
53
  * ```javascript
40
54
  * // The example deletes the access policy associated with the vault named examplevault.
@@ -48,6 +48,20 @@ export interface DeleteVaultCommandOutput extends __MetadataBearer {
48
48
  * @see {@link DeleteVaultCommandOutput} for command's `response` shape.
49
49
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
50
50
  *
51
+ * @throws {@link InvalidParameterValueException} (client fault)
52
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
53
+ *
54
+ * @throws {@link MissingParameterValueException} (client fault)
55
+ * <p>Returned if a required header or parameter is missing from the request.</p>
56
+ *
57
+ * @throws {@link ResourceNotFoundException} (client fault)
58
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
59
+ * exist.</p>
60
+ *
61
+ * @throws {@link ServiceUnavailableException} (server fault)
62
+ * <p>Returned if the service cannot complete the request.</p>
63
+ *
64
+ *
51
65
  * @example To delete a vault
52
66
  * ```javascript
53
67
  * // The example deletes a vault named my-vault:
@@ -41,6 +41,20 @@ export interface DeleteVaultNotificationsCommandOutput extends __MetadataBearer
41
41
  * @see {@link DeleteVaultNotificationsCommandOutput} for command's `response` shape.
42
42
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
43
43
  *
44
+ * @throws {@link InvalidParameterValueException} (client fault)
45
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
46
+ *
47
+ * @throws {@link MissingParameterValueException} (client fault)
48
+ * <p>Returned if a required header or parameter is missing from the request.</p>
49
+ *
50
+ * @throws {@link ResourceNotFoundException} (client fault)
51
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
52
+ * exist.</p>
53
+ *
54
+ * @throws {@link ServiceUnavailableException} (server fault)
55
+ * <p>Returned if the service cannot complete the request.</p>
56
+ *
57
+ *
44
58
  * @example To delete the notification configuration set for a vault
45
59
  * ```javascript
46
60
  * // The example deletes the notification configuration set for the vault named examplevault.
@@ -52,6 +52,20 @@ export interface DescribeJobCommandOutput extends GlacierJobDescription, __Metad
52
52
  * @see {@link DescribeJobCommandOutput} for command's `response` shape.
53
53
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
54
54
  *
55
+ * @throws {@link InvalidParameterValueException} (client fault)
56
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
57
+ *
58
+ * @throws {@link MissingParameterValueException} (client fault)
59
+ * <p>Returned if a required header or parameter is missing from the request.</p>
60
+ *
61
+ * @throws {@link ResourceNotFoundException} (client fault)
62
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
63
+ * exist.</p>
64
+ *
65
+ * @throws {@link ServiceUnavailableException} (server fault)
66
+ * <p>Returned if the service cannot complete the request.</p>
67
+ *
68
+ *
55
69
  * @example To get information about a previously initiated job
56
70
  * ```javascript
57
71
  * // The example returns information about the previously initiated job specified by the job ID.
@@ -46,6 +46,20 @@ export interface DescribeVaultCommandOutput extends DescribeVaultOutput, __Metad
46
46
  * @see {@link DescribeVaultCommandOutput} for command's `response` shape.
47
47
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
48
48
  *
49
+ * @throws {@link InvalidParameterValueException} (client fault)
50
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
51
+ *
52
+ * @throws {@link MissingParameterValueException} (client fault)
53
+ * <p>Returned if a required header or parameter is missing from the request.</p>
54
+ *
55
+ * @throws {@link ResourceNotFoundException} (client fault)
56
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
57
+ * exist.</p>
58
+ *
59
+ * @throws {@link ServiceUnavailableException} (server fault)
60
+ * <p>Returned if the service cannot complete the request.</p>
61
+ *
62
+ *
49
63
  * @example To retrieve information about a vault
50
64
  * ```javascript
51
65
  * // The example retrieves data about a vault named my-vault.
@@ -31,6 +31,16 @@ export interface GetDataRetrievalPolicyCommandOutput extends GetDataRetrievalPol
31
31
  * @see {@link GetDataRetrievalPolicyCommandOutput} for command's `response` shape.
32
32
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
33
33
  *
34
+ * @throws {@link InvalidParameterValueException} (client fault)
35
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
36
+ *
37
+ * @throws {@link MissingParameterValueException} (client fault)
38
+ * <p>Returned if a required header or parameter is missing from the request.</p>
39
+ *
40
+ * @throws {@link ServiceUnavailableException} (server fault)
41
+ * <p>Returned if the service cannot complete the request.</p>
42
+ *
43
+ *
34
44
  * @example To get the current data retrieval policy for an account
35
45
  * ```javascript
36
46
  * // The example returns the current data retrieval policy for the account.
@@ -65,6 +65,20 @@ export interface GetJobOutputCommandOutput extends __WithSdkStreamMixin<GetJobOu
65
65
  * @see {@link GetJobOutputCommandOutput} for command's `response` shape.
66
66
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
67
67
  *
68
+ * @throws {@link InvalidParameterValueException} (client fault)
69
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
70
+ *
71
+ * @throws {@link MissingParameterValueException} (client fault)
72
+ * <p>Returned if a required header or parameter is missing from the request.</p>
73
+ *
74
+ * @throws {@link ResourceNotFoundException} (client fault)
75
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
76
+ * exist.</p>
77
+ *
78
+ * @throws {@link ServiceUnavailableException} (server fault)
79
+ * <p>Returned if the service cannot complete the request.</p>
80
+ *
81
+ *
68
82
  * @example To get the output of a previously initiated job
69
83
  * ```javascript
70
84
  * // The example downloads the output of a previously initiated inventory retrieval job that is identified by the job ID.
@@ -34,6 +34,20 @@ export interface GetVaultAccessPolicyCommandOutput extends GetVaultAccessPolicyO
34
34
  * @see {@link GetVaultAccessPolicyCommandOutput} for command's `response` shape.
35
35
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
36
36
  *
37
+ * @throws {@link InvalidParameterValueException} (client fault)
38
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
39
+ *
40
+ * @throws {@link MissingParameterValueException} (client fault)
41
+ * <p>Returned if a required header or parameter is missing from the request.</p>
42
+ *
43
+ * @throws {@link ResourceNotFoundException} (client fault)
44
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
45
+ * exist.</p>
46
+ *
47
+ * @throws {@link ServiceUnavailableException} (server fault)
48
+ * <p>Returned if the service cannot complete the request.</p>
49
+ *
50
+ *
37
51
  * @example To get the access-policy set on the vault
38
52
  * ```javascript
39
53
  * // The example retrieves the access-policy set on the vault named example-vault.
@@ -56,6 +56,20 @@ export interface GetVaultLockCommandOutput extends GetVaultLockOutput, __Metadat
56
56
  * @see {@link GetVaultLockCommandOutput} for command's `response` shape.
57
57
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
58
58
  *
59
+ * @throws {@link InvalidParameterValueException} (client fault)
60
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
61
+ *
62
+ * @throws {@link MissingParameterValueException} (client fault)
63
+ * <p>Returned if a required header or parameter is missing from the request.</p>
64
+ *
65
+ * @throws {@link ResourceNotFoundException} (client fault)
66
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
67
+ * exist.</p>
68
+ *
69
+ * @throws {@link ServiceUnavailableException} (server fault)
70
+ * <p>Returned if the service cannot complete the request.</p>
71
+ *
72
+ *
59
73
  * @example To retrieve vault lock-policy related attributes that are set on a vault
60
74
  * ```javascript
61
75
  * // The example retrieves the attributes from the lock-policy subresource set on the vault named examplevault.
@@ -44,6 +44,20 @@ export interface GetVaultNotificationsCommandOutput extends GetVaultNotification
44
44
  * @see {@link GetVaultNotificationsCommandOutput} for command's `response` shape.
45
45
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
46
46
  *
47
+ * @throws {@link InvalidParameterValueException} (client fault)
48
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
49
+ *
50
+ * @throws {@link MissingParameterValueException} (client fault)
51
+ * <p>Returned if a required header or parameter is missing from the request.</p>
52
+ *
53
+ * @throws {@link ResourceNotFoundException} (client fault)
54
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
55
+ * exist.</p>
56
+ *
57
+ * @throws {@link ServiceUnavailableException} (server fault)
58
+ * <p>Returned if the service cannot complete the request.</p>
59
+ *
60
+ *
47
61
  * @example To get the notification-configuration for the specified vault
48
62
  * ```javascript
49
63
  * // The example retrieves the notification-configuration for the vault named my-vault.
@@ -33,6 +33,29 @@ export interface InitiateJobCommandOutput extends InitiateJobOutput, __MetadataB
33
33
  * @see {@link InitiateJobCommandOutput} for command's `response` shape.
34
34
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
35
35
  *
36
+ * @throws {@link InsufficientCapacityException} (client fault)
37
+ * <p>Returned if there is insufficient capacity to process this expedited request. This
38
+ * error only applies to expedited retrievals and not to standard or bulk
39
+ * retrievals.</p>
40
+ *
41
+ * @throws {@link InvalidParameterValueException} (client fault)
42
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
43
+ *
44
+ * @throws {@link MissingParameterValueException} (client fault)
45
+ * <p>Returned if a required header or parameter is missing from the request.</p>
46
+ *
47
+ * @throws {@link PolicyEnforcedException} (client fault)
48
+ * <p>Returned if a retrieval job would exceed the current data policy's retrieval rate
49
+ * limit. For more information about data retrieval policies,</p>
50
+ *
51
+ * @throws {@link ResourceNotFoundException} (client fault)
52
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
53
+ * exist.</p>
54
+ *
55
+ * @throws {@link ServiceUnavailableException} (server fault)
56
+ * <p>Returned if the service cannot complete the request.</p>
57
+ *
58
+ *
36
59
  * @example To initiate an inventory-retrieval job
37
60
  * ```javascript
38
61
  * // The example initiates an inventory-retrieval job for the vault named examplevault.
@@ -62,6 +62,20 @@ export interface InitiateMultipartUploadCommandOutput extends InitiateMultipartU
62
62
  * @see {@link InitiateMultipartUploadCommandOutput} for command's `response` shape.
63
63
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
64
64
  *
65
+ * @throws {@link InvalidParameterValueException} (client fault)
66
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
67
+ *
68
+ * @throws {@link MissingParameterValueException} (client fault)
69
+ * <p>Returned if a required header or parameter is missing from the request.</p>
70
+ *
71
+ * @throws {@link ResourceNotFoundException} (client fault)
72
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
73
+ * exist.</p>
74
+ *
75
+ * @throws {@link ServiceUnavailableException} (server fault)
76
+ * <p>Returned if the service cannot complete the request.</p>
77
+ *
78
+ *
65
79
  * @example To initiate a multipart upload
66
80
  * ```javascript
67
81
  * // The example initiates a multipart upload to a vault named my-vault with a part size of 1 MiB (1024 x 1024 bytes) per file.
@@ -63,6 +63,20 @@ export interface InitiateVaultLockCommandOutput extends InitiateVaultLockOutput,
63
63
  * @see {@link InitiateVaultLockCommandOutput} for command's `response` shape.
64
64
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
65
65
  *
66
+ * @throws {@link InvalidParameterValueException} (client fault)
67
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
68
+ *
69
+ * @throws {@link MissingParameterValueException} (client fault)
70
+ * <p>Returned if a required header or parameter is missing from the request.</p>
71
+ *
72
+ * @throws {@link ResourceNotFoundException} (client fault)
73
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
74
+ * exist.</p>
75
+ *
76
+ * @throws {@link ServiceUnavailableException} (server fault)
77
+ * <p>Returned if the service cannot complete the request.</p>
78
+ *
79
+ *
66
80
  * @example To initiate the vault locking process
67
81
  * ```javascript
68
82
  * // The example initiates the vault locking process for the vault named my-vault.
@@ -64,6 +64,20 @@ export interface ListJobsCommandOutput extends ListJobsOutput, __MetadataBearer
64
64
  * @see {@link ListJobsCommandOutput} for command's `response` shape.
65
65
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
66
66
  *
67
+ * @throws {@link InvalidParameterValueException} (client fault)
68
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
69
+ *
70
+ * @throws {@link MissingParameterValueException} (client fault)
71
+ * <p>Returned if a required header or parameter is missing from the request.</p>
72
+ *
73
+ * @throws {@link ResourceNotFoundException} (client fault)
74
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
75
+ * exist.</p>
76
+ *
77
+ * @throws {@link ServiceUnavailableException} (server fault)
78
+ * <p>Returned if the service cannot complete the request.</p>
79
+ *
80
+ *
67
81
  * @example To list jobs for a vault
68
82
  * ```javascript
69
83
  * // The example lists jobs for the vault named my-vault.
@@ -54,6 +54,20 @@ export interface ListMultipartUploadsCommandOutput extends ListMultipartUploadsO
54
54
  * @see {@link ListMultipartUploadsCommandOutput} for command's `response` shape.
55
55
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
56
56
  *
57
+ * @throws {@link InvalidParameterValueException} (client fault)
58
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
59
+ *
60
+ * @throws {@link MissingParameterValueException} (client fault)
61
+ * <p>Returned if a required header or parameter is missing from the request.</p>
62
+ *
63
+ * @throws {@link ResourceNotFoundException} (client fault)
64
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
65
+ * exist.</p>
66
+ *
67
+ * @throws {@link ServiceUnavailableException} (server fault)
68
+ * <p>Returned if the service cannot complete the request.</p>
69
+ *
70
+ *
57
71
  * @example To list all the in-progress multipart uploads for a vault
58
72
  * ```javascript
59
73
  * // The example lists all the in-progress multipart uploads for the vault named examplevault.
@@ -50,6 +50,20 @@ export interface ListPartsCommandOutput extends ListPartsOutput, __MetadataBeare
50
50
  * @see {@link ListPartsCommandOutput} for command's `response` shape.
51
51
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
52
52
  *
53
+ * @throws {@link InvalidParameterValueException} (client fault)
54
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
55
+ *
56
+ * @throws {@link MissingParameterValueException} (client fault)
57
+ * <p>Returned if a required header or parameter is missing from the request.</p>
58
+ *
59
+ * @throws {@link ResourceNotFoundException} (client fault)
60
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
61
+ * exist.</p>
62
+ *
63
+ * @throws {@link ServiceUnavailableException} (server fault)
64
+ * <p>Returned if the service cannot complete the request.</p>
65
+ *
66
+ *
53
67
  * @example To list the parts of an archive that have been uploaded in a multipart upload
54
68
  * ```javascript
55
69
  * // The example lists all the parts of a multipart upload.
@@ -30,6 +30,16 @@ export interface ListProvisionedCapacityCommandOutput extends ListProvisionedCap
30
30
  * @see {@link ListProvisionedCapacityCommandOutput} for command's `response` shape.
31
31
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
32
32
  *
33
+ * @throws {@link InvalidParameterValueException} (client fault)
34
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
35
+ *
36
+ * @throws {@link MissingParameterValueException} (client fault)
37
+ * <p>Returned if a required header or parameter is missing from the request.</p>
38
+ *
39
+ * @throws {@link ServiceUnavailableException} (server fault)
40
+ * <p>Returned if the service cannot complete the request.</p>
41
+ *
42
+ *
33
43
  * @example To list the provisioned capacity units for an account
34
44
  * ```javascript
35
45
  * // The example lists the provisioned capacity units for an account.
@@ -31,6 +31,20 @@ export interface ListTagsForVaultCommandOutput extends ListTagsForVaultOutput, _
31
31
  * @see {@link ListTagsForVaultCommandOutput} for command's `response` shape.
32
32
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
33
33
  *
34
+ * @throws {@link InvalidParameterValueException} (client fault)
35
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
36
+ *
37
+ * @throws {@link MissingParameterValueException} (client fault)
38
+ * <p>Returned if a required header or parameter is missing from the request.</p>
39
+ *
40
+ * @throws {@link ResourceNotFoundException} (client fault)
41
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
42
+ * exist.</p>
43
+ *
44
+ * @throws {@link ServiceUnavailableException} (server fault)
45
+ * <p>Returned if the service cannot complete the request.</p>
46
+ *
47
+ *
34
48
  * @example To list the tags for a vault
35
49
  * ```javascript
36
50
  * // The example lists all the tags attached to the vault examplevault.
@@ -47,6 +47,20 @@ export interface ListVaultsCommandOutput extends ListVaultsOutput, __MetadataBea
47
47
  * @see {@link ListVaultsCommandOutput} for command's `response` shape.
48
48
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
49
49
  *
50
+ * @throws {@link InvalidParameterValueException} (client fault)
51
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
52
+ *
53
+ * @throws {@link MissingParameterValueException} (client fault)
54
+ * <p>Returned if a required header or parameter is missing from the request.</p>
55
+ *
56
+ * @throws {@link ResourceNotFoundException} (client fault)
57
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
58
+ * exist.</p>
59
+ *
60
+ * @throws {@link ServiceUnavailableException} (server fault)
61
+ * <p>Returned if the service cannot complete the request.</p>
62
+ *
63
+ *
50
64
  * @example To list all vaults owned by the calling user's account
51
65
  * ```javascript
52
66
  * // The example lists all vaults owned by the specified AWS account.
@@ -29,6 +29,19 @@ export interface PurchaseProvisionedCapacityCommandOutput extends PurchaseProvis
29
29
  * @see {@link PurchaseProvisionedCapacityCommandOutput} for command's `response` shape.
30
30
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
31
31
  *
32
+ * @throws {@link InvalidParameterValueException} (client fault)
33
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
34
+ *
35
+ * @throws {@link LimitExceededException} (client fault)
36
+ * <p>Returned if the request results in a vault or account limit being exceeded.</p>
37
+ *
38
+ * @throws {@link MissingParameterValueException} (client fault)
39
+ * <p>Returned if a required header or parameter is missing from the request.</p>
40
+ *
41
+ * @throws {@link ServiceUnavailableException} (server fault)
42
+ * <p>Returned if the service cannot complete the request.</p>
43
+ *
44
+ *
32
45
  * @example To purchases a provisioned capacity unit for an AWS account
33
46
  * ```javascript
34
47
  * // The example purchases provisioned capacity unit for an AWS account.
@@ -32,6 +32,20 @@ export interface RemoveTagsFromVaultCommandOutput extends __MetadataBearer {
32
32
  * @see {@link RemoveTagsFromVaultCommandOutput} for command's `response` shape.
33
33
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
34
34
  *
35
+ * @throws {@link InvalidParameterValueException} (client fault)
36
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
37
+ *
38
+ * @throws {@link MissingParameterValueException} (client fault)
39
+ * <p>Returned if a required header or parameter is missing from the request.</p>
40
+ *
41
+ * @throws {@link ResourceNotFoundException} (client fault)
42
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
43
+ * exist.</p>
44
+ *
45
+ * @throws {@link ServiceUnavailableException} (server fault)
46
+ * <p>Returned if the service cannot complete the request.</p>
47
+ *
48
+ *
35
49
  * @example To remove tags from a vault
36
50
  * ```javascript
37
51
  * // The example removes two tags from the vault named examplevault.
@@ -34,6 +34,16 @@ export interface SetDataRetrievalPolicyCommandOutput extends __MetadataBearer {
34
34
  * @see {@link SetDataRetrievalPolicyCommandOutput} for command's `response` shape.
35
35
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
36
36
  *
37
+ * @throws {@link InvalidParameterValueException} (client fault)
38
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
39
+ *
40
+ * @throws {@link MissingParameterValueException} (client fault)
41
+ * <p>Returned if a required header or parameter is missing from the request.</p>
42
+ *
43
+ * @throws {@link ServiceUnavailableException} (server fault)
44
+ * <p>Returned if the service cannot complete the request.</p>
45
+ *
46
+ *
37
47
  * @example To set and then enact a data retrieval policy
38
48
  * ```javascript
39
49
  * // The example sets and then enacts a data retrieval policy.
@@ -34,6 +34,20 @@ export interface SetVaultAccessPolicyCommandOutput extends __MetadataBearer {
34
34
  * @see {@link SetVaultAccessPolicyCommandOutput} for command's `response` shape.
35
35
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
36
36
  *
37
+ * @throws {@link InvalidParameterValueException} (client fault)
38
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
39
+ *
40
+ * @throws {@link MissingParameterValueException} (client fault)
41
+ * <p>Returned if a required header or parameter is missing from the request.</p>
42
+ *
43
+ * @throws {@link ResourceNotFoundException} (client fault)
44
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
45
+ * exist.</p>
46
+ *
47
+ * @throws {@link ServiceUnavailableException} (server fault)
48
+ * <p>Returned if the service cannot complete the request.</p>
49
+ *
50
+ *
37
51
  * @example To set the access-policy on a vault
38
52
  * ```javascript
39
53
  * // The example configures an access policy for the vault named examplevault.
@@ -66,6 +66,20 @@ export interface SetVaultNotificationsCommandOutput extends __MetadataBearer {
66
66
  * @see {@link SetVaultNotificationsCommandOutput} for command's `response` shape.
67
67
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
68
68
  *
69
+ * @throws {@link InvalidParameterValueException} (client fault)
70
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
71
+ *
72
+ * @throws {@link MissingParameterValueException} (client fault)
73
+ * <p>Returned if a required header or parameter is missing from the request.</p>
74
+ *
75
+ * @throws {@link ResourceNotFoundException} (client fault)
76
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
77
+ * exist.</p>
78
+ *
79
+ * @throws {@link ServiceUnavailableException} (server fault)
80
+ * <p>Returned if the service cannot complete the request.</p>
81
+ *
82
+ *
69
83
  * @example To configure a vault to post a message to an Amazon SNS topic when jobs complete
70
84
  * ```javascript
71
85
  * // The example sets the examplevault notification configuration.
@@ -70,6 +70,24 @@ export interface UploadArchiveCommandOutput extends ArchiveCreationOutput, __Met
70
70
  * @see {@link UploadArchiveCommandOutput} for command's `response` shape.
71
71
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
72
72
  *
73
+ * @throws {@link InvalidParameterValueException} (client fault)
74
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
75
+ *
76
+ * @throws {@link MissingParameterValueException} (client fault)
77
+ * <p>Returned if a required header or parameter is missing from the request.</p>
78
+ *
79
+ * @throws {@link RequestTimeoutException} (client fault)
80
+ * <p>Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the
81
+ * upload.</p>
82
+ *
83
+ * @throws {@link ResourceNotFoundException} (client fault)
84
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
85
+ * exist.</p>
86
+ *
87
+ * @throws {@link ServiceUnavailableException} (server fault)
88
+ * <p>Returned if the service cannot complete the request.</p>
89
+ *
90
+ *
73
91
  * @example To upload an archive
74
92
  * ```javascript
75
93
  * // The example adds an archive to a vault.
@@ -89,6 +89,24 @@ export interface UploadMultipartPartCommandOutput extends UploadMultipartPartOut
89
89
  * @see {@link UploadMultipartPartCommandOutput} for command's `response` shape.
90
90
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
91
91
  *
92
+ * @throws {@link InvalidParameterValueException} (client fault)
93
+ * <p>Returned if a parameter of the request is incorrectly specified.</p>
94
+ *
95
+ * @throws {@link MissingParameterValueException} (client fault)
96
+ * <p>Returned if a required header or parameter is missing from the request.</p>
97
+ *
98
+ * @throws {@link RequestTimeoutException} (client fault)
99
+ * <p>Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the
100
+ * upload.</p>
101
+ *
102
+ * @throws {@link ResourceNotFoundException} (client fault)
103
+ * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
104
+ * exist.</p>
105
+ *
106
+ * @throws {@link ServiceUnavailableException} (server fault)
107
+ * <p>Returned if the service cannot complete the request.</p>
108
+ *
109
+ *
92
110
  * @example To upload the first part of an archive
93
111
  * ```javascript
94
112
  * // The example uploads the first 1 MiB (1024 x 1024 bytes) part of an archive.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-glacier",
3
3
  "description": "AWS SDK for JavaScript Glacier Client for Node.js, Browser and React Native",
4
- "version": "3.289.0",
4
+ "version": "3.292.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,61 +20,56 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/body-checksum-browser": "3.289.0",
24
- "@aws-sdk/body-checksum-node": "3.289.0",
25
- "@aws-sdk/client-sts": "3.289.0",
26
- "@aws-sdk/config-resolver": "3.289.0",
27
- "@aws-sdk/credential-provider-node": "3.289.0",
28
- "@aws-sdk/fetch-http-handler": "3.289.0",
29
- "@aws-sdk/hash-node": "3.289.0",
30
- "@aws-sdk/invalid-dependency": "3.289.0",
31
- "@aws-sdk/middleware-content-length": "3.289.0",
32
- "@aws-sdk/middleware-endpoint": "3.289.0",
33
- "@aws-sdk/middleware-host-header": "3.289.0",
34
- "@aws-sdk/middleware-logger": "3.289.0",
35
- "@aws-sdk/middleware-recursion-detection": "3.289.0",
36
- "@aws-sdk/middleware-retry": "3.289.0",
37
- "@aws-sdk/middleware-sdk-glacier": "3.289.0",
38
- "@aws-sdk/middleware-serde": "3.289.0",
39
- "@aws-sdk/middleware-signing": "3.289.0",
40
- "@aws-sdk/middleware-stack": "3.289.0",
41
- "@aws-sdk/middleware-user-agent": "3.289.0",
42
- "@aws-sdk/node-config-provider": "3.289.0",
43
- "@aws-sdk/node-http-handler": "3.289.0",
44
- "@aws-sdk/protocol-http": "3.289.0",
45
- "@aws-sdk/smithy-client": "3.289.0",
46
- "@aws-sdk/types": "3.289.0",
47
- "@aws-sdk/url-parser": "3.289.0",
48
- "@aws-sdk/util-base64": "3.208.0",
49
- "@aws-sdk/util-body-length-browser": "3.188.0",
50
- "@aws-sdk/util-body-length-node": "3.208.0",
51
- "@aws-sdk/util-defaults-mode-browser": "3.289.0",
52
- "@aws-sdk/util-defaults-mode-node": "3.289.0",
53
- "@aws-sdk/util-endpoints": "3.289.0",
54
- "@aws-sdk/util-retry": "3.289.0",
55
- "@aws-sdk/util-stream-browser": "3.289.0",
56
- "@aws-sdk/util-stream-node": "3.289.0",
57
- "@aws-sdk/util-user-agent-browser": "3.289.0",
58
- "@aws-sdk/util-user-agent-node": "3.289.0",
59
- "@aws-sdk/util-utf8": "3.254.0",
60
- "@aws-sdk/util-waiter": "3.289.0",
23
+ "@aws-sdk/body-checksum-browser": "3.292.0",
24
+ "@aws-sdk/body-checksum-node": "3.292.0",
25
+ "@aws-sdk/client-sts": "3.292.0",
26
+ "@aws-sdk/config-resolver": "3.292.0",
27
+ "@aws-sdk/credential-provider-node": "3.292.0",
28
+ "@aws-sdk/fetch-http-handler": "3.292.0",
29
+ "@aws-sdk/hash-node": "3.292.0",
30
+ "@aws-sdk/invalid-dependency": "3.292.0",
31
+ "@aws-sdk/middleware-content-length": "3.292.0",
32
+ "@aws-sdk/middleware-endpoint": "3.292.0",
33
+ "@aws-sdk/middleware-host-header": "3.292.0",
34
+ "@aws-sdk/middleware-logger": "3.292.0",
35
+ "@aws-sdk/middleware-recursion-detection": "3.292.0",
36
+ "@aws-sdk/middleware-retry": "3.292.0",
37
+ "@aws-sdk/middleware-sdk-glacier": "3.292.0",
38
+ "@aws-sdk/middleware-serde": "3.292.0",
39
+ "@aws-sdk/middleware-signing": "3.292.0",
40
+ "@aws-sdk/middleware-stack": "3.292.0",
41
+ "@aws-sdk/middleware-user-agent": "3.292.0",
42
+ "@aws-sdk/node-config-provider": "3.292.0",
43
+ "@aws-sdk/node-http-handler": "3.292.0",
44
+ "@aws-sdk/protocol-http": "3.292.0",
45
+ "@aws-sdk/smithy-client": "3.292.0",
46
+ "@aws-sdk/types": "3.292.0",
47
+ "@aws-sdk/url-parser": "3.292.0",
48
+ "@aws-sdk/util-base64": "3.292.0",
49
+ "@aws-sdk/util-body-length-browser": "3.292.0",
50
+ "@aws-sdk/util-body-length-node": "3.292.0",
51
+ "@aws-sdk/util-defaults-mode-browser": "3.292.0",
52
+ "@aws-sdk/util-defaults-mode-node": "3.292.0",
53
+ "@aws-sdk/util-endpoints": "3.292.0",
54
+ "@aws-sdk/util-retry": "3.292.0",
55
+ "@aws-sdk/util-stream-browser": "3.292.0",
56
+ "@aws-sdk/util-stream-node": "3.292.0",
57
+ "@aws-sdk/util-user-agent-browser": "3.292.0",
58
+ "@aws-sdk/util-user-agent-node": "3.292.0",
59
+ "@aws-sdk/util-utf8": "3.292.0",
60
+ "@aws-sdk/util-waiter": "3.292.0",
61
61
  "tslib": "^2.3.1"
62
62
  },
63
63
  "devDependencies": {
64
- "@aws-sdk/service-client-documentation-generator": "3.208.0",
64
+ "@aws-sdk/service-client-documentation-generator": "3.292.0",
65
65
  "@tsconfig/node14": "1.0.3",
66
66
  "@types/node": "^14.14.31",
67
67
  "concurrently": "7.0.0",
68
68
  "downlevel-dts": "0.10.1",
69
69
  "rimraf": "3.0.2",
70
- "typedoc": "0.19.2",
70
+ "typedoc": "0.23.23",
71
71
  "typescript": "~4.6.2"
72
72
  },
73
- "overrides": {
74
- "typedoc": {
75
- "typescript": "~4.6.2"
76
- }
77
- },
78
73
  "engines": {
79
74
  "node": ">=14.0.0"
80
75
  },