@aws-sdk/client-glacier 3.288.0 → 3.290.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 +27 -0
  2. package/dist-types/commands/AbortVaultLockCommand.d.ts +26 -0
  3. package/dist-types/commands/AddTagsToVaultCommand.d.ts +33 -0
  4. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +36 -0
  5. package/dist-types/commands/CompleteVaultLockCommand.d.ts +27 -0
  6. package/dist-types/commands/CreateVaultCommand.d.ts +30 -0
  7. package/dist-types/commands/DeleteArchiveCommand.d.ts +27 -0
  8. package/dist-types/commands/DeleteVaultAccessPolicyCommand.d.ts +26 -0
  9. package/dist-types/commands/DeleteVaultCommand.d.ts +26 -0
  10. package/dist-types/commands/DeleteVaultNotificationsCommand.d.ts +26 -0
  11. package/dist-types/commands/DescribeJobCommand.d.ts +40 -0
  12. package/dist-types/commands/DescribeVaultCommand.d.ts +35 -0
  13. package/dist-types/commands/GetDataRetrievalPolicyCommand.d.ts +33 -0
  14. package/dist-types/commands/GetJobOutputCommand.d.ts +36 -0
  15. package/dist-types/commands/GetVaultAccessPolicyCommand.d.ts +33 -0
  16. package/dist-types/commands/GetVaultLockCommand.d.ts +34 -0
  17. package/dist-types/commands/GetVaultNotificationsCommand.d.ts +37 -0
  18. package/dist-types/commands/InitiateJobCommand.d.ts +47 -0
  19. package/dist-types/commands/InitiateMultipartUploadCommand.d.ts +33 -0
  20. package/dist-types/commands/InitiateVaultLockCommand.d.ts +34 -0
  21. package/dist-types/commands/ListJobsCommand.d.ts +58 -0
  22. package/dist-types/commands/ListMultipartUploadsCommand.d.ts +54 -0
  23. package/dist-types/commands/ListPartsCommand.d.ts +47 -0
  24. package/dist-types/commands/ListProvisionedCapacityCommand.d.ts +37 -0
  25. package/dist-types/commands/ListTagsForVaultCommand.d.ts +34 -0
  26. package/dist-types/commands/ListVaultsCommand.d.ts +41 -0
  27. package/dist-types/commands/PurchaseProvisionedCapacityCommand.d.ts +29 -0
  28. package/dist-types/commands/RemoveTagsFromVaultCommand.d.ts +30 -0
  29. package/dist-types/commands/SetDataRetrievalPolicyCommand.d.ts +29 -0
  30. package/dist-types/commands/SetVaultAccessPolicyCommand.d.ts +29 -0
  31. package/dist-types/commands/SetVaultNotificationsCommand.d.ts +33 -0
  32. package/dist-types/commands/UploadArchiveCommand.d.ts +40 -0
  33. package/dist-types/commands/UploadMultipartPartCommand.d.ts +39 -0
  34. package/package.json +35 -35
@@ -46,6 +46,33 @@ 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
+ *
63
+ * @example To abort a multipart upload identified by the upload ID
64
+ * ```javascript
65
+ * // The example deletes an in-progress multipart upload to a vault named my-vault:
66
+ * const input = {
67
+ * "accountId": "-",
68
+ * "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
69
+ * "vaultName": "my-vault"
70
+ * };
71
+ * const command = new AbortMultipartUploadCommand(input);
72
+ * await client.send(command);
73
+ * // example id: f3d907f6-e71c-420c-8f71-502346a2c48a
74
+ * ```
75
+ *
49
76
  */
50
77
  export declare class AbortMultipartUploadCommand extends $Command<AbortMultipartUploadCommandInput, AbortMultipartUploadCommandOutput, GlacierClientResolvedConfig> {
51
78
  readonly input: AbortMultipartUploadCommandInput;
@@ -42,6 +42,32 @@ 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
+ *
59
+ * @example To abort a vault lock
60
+ * ```javascript
61
+ * // The example aborts the vault locking process if the vault lock is not in the Locked state for the vault named examplevault.
62
+ * const input = {
63
+ * "accountId": "-",
64
+ * "vaultName": "examplevault"
65
+ * };
66
+ * const command = new AbortVaultLockCommand(input);
67
+ * await client.send(command);
68
+ * // example id: to-abort-a-vault-lock-1481839357947
69
+ * ```
70
+ *
45
71
  */
46
72
  export declare class AbortVaultLockCommand extends $Command<AbortVaultLockCommandInput, AbortVaultLockCommandOutput, GlacierClientResolvedConfig> {
47
73
  readonly input: AbortVaultLockCommandInput;
@@ -34,6 +34,39 @@ 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
+ *
54
+ * @example To add tags to a vault
55
+ * ```javascript
56
+ * // The example adds two tags to a my-vault.
57
+ * const input = {
58
+ * "Tags": {
59
+ * "examplekey1": "examplevalue1",
60
+ * "examplekey2": "examplevalue2"
61
+ * },
62
+ * "accountId": "-",
63
+ * "vaultName": "my-vault"
64
+ * };
65
+ * const command = new AddTagsToVaultCommand(input);
66
+ * await client.send(command);
67
+ * // example id: add-tags-to-vault-post-tags-add-1481663457694
68
+ * ```
69
+ *
37
70
  */
38
71
  export declare class AddTagsToVaultCommand extends $Command<AddTagsToVaultCommandInput, AddTagsToVaultCommandOutput, GlacierClientResolvedConfig> {
39
72
  readonly input: AddTagsToVaultCommandInput;
@@ -66,6 +66,42 @@ 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
+ *
83
+ * @example To complete a multipart upload
84
+ * ```javascript
85
+ * // The example completes a multipart upload for a 3 MiB archive.
86
+ * const input = {
87
+ * "accountId": "-",
88
+ * "archiveSize": "3145728",
89
+ * "checksum": "9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67",
90
+ * "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
91
+ * "vaultName": "my-vault"
92
+ * };
93
+ * const command = new CompleteMultipartUploadCommand(input);
94
+ * const response = await client.send(command);
95
+ * /* response ==
96
+ * {
97
+ * "archiveId": "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId",
98
+ * "checksum": "9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67",
99
+ * "location": "/111122223333/vaults/my-vault/archives/NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId"
100
+ * }
101
+ * *\/
102
+ * // example id: 272aa0b8-e44c-4a64-add2-ad905a37984d
103
+ * ```
104
+ *
69
105
  */
70
106
  export declare class CompleteMultipartUploadCommand extends $Command<CompleteMultipartUploadCommandInput, CompleteMultipartUploadCommandOutput, GlacierClientResolvedConfig> {
71
107
  readonly input: CompleteMultipartUploadCommandInput;
@@ -42,6 +42,33 @@ 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
+ *
59
+ * @example To complete a vault lock
60
+ * ```javascript
61
+ * // The example completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state.
62
+ * const input = {
63
+ * "accountId": "-",
64
+ * "lockId": "AE863rKkWZU53SLW5be4DUcW",
65
+ * "vaultName": "example-vault"
66
+ * };
67
+ * const command = new CompleteVaultLockCommand(input);
68
+ * await client.send(command);
69
+ * // example id: to-complete-a-vault-lock-1481839721312
70
+ * ```
71
+ *
45
72
  */
46
73
  export declare class CompleteVaultLockCommand extends $Command<CompleteVaultLockCommandInput, CompleteVaultLockCommandOutput, GlacierClientResolvedConfig> {
47
74
  readonly input: CompleteVaultLockCommandInput;
@@ -52,6 +52,36 @@ 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
+ *
68
+ * @example To create a new vault
69
+ * ```javascript
70
+ * // The following example creates a new vault named my-vault.
71
+ * const input = {
72
+ * "accountId": "-",
73
+ * "vaultName": "my-vault"
74
+ * };
75
+ * const command = new CreateVaultCommand(input);
76
+ * const response = await client.send(command);
77
+ * /* response ==
78
+ * {
79
+ * "location": "/111122223333/vaults/my-vault"
80
+ * }
81
+ * *\/
82
+ * // example id: 1dc0313d-ace1-4e6c-9d13-1ec7813b14b7
83
+ * ```
84
+ *
55
85
  */
56
86
  export declare class CreateVaultCommand extends $Command<CreateVaultCommandInput, CreateVaultCommandOutput, GlacierClientResolvedConfig> {
57
87
  readonly input: CreateVaultCommandInput;
@@ -55,6 +55,33 @@ 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
+ *
72
+ * @example To delete an archive
73
+ * ```javascript
74
+ * // The example deletes the archive specified by the archive ID.
75
+ * const input = {
76
+ * "accountId": "-",
77
+ * "archiveId": "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId",
78
+ * "vaultName": "examplevault"
79
+ * };
80
+ * const command = new DeleteArchiveCommand(input);
81
+ * await client.send(command);
82
+ * // example id: delete-archive-1481667809463
83
+ * ```
84
+ *
58
85
  */
59
86
  export declare class DeleteArchiveCommand extends $Command<DeleteArchiveCommandInput, DeleteArchiveCommandOutput, GlacierClientResolvedConfig> {
60
87
  readonly input: DeleteArchiveCommandInput;
@@ -35,6 +35,32 @@ 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
+ *
52
+ * @example To delete the vault access policy
53
+ * ```javascript
54
+ * // The example deletes the access policy associated with the vault named examplevault.
55
+ * const input = {
56
+ * "accountId": "-",
57
+ * "vaultName": "examplevault"
58
+ * };
59
+ * const command = new DeleteVaultAccessPolicyCommand(input);
60
+ * await client.send(command);
61
+ * // example id: to-delete-the-vault-access-policy-1481840424677
62
+ * ```
63
+ *
38
64
  */
39
65
  export declare class DeleteVaultAccessPolicyCommand extends $Command<DeleteVaultAccessPolicyCommandInput, DeleteVaultAccessPolicyCommandOutput, GlacierClientResolvedConfig> {
40
66
  readonly input: DeleteVaultAccessPolicyCommandInput;
@@ -48,6 +48,32 @@ 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
+ *
65
+ * @example To delete a vault
66
+ * ```javascript
67
+ * // The example deletes a vault named my-vault:
68
+ * const input = {
69
+ * "accountId": "-",
70
+ * "vaultName": "my-vault"
71
+ * };
72
+ * const command = new DeleteVaultCommand(input);
73
+ * await client.send(command);
74
+ * // example id: 7f7f000b-4bdb-40d2-91e6-7c902f60f60f
75
+ * ```
76
+ *
51
77
  */
52
78
  export declare class DeleteVaultCommand extends $Command<DeleteVaultCommandInput, DeleteVaultCommandOutput, GlacierClientResolvedConfig> {
53
79
  readonly input: DeleteVaultCommandInput;
@@ -41,6 +41,32 @@ 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
+ *
58
+ * @example To delete the notification configuration set for a vault
59
+ * ```javascript
60
+ * // The example deletes the notification configuration set for the vault named examplevault.
61
+ * const input = {
62
+ * "accountId": "-",
63
+ * "vaultName": "examplevault"
64
+ * };
65
+ * const command = new DeleteVaultNotificationsCommand(input);
66
+ * await client.send(command);
67
+ * // example id: to-delete-the-notification-configuration-set-for-a-vault-1481840646090
68
+ * ```
69
+ *
44
70
  */
45
71
  export declare class DeleteVaultNotificationsCommand extends $Command<DeleteVaultNotificationsCommandInput, DeleteVaultNotificationsCommandOutput, GlacierClientResolvedConfig> {
46
72
  readonly input: DeleteVaultNotificationsCommandInput;
@@ -52,6 +52,46 @@ 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
+ *
69
+ * @example To get information about a previously initiated job
70
+ * ```javascript
71
+ * // The example returns information about the previously initiated job specified by the job ID.
72
+ * const input = {
73
+ * "accountId": "-",
74
+ * "jobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4Cn",
75
+ * "vaultName": "my-vault"
76
+ * };
77
+ * const command = new DescribeJobCommand(input);
78
+ * const response = await client.send(command);
79
+ * /* response ==
80
+ * {
81
+ * "Action": "InventoryRetrieval",
82
+ * "Completed": false,
83
+ * "CreationDate": "2015-07-17T20:23:41.616Z",
84
+ * "InventoryRetrievalParameters": {
85
+ * "Format": "JSON"
86
+ * },
87
+ * "JobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",
88
+ * "StatusCode": "InProgress",
89
+ * "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault"
90
+ * }
91
+ * *\/
92
+ * // example id: to-get-information-about-a-job-you-previously-initiated-1481840928592
93
+ * ```
94
+ *
55
95
  */
56
96
  export declare class DescribeJobCommand extends $Command<DescribeJobCommandInput, DescribeJobCommandOutput, GlacierClientResolvedConfig> {
57
97
  readonly input: DescribeJobCommandInput;
@@ -46,6 +46,41 @@ 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
+ *
63
+ * @example To retrieve information about a vault
64
+ * ```javascript
65
+ * // The example retrieves data about a vault named my-vault.
66
+ * const input = {
67
+ * "accountId": "-",
68
+ * "vaultName": "my-vault"
69
+ * };
70
+ * const command = new DescribeVaultCommand(input);
71
+ * const response = await client.send(command);
72
+ * /* response ==
73
+ * {
74
+ * "CreationDate": "2016-09-23T19:27:18.665Z",
75
+ * "NumberOfArchives": 0,
76
+ * "SizeInBytes": 0,
77
+ * "VaultARN": "arn:aws:glacier:us-west-2:111122223333:vaults/my-vault",
78
+ * "VaultName": "my-vault"
79
+ * }
80
+ * *\/
81
+ * // example id: 3c1c6e9d-f5a2-427a-aa6a-f439eacfc05f
82
+ * ```
83
+ *
49
84
  */
50
85
  export declare class DescribeVaultCommand extends $Command<DescribeVaultCommandInput, DescribeVaultCommandOutput, GlacierClientResolvedConfig> {
51
86
  readonly input: DescribeVaultCommandInput;
@@ -31,6 +31,39 @@ 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
+ *
44
+ * @example To get the current data retrieval policy for an account
45
+ * ```javascript
46
+ * // The example returns the current data retrieval policy for the account.
47
+ * const input = {
48
+ * "accountId": "-"
49
+ * };
50
+ * const command = new GetDataRetrievalPolicyCommand(input);
51
+ * const response = await client.send(command);
52
+ * /* response ==
53
+ * {
54
+ * "Policy": {
55
+ * "Rules": [
56
+ * {
57
+ * "BytesPerHour": 10737418240,
58
+ * "Strategy": "BytesPerHour"
59
+ * }
60
+ * ]
61
+ * }
62
+ * }
63
+ * *\/
64
+ * // example id: to-get-the-current-data-retrieval-policy-for-the-account-1481851580439
65
+ * ```
66
+ *
34
67
  */
35
68
  export declare class GetDataRetrievalPolicyCommand extends $Command<GetDataRetrievalPolicyCommandInput, GetDataRetrievalPolicyCommandOutput, GlacierClientResolvedConfig> {
36
69
  readonly input: GetDataRetrievalPolicyCommandInput;
@@ -65,6 +65,42 @@ 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
+ *
82
+ * @example To get the output of a previously initiated job
83
+ * ```javascript
84
+ * // The example downloads the output of a previously initiated inventory retrieval job that is identified by the job ID.
85
+ * const input = {
86
+ * "accountId": "-",
87
+ * "jobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",
88
+ * "range": "",
89
+ * "vaultName": "my-vaul"
90
+ * };
91
+ * const command = new GetJobOutputCommand(input);
92
+ * const response = await client.send(command);
93
+ * /* response ==
94
+ * {
95
+ * "acceptRanges": "bytes",
96
+ * "body": "inventory-data",
97
+ * "contentType": "application/json",
98
+ * "status": 200
99
+ * }
100
+ * *\/
101
+ * // example id: to-get-the-output-of-a-previously-initiated-job-1481848550859
102
+ * ```
103
+ *
68
104
  */
69
105
  export declare class GetJobOutputCommand extends $Command<GetJobOutputCommandInput, GetJobOutputCommandOutput, GlacierClientResolvedConfig> {
70
106
  readonly input: GetJobOutputCommandInput;
@@ -34,6 +34,39 @@ 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
+ *
51
+ * @example To get the access-policy set on the vault
52
+ * ```javascript
53
+ * // The example retrieves the access-policy set on the vault named example-vault.
54
+ * const input = {
55
+ * "accountId": "-",
56
+ * "vaultName": "example-vault"
57
+ * };
58
+ * const command = new GetVaultAccessPolicyCommand(input);
59
+ * const response = await client.send(command);
60
+ * /* response ==
61
+ * {
62
+ * "policy": {
63
+ * "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-owner-access-rights\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\"}]}"
64
+ * }
65
+ * }
66
+ * *\/
67
+ * // example id: to--get-the-access-policy-set-on-the-vault-1481936004590
68
+ * ```
69
+ *
37
70
  */
38
71
  export declare class GetVaultAccessPolicyCommand extends $Command<GetVaultAccessPolicyCommandInput, GetVaultAccessPolicyCommandOutput, GlacierClientResolvedConfig> {
39
72
  readonly input: GetVaultAccessPolicyCommandInput;
@@ -56,6 +56,40 @@ 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
+ *
73
+ * @example To retrieve vault lock-policy related attributes that are set on a vault
74
+ * ```javascript
75
+ * // The example retrieves the attributes from the lock-policy subresource set on the vault named examplevault.
76
+ * const input = {
77
+ * "accountId": "-",
78
+ * "vaultName": "examplevault"
79
+ * };
80
+ * const command = new GetVaultLockCommand(input);
81
+ * const response = await client.send(command);
82
+ * /* response ==
83
+ * {
84
+ * "CreationDate": "exampledate",
85
+ * "ExpirationDate": "exampledate",
86
+ * "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}",
87
+ * "State": "InProgress"
88
+ * }
89
+ * *\/
90
+ * // example id: to-retrieve-vault-lock-policy-related-attributes-that-are-set-on-a-vault-1481851363097
91
+ * ```
92
+ *
59
93
  */
60
94
  export declare class GetVaultLockCommand extends $Command<GetVaultLockCommandInput, GetVaultLockCommandOutput, GlacierClientResolvedConfig> {
61
95
  readonly input: GetVaultLockCommandInput;
@@ -44,6 +44,43 @@ 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
+ *
61
+ * @example To get the notification-configuration for the specified vault
62
+ * ```javascript
63
+ * // The example retrieves the notification-configuration for the vault named my-vault.
64
+ * const input = {
65
+ * "accountId": "-",
66
+ * "vaultName": "my-vault"
67
+ * };
68
+ * const command = new GetVaultNotificationsCommand(input);
69
+ * const response = await client.send(command);
70
+ * /* response ==
71
+ * {
72
+ * "vaultNotificationConfig": {
73
+ * "Events": [
74
+ * "InventoryRetrievalCompleted",
75
+ * "ArchiveRetrievalCompleted"
76
+ * ],
77
+ * "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-vault"
78
+ * }
79
+ * }
80
+ * *\/
81
+ * // example id: to-get-the-notification-configuration-for-the-specified-vault-1481918746677
82
+ * ```
83
+ *
47
84
  */
48
85
  export declare class GetVaultNotificationsCommand extends $Command<GetVaultNotificationsCommandInput, GetVaultNotificationsCommandOutput, GlacierClientResolvedConfig> {
49
86
  readonly input: GetVaultNotificationsCommandInput;