@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.
- package/dist-types/commands/AbortMultipartUploadCommand.d.ts +27 -0
- package/dist-types/commands/AbortVaultLockCommand.d.ts +26 -0
- package/dist-types/commands/AddTagsToVaultCommand.d.ts +33 -0
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +36 -0
- package/dist-types/commands/CompleteVaultLockCommand.d.ts +27 -0
- package/dist-types/commands/CreateVaultCommand.d.ts +30 -0
- package/dist-types/commands/DeleteArchiveCommand.d.ts +27 -0
- package/dist-types/commands/DeleteVaultAccessPolicyCommand.d.ts +26 -0
- package/dist-types/commands/DeleteVaultCommand.d.ts +26 -0
- package/dist-types/commands/DeleteVaultNotificationsCommand.d.ts +26 -0
- package/dist-types/commands/DescribeJobCommand.d.ts +40 -0
- package/dist-types/commands/DescribeVaultCommand.d.ts +35 -0
- package/dist-types/commands/GetDataRetrievalPolicyCommand.d.ts +33 -0
- package/dist-types/commands/GetJobOutputCommand.d.ts +36 -0
- package/dist-types/commands/GetVaultAccessPolicyCommand.d.ts +33 -0
- package/dist-types/commands/GetVaultLockCommand.d.ts +34 -0
- package/dist-types/commands/GetVaultNotificationsCommand.d.ts +37 -0
- package/dist-types/commands/InitiateJobCommand.d.ts +47 -0
- package/dist-types/commands/InitiateMultipartUploadCommand.d.ts +33 -0
- package/dist-types/commands/InitiateVaultLockCommand.d.ts +34 -0
- package/dist-types/commands/ListJobsCommand.d.ts +58 -0
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +54 -0
- package/dist-types/commands/ListPartsCommand.d.ts +47 -0
- package/dist-types/commands/ListProvisionedCapacityCommand.d.ts +37 -0
- package/dist-types/commands/ListTagsForVaultCommand.d.ts +34 -0
- package/dist-types/commands/ListVaultsCommand.d.ts +41 -0
- package/dist-types/commands/PurchaseProvisionedCapacityCommand.d.ts +29 -0
- package/dist-types/commands/RemoveTagsFromVaultCommand.d.ts +30 -0
- package/dist-types/commands/SetDataRetrievalPolicyCommand.d.ts +29 -0
- package/dist-types/commands/SetVaultAccessPolicyCommand.d.ts +29 -0
- package/dist-types/commands/SetVaultNotificationsCommand.d.ts +33 -0
- package/dist-types/commands/UploadArchiveCommand.d.ts +40 -0
- package/dist-types/commands/UploadMultipartPartCommand.d.ts +39 -0
- package/package.json +35 -35
|
@@ -33,6 +33,53 @@ 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
|
+
*
|
|
59
|
+
* @example To initiate an inventory-retrieval job
|
|
60
|
+
* ```javascript
|
|
61
|
+
* // The example initiates an inventory-retrieval job for the vault named examplevault.
|
|
62
|
+
* const input = {
|
|
63
|
+
* "accountId": "-",
|
|
64
|
+
* "jobParameters": {
|
|
65
|
+
* "Description": "My inventory job",
|
|
66
|
+
* "Format": "CSV",
|
|
67
|
+
* "SNSTopic": "arn:aws:sns:us-west-2:111111111111:Glacier-InventoryRetrieval-topic-Example",
|
|
68
|
+
* "Type": "inventory-retrieval"
|
|
69
|
+
* },
|
|
70
|
+
* "vaultName": "examplevault"
|
|
71
|
+
* };
|
|
72
|
+
* const command = new InitiateJobCommand(input);
|
|
73
|
+
* const response = await client.send(command);
|
|
74
|
+
* /* response ==
|
|
75
|
+
* {
|
|
76
|
+
* "jobId": " HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID",
|
|
77
|
+
* "location": "/111122223333/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID"
|
|
78
|
+
* }
|
|
79
|
+
* *\/
|
|
80
|
+
* // example id: to-initiate-an-inventory-retrieval-job-1482186883826
|
|
81
|
+
* ```
|
|
82
|
+
*
|
|
36
83
|
*/
|
|
37
84
|
export declare class InitiateJobCommand extends $Command<InitiateJobCommandInput, InitiateJobCommandOutput, GlacierClientResolvedConfig> {
|
|
38
85
|
readonly input: InitiateJobCommandInput;
|
|
@@ -62,6 +62,39 @@ 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
|
+
*
|
|
79
|
+
* @example To initiate a multipart upload
|
|
80
|
+
* ```javascript
|
|
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.
|
|
82
|
+
* const input = {
|
|
83
|
+
* "accountId": "-",
|
|
84
|
+
* "partSize": "1048576",
|
|
85
|
+
* "vaultName": "my-vault"
|
|
86
|
+
* };
|
|
87
|
+
* const command = new InitiateMultipartUploadCommand(input);
|
|
88
|
+
* const response = await client.send(command);
|
|
89
|
+
* /* response ==
|
|
90
|
+
* {
|
|
91
|
+
* "location": "/111122223333/vaults/my-vault/multipart-uploads/19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
|
|
92
|
+
* "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ"
|
|
93
|
+
* }
|
|
94
|
+
* *\/
|
|
95
|
+
* // example id: 72f2db19-3d93-4c74-b2ed-38703baacf49
|
|
96
|
+
* ```
|
|
97
|
+
*
|
|
65
98
|
*/
|
|
66
99
|
export declare class InitiateMultipartUploadCommand extends $Command<InitiateMultipartUploadCommandInput, InitiateMultipartUploadCommandOutput, GlacierClientResolvedConfig> {
|
|
67
100
|
readonly input: InitiateMultipartUploadCommandInput;
|
|
@@ -63,6 +63,40 @@ 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
|
+
*
|
|
80
|
+
* @example To initiate the vault locking process
|
|
81
|
+
* ```javascript
|
|
82
|
+
* // The example initiates the vault locking process for the vault named my-vault.
|
|
83
|
+
* const input = {
|
|
84
|
+
* "accountId": "-",
|
|
85
|
+
* "policy": {
|
|
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
|
+
* },
|
|
88
|
+
* "vaultName": "my-vault"
|
|
89
|
+
* };
|
|
90
|
+
* const command = new InitiateVaultLockCommand(input);
|
|
91
|
+
* const response = await client.send(command);
|
|
92
|
+
* /* response ==
|
|
93
|
+
* {
|
|
94
|
+
* "lockId": "AE863rKkWZU53SLW5be4DUcW"
|
|
95
|
+
* }
|
|
96
|
+
* *\/
|
|
97
|
+
* // example id: to-initiate-the-vault-locking-process-1481919693394
|
|
98
|
+
* ```
|
|
99
|
+
*
|
|
66
100
|
*/
|
|
67
101
|
export declare class InitiateVaultLockCommand extends $Command<InitiateVaultLockCommandInput, InitiateVaultLockCommandOutput, GlacierClientResolvedConfig> {
|
|
68
102
|
readonly input: InitiateVaultLockCommandInput;
|
|
@@ -64,6 +64,64 @@ 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
|
+
*
|
|
81
|
+
* @example To list jobs for a vault
|
|
82
|
+
* ```javascript
|
|
83
|
+
* // The example lists jobs for the vault named my-vault.
|
|
84
|
+
* const input = {
|
|
85
|
+
* "accountId": "-",
|
|
86
|
+
* "vaultName": "my-vault"
|
|
87
|
+
* };
|
|
88
|
+
* const command = new ListJobsCommand(input);
|
|
89
|
+
* const response = await client.send(command);
|
|
90
|
+
* /* response ==
|
|
91
|
+
* {
|
|
92
|
+
* "JobList": [
|
|
93
|
+
* {
|
|
94
|
+
* "Action": "ArchiveRetrieval",
|
|
95
|
+
* "ArchiveId": "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw",
|
|
96
|
+
* "ArchiveSHA256TreeHash": "9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67",
|
|
97
|
+
* "ArchiveSizeInBytes": 3145728,
|
|
98
|
+
* "Completed": false,
|
|
99
|
+
* "CreationDate": "2015-07-17T21:16:13.840Z",
|
|
100
|
+
* "JobDescription": "Retrieve archive on 2015-07-17",
|
|
101
|
+
* "JobId": "l7IL5-EkXyEY9Ws95fClzIbk2O5uLYaFdAYOi-azsX_Z8V6NH4yERHzars8wTKYQMX6nBDI9cMNHzyZJO59-8N9aHWav",
|
|
102
|
+
* "RetrievalByteRange": "0-3145727",
|
|
103
|
+
* "SHA256TreeHash": "9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67",
|
|
104
|
+
* "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-vault",
|
|
105
|
+
* "StatusCode": "InProgress",
|
|
106
|
+
* "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault"
|
|
107
|
+
* },
|
|
108
|
+
* {
|
|
109
|
+
* "Action": "InventoryRetrieval",
|
|
110
|
+
* "Completed": false,
|
|
111
|
+
* "CreationDate": "2015-07-17T20:23:41.616Z",
|
|
112
|
+
* "InventoryRetrievalParameters": {
|
|
113
|
+
* "Format": "JSON"
|
|
114
|
+
* },
|
|
115
|
+
* "JobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",
|
|
116
|
+
* "StatusCode": "InProgress",
|
|
117
|
+
* "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault"
|
|
118
|
+
* }
|
|
119
|
+
* ]
|
|
120
|
+
* }
|
|
121
|
+
* *\/
|
|
122
|
+
* // example id: to-list-jobs-for-a-vault-1481920530537
|
|
123
|
+
* ```
|
|
124
|
+
*
|
|
67
125
|
*/
|
|
68
126
|
export declare class ListJobsCommand extends $Command<ListJobsCommandInput, ListJobsCommandOutput, GlacierClientResolvedConfig> {
|
|
69
127
|
readonly input: ListJobsCommandInput;
|
|
@@ -54,6 +54,60 @@ 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
|
+
*
|
|
71
|
+
* @example To list all the in-progress multipart uploads for a vault
|
|
72
|
+
* ```javascript
|
|
73
|
+
* // The example lists all the in-progress multipart uploads for the vault named examplevault.
|
|
74
|
+
* const input = {
|
|
75
|
+
* "accountId": "-",
|
|
76
|
+
* "vaultName": "examplevault"
|
|
77
|
+
* };
|
|
78
|
+
* const command = new ListMultipartUploadsCommand(input);
|
|
79
|
+
* const response = await client.send(command);
|
|
80
|
+
* /* response ==
|
|
81
|
+
* {
|
|
82
|
+
* "Marker": "null",
|
|
83
|
+
* "UploadsList": [
|
|
84
|
+
* {
|
|
85
|
+
* "ArchiveDescription": "archive 1",
|
|
86
|
+
* "CreationDate": "2012-03-19T23:20:59.130Z",
|
|
87
|
+
* "MultipartUploadId": "xsQdFIRsfJr20CW2AbZBKpRZAFTZSJIMtL2hYf8mvp8dM0m4RUzlaqoEye6g3h3ecqB_zqwB7zLDMeSWhwo65re4C4Ev",
|
|
88
|
+
* "PartSizeInBytes": 4194304,
|
|
89
|
+
* "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
|
|
90
|
+
* },
|
|
91
|
+
* {
|
|
92
|
+
* "ArchiveDescription": "archive 2",
|
|
93
|
+
* "CreationDate": "2012-04-01T15:00:00.000Z",
|
|
94
|
+
* "MultipartUploadId": "nPyGOnyFcx67qqX7E-0tSGiRi88hHMOwOxR-_jNyM6RjVMFfV29lFqZ3rNsSaWBugg6OP92pRtufeHdQH7ClIpSF6uJc",
|
|
95
|
+
* "PartSizeInBytes": 4194304,
|
|
96
|
+
* "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
|
|
97
|
+
* },
|
|
98
|
+
* {
|
|
99
|
+
* "ArchiveDescription": "archive 3",
|
|
100
|
+
* "CreationDate": "2012-03-20T17:03:43.221Z",
|
|
101
|
+
* "MultipartUploadId": "qt-RBst_7yO8gVIonIBsAxr2t-db0pE4s8MNeGjKjGdNpuU-cdSAcqG62guwV9r5jh5mLyFPzFEitTpNE7iQfHiu1XoV",
|
|
102
|
+
* "PartSizeInBytes": 4194304,
|
|
103
|
+
* "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
|
|
104
|
+
* }
|
|
105
|
+
* ]
|
|
106
|
+
* }
|
|
107
|
+
* *\/
|
|
108
|
+
* // example id: to-list-all-the-in-progress-multipart-uploads-for-a-vault-1481935250590
|
|
109
|
+
* ```
|
|
110
|
+
*
|
|
57
111
|
*/
|
|
58
112
|
export declare class ListMultipartUploadsCommand extends $Command<ListMultipartUploadsCommandInput, ListMultipartUploadsCommandOutput, GlacierClientResolvedConfig> {
|
|
59
113
|
readonly input: ListMultipartUploadsCommandInput;
|
|
@@ -50,6 +50,53 @@ 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
|
+
*
|
|
67
|
+
* @example To list the parts of an archive that have been uploaded in a multipart upload
|
|
68
|
+
* ```javascript
|
|
69
|
+
* // The example lists all the parts of a multipart upload.
|
|
70
|
+
* const input = {
|
|
71
|
+
* "accountId": "-",
|
|
72
|
+
* "uploadId": "OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE",
|
|
73
|
+
* "vaultName": "examplevault"
|
|
74
|
+
* };
|
|
75
|
+
* const command = new ListPartsCommand(input);
|
|
76
|
+
* const response = await client.send(command);
|
|
77
|
+
* /* response ==
|
|
78
|
+
* {
|
|
79
|
+
* "ArchiveDescription": "archive description",
|
|
80
|
+
* "CreationDate": "2012-03-20T17:03:43.221Z",
|
|
81
|
+
* "Marker": "null",
|
|
82
|
+
* "MultipartUploadId": "OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE",
|
|
83
|
+
* "PartSizeInBytes": 4194304,
|
|
84
|
+
* "Parts": [
|
|
85
|
+
* {
|
|
86
|
+
* "RangeInBytes": "0-4194303",
|
|
87
|
+
* "SHA256TreeHash": "01d34dabf7be316472c93b1ef80721f5d4"
|
|
88
|
+
* },
|
|
89
|
+
* {
|
|
90
|
+
* "RangeInBytes": "4194304-8388607",
|
|
91
|
+
* "SHA256TreeHash": "0195875365afda349fc21c84c099987164"
|
|
92
|
+
* }
|
|
93
|
+
* ],
|
|
94
|
+
* "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/demo1-vault"
|
|
95
|
+
* }
|
|
96
|
+
* *\/
|
|
97
|
+
* // example id: to-list-the-parts-of-an-archive-that-have-been-uploaded-in-a-multipart-upload-1481921767590
|
|
98
|
+
* ```
|
|
99
|
+
*
|
|
53
100
|
*/
|
|
54
101
|
export declare class ListPartsCommand extends $Command<ListPartsCommandInput, ListPartsCommandOutput, GlacierClientResolvedConfig> {
|
|
55
102
|
readonly input: ListPartsCommandInput;
|
|
@@ -30,6 +30,43 @@ 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
|
+
*
|
|
43
|
+
* @example To list the provisioned capacity units for an account
|
|
44
|
+
* ```javascript
|
|
45
|
+
* // The example lists the provisioned capacity units for an account.
|
|
46
|
+
* const input = {
|
|
47
|
+
* "accountId": "-"
|
|
48
|
+
* };
|
|
49
|
+
* const command = new ListProvisionedCapacityCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* /* response ==
|
|
52
|
+
* {
|
|
53
|
+
* "ProvisionedCapacityList": [
|
|
54
|
+
* {
|
|
55
|
+
* "CapacityId": "zSaq7NzHFQDANTfQkDen4V7z",
|
|
56
|
+
* "ExpirationDate": "2016-12-12T00:00:00.000Z",
|
|
57
|
+
* "StartDate": "2016-11-11T20:11:51.095Z"
|
|
58
|
+
* },
|
|
59
|
+
* {
|
|
60
|
+
* "CapacityId": "yXaq7NzHFQNADTfQkDen4V7z",
|
|
61
|
+
* "ExpirationDate": "2017-01-15T00:00:00.000Z",
|
|
62
|
+
* "StartDate": "2016-12-13T20:11:51.095Z"
|
|
63
|
+
* }
|
|
64
|
+
* ]
|
|
65
|
+
* }
|
|
66
|
+
* *\/
|
|
67
|
+
* // example id: to-list-the-provisioned-capacity-units-for-an-account-1481923656130
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
33
70
|
*/
|
|
34
71
|
export declare class ListProvisionedCapacityCommand extends $Command<ListProvisionedCapacityCommandInput, ListProvisionedCapacityCommandOutput, GlacierClientResolvedConfig> {
|
|
35
72
|
readonly input: ListProvisionedCapacityCommandInput;
|
|
@@ -31,6 +31,40 @@ 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
|
+
*
|
|
48
|
+
* @example To list the tags for a vault
|
|
49
|
+
* ```javascript
|
|
50
|
+
* // The example lists all the tags attached to the vault examplevault.
|
|
51
|
+
* const input = {
|
|
52
|
+
* "accountId": "-",
|
|
53
|
+
* "vaultName": "examplevault"
|
|
54
|
+
* };
|
|
55
|
+
* const command = new ListTagsForVaultCommand(input);
|
|
56
|
+
* const response = await client.send(command);
|
|
57
|
+
* /* response ==
|
|
58
|
+
* {
|
|
59
|
+
* "Tags": {
|
|
60
|
+
* "date": "july2015",
|
|
61
|
+
* "id": "1234"
|
|
62
|
+
* }
|
|
63
|
+
* }
|
|
64
|
+
* *\/
|
|
65
|
+
* // example id: list-tags-for-vault-1481755839720
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
34
68
|
*/
|
|
35
69
|
export declare class ListTagsForVaultCommand extends $Command<ListTagsForVaultCommandInput, ListTagsForVaultCommandOutput, GlacierClientResolvedConfig> {
|
|
36
70
|
readonly input: ListTagsForVaultCommandInput;
|
|
@@ -47,6 +47,47 @@ 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
|
+
*
|
|
64
|
+
* @example To list all vaults owned by the calling user's account
|
|
65
|
+
* ```javascript
|
|
66
|
+
* // The example lists all vaults owned by the specified AWS account.
|
|
67
|
+
* const input = {
|
|
68
|
+
* "accountId": "-",
|
|
69
|
+
* "limit": "",
|
|
70
|
+
* "marker": ""
|
|
71
|
+
* };
|
|
72
|
+
* const command = new ListVaultsCommand(input);
|
|
73
|
+
* const response = await client.send(command);
|
|
74
|
+
* /* response ==
|
|
75
|
+
* {
|
|
76
|
+
* "VaultList": [
|
|
77
|
+
* {
|
|
78
|
+
* "CreationDate": "2015-04-06T21:23:45.708Z",
|
|
79
|
+
* "LastInventoryDate": "2015-04-07T00:26:19.028Z",
|
|
80
|
+
* "NumberOfArchives": 1,
|
|
81
|
+
* "SizeInBytes": 3178496,
|
|
82
|
+
* "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault",
|
|
83
|
+
* "VaultName": "my-vault"
|
|
84
|
+
* }
|
|
85
|
+
* ]
|
|
86
|
+
* }
|
|
87
|
+
* *\/
|
|
88
|
+
* // example id: list-vaults-1481753006990
|
|
89
|
+
* ```
|
|
90
|
+
*
|
|
50
91
|
*/
|
|
51
92
|
export declare class ListVaultsCommand extends $Command<ListVaultsCommandInput, ListVaultsCommandOutput, GlacierClientResolvedConfig> {
|
|
52
93
|
readonly input: ListVaultsCommandInput;
|
|
@@ -29,6 +29,35 @@ 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
|
+
*
|
|
45
|
+
* @example To purchases a provisioned capacity unit for an AWS account
|
|
46
|
+
* ```javascript
|
|
47
|
+
* // The example purchases provisioned capacity unit for an AWS account.
|
|
48
|
+
* const input = {
|
|
49
|
+
* "accountId": "-"
|
|
50
|
+
* };
|
|
51
|
+
* const command = new PurchaseProvisionedCapacityCommand(input);
|
|
52
|
+
* const response = await client.send(command);
|
|
53
|
+
* /* response ==
|
|
54
|
+
* {
|
|
55
|
+
* "capacityId": "zSaq7NzHFQDANTfQkDen4V7z"
|
|
56
|
+
* }
|
|
57
|
+
* *\/
|
|
58
|
+
* // example id: to-purchases-a-provisioned-capacity-unit-for-an-aws-account-1481927446662
|
|
59
|
+
* ```
|
|
60
|
+
*
|
|
32
61
|
*/
|
|
33
62
|
export declare class PurchaseProvisionedCapacityCommand extends $Command<PurchaseProvisionedCapacityCommandInput, PurchaseProvisionedCapacityCommandOutput, GlacierClientResolvedConfig> {
|
|
34
63
|
readonly input: PurchaseProvisionedCapacityCommandInput;
|
|
@@ -32,6 +32,36 @@ 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
|
+
*
|
|
49
|
+
* @example To remove tags from a vault
|
|
50
|
+
* ```javascript
|
|
51
|
+
* // The example removes two tags from the vault named examplevault.
|
|
52
|
+
* const input = {
|
|
53
|
+
* "TagKeys": [
|
|
54
|
+
* "examplekey1",
|
|
55
|
+
* "examplekey2"
|
|
56
|
+
* ],
|
|
57
|
+
* "accountId": "-",
|
|
58
|
+
* "vaultName": "examplevault"
|
|
59
|
+
* };
|
|
60
|
+
* const command = new RemoveTagsFromVaultCommand(input);
|
|
61
|
+
* await client.send(command);
|
|
62
|
+
* // example id: remove-tags-from-vault-1481754998801
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
35
65
|
*/
|
|
36
66
|
export declare class RemoveTagsFromVaultCommand extends $Command<RemoveTagsFromVaultCommandInput, RemoveTagsFromVaultCommandOutput, GlacierClientResolvedConfig> {
|
|
37
67
|
readonly input: RemoveTagsFromVaultCommandInput;
|
|
@@ -34,6 +34,35 @@ 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
|
+
*
|
|
47
|
+
* @example To set and then enact a data retrieval policy
|
|
48
|
+
* ```javascript
|
|
49
|
+
* // The example sets and then enacts a data retrieval policy.
|
|
50
|
+
* const input = {
|
|
51
|
+
* "Policy": {
|
|
52
|
+
* "Rules": [
|
|
53
|
+
* {
|
|
54
|
+
* "BytesPerHour": 10737418240,
|
|
55
|
+
* "Strategy": "BytesPerHour"
|
|
56
|
+
* }
|
|
57
|
+
* ]
|
|
58
|
+
* },
|
|
59
|
+
* "accountId": "-"
|
|
60
|
+
* };
|
|
61
|
+
* const command = new SetDataRetrievalPolicyCommand(input);
|
|
62
|
+
* await client.send(command);
|
|
63
|
+
* // example id: to-set-and-then-enact-a-data-retrieval-policy--1481928352408
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
37
66
|
*/
|
|
38
67
|
export declare class SetDataRetrievalPolicyCommand extends $Command<SetDataRetrievalPolicyCommandInput, SetDataRetrievalPolicyCommandOutput, GlacierClientResolvedConfig> {
|
|
39
68
|
readonly input: SetDataRetrievalPolicyCommandInput;
|
|
@@ -34,6 +34,35 @@ 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
|
+
*
|
|
51
|
+
* @example To set the access-policy on a vault
|
|
52
|
+
* ```javascript
|
|
53
|
+
* // The example configures an access policy for the vault named examplevault.
|
|
54
|
+
* const input = {
|
|
55
|
+
* "accountId": "-",
|
|
56
|
+
* "policy": {
|
|
57
|
+
* "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\"}]}"
|
|
58
|
+
* },
|
|
59
|
+
* "vaultName": "examplevault"
|
|
60
|
+
* };
|
|
61
|
+
* const command = new SetVaultAccessPolicyCommand(input);
|
|
62
|
+
* await client.send(command);
|
|
63
|
+
* // example id: to--set-the-access-policy-on-a-vault-1482185872517
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
37
66
|
*/
|
|
38
67
|
export declare class SetVaultAccessPolicyCommand extends $Command<SetVaultAccessPolicyCommandInput, SetVaultAccessPolicyCommandOutput, GlacierClientResolvedConfig> {
|
|
39
68
|
readonly input: SetVaultAccessPolicyCommandInput;
|
|
@@ -66,6 +66,39 @@ 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
|
+
*
|
|
83
|
+
* @example To configure a vault to post a message to an Amazon SNS topic when jobs complete
|
|
84
|
+
* ```javascript
|
|
85
|
+
* // The example sets the examplevault notification configuration.
|
|
86
|
+
* const input = {
|
|
87
|
+
* "accountId": "-",
|
|
88
|
+
* "vaultName": "examplevault",
|
|
89
|
+
* "vaultNotificationConfig": {
|
|
90
|
+
* "Events": [
|
|
91
|
+
* "ArchiveRetrievalCompleted",
|
|
92
|
+
* "InventoryRetrievalCompleted"
|
|
93
|
+
* ],
|
|
94
|
+
* "SNSTopic": "arn:aws:sns:us-west-2:012345678901:mytopic"
|
|
95
|
+
* }
|
|
96
|
+
* };
|
|
97
|
+
* const command = new SetVaultNotificationsCommand(input);
|
|
98
|
+
* await client.send(command);
|
|
99
|
+
* // example id: to-configure-a-vault-to-post-a-message-to-an-amazon-simple-notification-service-amazon-sns-topic-when-jobs-complete-1482186397475
|
|
100
|
+
* ```
|
|
101
|
+
*
|
|
69
102
|
*/
|
|
70
103
|
export declare class SetVaultNotificationsCommand extends $Command<SetVaultNotificationsCommandInput, SetVaultNotificationsCommandOutput, GlacierClientResolvedConfig> {
|
|
71
104
|
readonly input: SetVaultNotificationsCommandInput;
|