@aws-sdk/client-glacier 3.775.0 → 3.782.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/AbortMultipartUploadCommand.d.ts +9 -6
- package/dist-types/commands/AbortVaultLockCommand.d.ts +8 -5
- package/dist-types/commands/AddTagsToVaultCommand.d.ts +11 -8
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +11 -11
- package/dist-types/commands/CompleteVaultLockCommand.d.ts +9 -6
- package/dist-types/commands/CreateVaultCommand.d.ts +6 -6
- package/dist-types/commands/DeleteArchiveCommand.d.ts +9 -6
- package/dist-types/commands/DeleteVaultAccessPolicyCommand.d.ts +8 -5
- package/dist-types/commands/DeleteVaultCommand.d.ts +8 -5
- package/dist-types/commands/DeleteVaultNotificationsCommand.d.ts +8 -5
- package/dist-types/commands/DescribeJobCommand.d.ts +14 -14
- package/dist-types/commands/DescribeVaultCommand.d.ts +10 -10
- package/dist-types/commands/GetDataRetrievalPolicyCommand.d.ts +8 -8
- package/dist-types/commands/GetJobOutputCommand.d.ts +21 -11
- package/dist-types/commands/GetVaultAccessPolicyCommand.d.ts +7 -7
- package/dist-types/commands/GetVaultLockCommand.d.ts +9 -9
- package/dist-types/commands/GetVaultNotificationsCommand.d.ts +8 -8
- package/dist-types/commands/InitiateJobCommand.d.ts +12 -12
- package/dist-types/commands/InitiateMultipartUploadCommand.d.ts +8 -8
- package/dist-types/commands/InitiateVaultLockCommand.d.ts +8 -8
- package/dist-types/commands/ListJobsCommand.d.ts +27 -27
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +22 -22
- package/dist-types/commands/ListPartsCommand.d.ts +17 -17
- package/dist-types/commands/ListProvisionedCapacityCommand.d.ts +11 -11
- package/dist-types/commands/ListTagsForVaultCommand.d.ts +8 -8
- package/dist-types/commands/ListVaultsCommand.d.ts +1 -27
- package/dist-types/commands/PurchaseProvisionedCapacityCommand.d.ts +5 -5
- package/dist-types/commands/RemoveTagsFromVaultCommand.d.ts +9 -6
- package/dist-types/commands/SetDataRetrievalPolicyCommand.d.ts +11 -8
- package/dist-types/commands/SetVaultAccessPolicyCommand.d.ts +10 -7
- package/dist-types/commands/SetVaultNotificationsCommand.d.ts +11 -8
- package/dist-types/commands/UploadArchiveCommand.d.ts +11 -11
- package/dist-types/commands/UploadMultipartPartCommand.d.ts +10 -10
- package/package.json +5 -5
|
@@ -84,20 +84,23 @@ declare const AbortMultipartUploadCommand_base: {
|
|
|
84
84
|
* @throws {@link GlacierServiceException}
|
|
85
85
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
86
86
|
*
|
|
87
|
-
*
|
|
87
|
+
*
|
|
88
88
|
* @example To abort a multipart upload identified by the upload ID
|
|
89
89
|
* ```javascript
|
|
90
90
|
* // The example deletes an in-progress multipart upload to a vault named my-vault:
|
|
91
91
|
* const input = {
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
*
|
|
92
|
+
* accountId: "-",
|
|
93
|
+
* uploadId: "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
|
|
94
|
+
* vaultName: "my-vault"
|
|
95
95
|
* };
|
|
96
96
|
* const command = new AbortMultipartUploadCommand(input);
|
|
97
|
-
* await client.send(command);
|
|
98
|
-
*
|
|
97
|
+
* const response = await client.send(command);
|
|
98
|
+
* /* response is
|
|
99
|
+
* { /* metadata only *\/ }
|
|
100
|
+
* *\/
|
|
99
101
|
* ```
|
|
100
102
|
*
|
|
103
|
+
* @public
|
|
101
104
|
*/
|
|
102
105
|
export declare class AbortMultipartUploadCommand extends AbortMultipartUploadCommand_base {
|
|
103
106
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -79,19 +79,22 @@ declare const AbortVaultLockCommand_base: {
|
|
|
79
79
|
* @throws {@link GlacierServiceException}
|
|
80
80
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
81
81
|
*
|
|
82
|
-
*
|
|
82
|
+
*
|
|
83
83
|
* @example To abort a vault lock
|
|
84
84
|
* ```javascript
|
|
85
85
|
* // The example aborts the vault locking process if the vault lock is not in the Locked state for the vault named examplevault.
|
|
86
86
|
* const input = {
|
|
87
|
-
*
|
|
88
|
-
*
|
|
87
|
+
* accountId: "-",
|
|
88
|
+
* vaultName: "examplevault"
|
|
89
89
|
* };
|
|
90
90
|
* const command = new AbortVaultLockCommand(input);
|
|
91
|
-
* await client.send(command);
|
|
92
|
-
*
|
|
91
|
+
* const response = await client.send(command);
|
|
92
|
+
* /* response is
|
|
93
|
+
* { /* metadata only *\/ }
|
|
94
|
+
* *\/
|
|
93
95
|
* ```
|
|
94
96
|
*
|
|
97
|
+
* @public
|
|
95
98
|
*/
|
|
96
99
|
export declare class AbortVaultLockCommand extends AbortVaultLockCommand_base {
|
|
97
100
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -77,23 +77,26 @@ declare const AddTagsToVaultCommand_base: {
|
|
|
77
77
|
* @throws {@link GlacierServiceException}
|
|
78
78
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
79
79
|
*
|
|
80
|
-
*
|
|
80
|
+
*
|
|
81
81
|
* @example To add tags to a vault
|
|
82
82
|
* ```javascript
|
|
83
83
|
* // The example adds two tags to a my-vault.
|
|
84
84
|
* const input = {
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
85
|
+
* Tags: {
|
|
86
|
+
* examplekey1: "examplevalue1",
|
|
87
|
+
* examplekey2: "examplevalue2"
|
|
88
88
|
* },
|
|
89
|
-
*
|
|
90
|
-
*
|
|
89
|
+
* accountId: "-",
|
|
90
|
+
* vaultName: "my-vault"
|
|
91
91
|
* };
|
|
92
92
|
* const command = new AddTagsToVaultCommand(input);
|
|
93
|
-
* await client.send(command);
|
|
94
|
-
*
|
|
93
|
+
* const response = await client.send(command);
|
|
94
|
+
* /* response is
|
|
95
|
+
* { /* metadata only *\/ }
|
|
96
|
+
* *\/
|
|
95
97
|
* ```
|
|
96
98
|
*
|
|
99
|
+
* @public
|
|
97
100
|
*/
|
|
98
101
|
export declare class AddTagsToVaultCommand extends AddTagsToVaultCommand_base {
|
|
99
102
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -110,29 +110,29 @@ declare const CompleteMultipartUploadCommand_base: {
|
|
|
110
110
|
* @throws {@link GlacierServiceException}
|
|
111
111
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
112
112
|
*
|
|
113
|
-
*
|
|
113
|
+
*
|
|
114
114
|
* @example To complete a multipart upload
|
|
115
115
|
* ```javascript
|
|
116
116
|
* // The example completes a multipart upload for a 3 MiB archive.
|
|
117
117
|
* const input = {
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
118
|
+
* accountId: "-",
|
|
119
|
+
* archiveSize: "3145728",
|
|
120
|
+
* checksum: "9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67",
|
|
121
|
+
* uploadId: "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
|
|
122
|
+
* vaultName: "my-vault"
|
|
123
123
|
* };
|
|
124
124
|
* const command = new CompleteMultipartUploadCommand(input);
|
|
125
125
|
* const response = await client.send(command);
|
|
126
|
-
* /* response
|
|
126
|
+
* /* response is
|
|
127
127
|
* {
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
128
|
+
* archiveId: "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId",
|
|
129
|
+
* checksum: "9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67",
|
|
130
|
+
* location: "/111122223333/vaults/my-vault/archives/NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId"
|
|
131
131
|
* }
|
|
132
132
|
* *\/
|
|
133
|
-
* // example id: 272aa0b8-e44c-4a64-add2-ad905a37984d
|
|
134
133
|
* ```
|
|
135
134
|
*
|
|
135
|
+
* @public
|
|
136
136
|
*/
|
|
137
137
|
export declare class CompleteMultipartUploadCommand extends CompleteMultipartUploadCommand_base {
|
|
138
138
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -80,20 +80,23 @@ declare const CompleteVaultLockCommand_base: {
|
|
|
80
80
|
* @throws {@link GlacierServiceException}
|
|
81
81
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
82
82
|
*
|
|
83
|
-
*
|
|
83
|
+
*
|
|
84
84
|
* @example To complete a vault lock
|
|
85
85
|
* ```javascript
|
|
86
86
|
* // The example completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state.
|
|
87
87
|
* const input = {
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
88
|
+
* accountId: "-",
|
|
89
|
+
* lockId: "AE863rKkWZU53SLW5be4DUcW",
|
|
90
|
+
* vaultName: "example-vault"
|
|
91
91
|
* };
|
|
92
92
|
* const command = new CompleteVaultLockCommand(input);
|
|
93
|
-
* await client.send(command);
|
|
94
|
-
*
|
|
93
|
+
* const response = await client.send(command);
|
|
94
|
+
* /* response is
|
|
95
|
+
* { /* metadata only *\/ }
|
|
96
|
+
* *\/
|
|
95
97
|
* ```
|
|
96
98
|
*
|
|
99
|
+
* @public
|
|
97
100
|
*/
|
|
98
101
|
export declare class CompleteVaultLockCommand extends CompleteVaultLockCommand_base {
|
|
99
102
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -90,24 +90,24 @@ declare const CreateVaultCommand_base: {
|
|
|
90
90
|
* @throws {@link GlacierServiceException}
|
|
91
91
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
92
92
|
*
|
|
93
|
-
*
|
|
93
|
+
*
|
|
94
94
|
* @example To create a new vault
|
|
95
95
|
* ```javascript
|
|
96
96
|
* // The following example creates a new vault named my-vault.
|
|
97
97
|
* const input = {
|
|
98
|
-
*
|
|
99
|
-
*
|
|
98
|
+
* accountId: "-",
|
|
99
|
+
* vaultName: "my-vault"
|
|
100
100
|
* };
|
|
101
101
|
* const command = new CreateVaultCommand(input);
|
|
102
102
|
* const response = await client.send(command);
|
|
103
|
-
* /* response
|
|
103
|
+
* /* response is
|
|
104
104
|
* {
|
|
105
|
-
*
|
|
105
|
+
* location: "/111122223333/vaults/my-vault"
|
|
106
106
|
* }
|
|
107
107
|
* *\/
|
|
108
|
-
* // example id: 1dc0313d-ace1-4e6c-9d13-1ec7813b14b7
|
|
109
108
|
* ```
|
|
110
109
|
*
|
|
110
|
+
* @public
|
|
111
111
|
*/
|
|
112
112
|
export declare class CreateVaultCommand extends CreateVaultCommand_base {
|
|
113
113
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -93,20 +93,23 @@ declare const DeleteArchiveCommand_base: {
|
|
|
93
93
|
* @throws {@link GlacierServiceException}
|
|
94
94
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
95
95
|
*
|
|
96
|
-
*
|
|
96
|
+
*
|
|
97
97
|
* @example To delete an archive
|
|
98
98
|
* ```javascript
|
|
99
99
|
* // The example deletes the archive specified by the archive ID.
|
|
100
100
|
* const input = {
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
101
|
+
* accountId: "-",
|
|
102
|
+
* archiveId: "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId",
|
|
103
|
+
* vaultName: "examplevault"
|
|
104
104
|
* };
|
|
105
105
|
* const command = new DeleteArchiveCommand(input);
|
|
106
|
-
* await client.send(command);
|
|
107
|
-
*
|
|
106
|
+
* const response = await client.send(command);
|
|
107
|
+
* /* response is
|
|
108
|
+
* { /* metadata only *\/ }
|
|
109
|
+
* *\/
|
|
108
110
|
* ```
|
|
109
111
|
*
|
|
112
|
+
* @public
|
|
110
113
|
*/
|
|
111
114
|
export declare class DeleteArchiveCommand extends DeleteArchiveCommand_base {
|
|
112
115
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -72,19 +72,22 @@ declare const DeleteVaultAccessPolicyCommand_base: {
|
|
|
72
72
|
* @throws {@link GlacierServiceException}
|
|
73
73
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
74
74
|
*
|
|
75
|
-
*
|
|
75
|
+
*
|
|
76
76
|
* @example To delete the vault access policy
|
|
77
77
|
* ```javascript
|
|
78
78
|
* // The example deletes the access policy associated with the vault named examplevault.
|
|
79
79
|
* const input = {
|
|
80
|
-
*
|
|
81
|
-
*
|
|
80
|
+
* accountId: "-",
|
|
81
|
+
* vaultName: "examplevault"
|
|
82
82
|
* };
|
|
83
83
|
* const command = new DeleteVaultAccessPolicyCommand(input);
|
|
84
|
-
* await client.send(command);
|
|
85
|
-
*
|
|
84
|
+
* const response = await client.send(command);
|
|
85
|
+
* /* response is
|
|
86
|
+
* { /* metadata only *\/ }
|
|
87
|
+
* *\/
|
|
86
88
|
* ```
|
|
87
89
|
*
|
|
90
|
+
* @public
|
|
88
91
|
*/
|
|
89
92
|
export declare class DeleteVaultAccessPolicyCommand extends DeleteVaultAccessPolicyCommand_base {
|
|
90
93
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -85,19 +85,22 @@ declare const DeleteVaultCommand_base: {
|
|
|
85
85
|
* @throws {@link GlacierServiceException}
|
|
86
86
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
87
87
|
*
|
|
88
|
-
*
|
|
88
|
+
*
|
|
89
89
|
* @example To delete a vault
|
|
90
90
|
* ```javascript
|
|
91
91
|
* // The example deletes a vault named my-vault:
|
|
92
92
|
* const input = {
|
|
93
|
-
*
|
|
94
|
-
*
|
|
93
|
+
* accountId: "-",
|
|
94
|
+
* vaultName: "my-vault"
|
|
95
95
|
* };
|
|
96
96
|
* const command = new DeleteVaultCommand(input);
|
|
97
|
-
* await client.send(command);
|
|
98
|
-
*
|
|
97
|
+
* const response = await client.send(command);
|
|
98
|
+
* /* response is
|
|
99
|
+
* { /* metadata only *\/ }
|
|
100
|
+
* *\/
|
|
99
101
|
* ```
|
|
100
102
|
*
|
|
103
|
+
* @public
|
|
101
104
|
*/
|
|
102
105
|
export declare class DeleteVaultCommand extends DeleteVaultCommand_base {
|
|
103
106
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -78,19 +78,22 @@ declare const DeleteVaultNotificationsCommand_base: {
|
|
|
78
78
|
* @throws {@link GlacierServiceException}
|
|
79
79
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
80
80
|
*
|
|
81
|
-
*
|
|
81
|
+
*
|
|
82
82
|
* @example To delete the notification configuration set for a vault
|
|
83
83
|
* ```javascript
|
|
84
84
|
* // The example deletes the notification configuration set for the vault named examplevault.
|
|
85
85
|
* const input = {
|
|
86
|
-
*
|
|
87
|
-
*
|
|
86
|
+
* accountId: "-",
|
|
87
|
+
* vaultName: "examplevault"
|
|
88
88
|
* };
|
|
89
89
|
* const command = new DeleteVaultNotificationsCommand(input);
|
|
90
|
-
* await client.send(command);
|
|
91
|
-
*
|
|
90
|
+
* const response = await client.send(command);
|
|
91
|
+
* /* response is
|
|
92
|
+
* { /* metadata only *\/ }
|
|
93
|
+
* *\/
|
|
92
94
|
* ```
|
|
93
95
|
*
|
|
96
|
+
* @public
|
|
94
97
|
*/
|
|
95
98
|
export declare class DeleteVaultNotificationsCommand extends DeleteVaultNotificationsCommand_base {
|
|
96
99
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -170,33 +170,33 @@ declare const DescribeJobCommand_base: {
|
|
|
170
170
|
* @throws {@link GlacierServiceException}
|
|
171
171
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
172
172
|
*
|
|
173
|
-
*
|
|
173
|
+
*
|
|
174
174
|
* @example To get information about a previously initiated job
|
|
175
175
|
* ```javascript
|
|
176
176
|
* // The example returns information about the previously initiated job specified by the job ID.
|
|
177
177
|
* const input = {
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
*
|
|
178
|
+
* accountId: "-",
|
|
179
|
+
* jobId: "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4Cn",
|
|
180
|
+
* vaultName: "my-vault"
|
|
181
181
|
* };
|
|
182
182
|
* const command = new DescribeJobCommand(input);
|
|
183
183
|
* const response = await client.send(command);
|
|
184
|
-
* /* response
|
|
184
|
+
* /* response is
|
|
185
185
|
* {
|
|
186
|
-
*
|
|
187
|
-
*
|
|
188
|
-
*
|
|
189
|
-
*
|
|
190
|
-
*
|
|
186
|
+
* Action: "InventoryRetrieval",
|
|
187
|
+
* Completed: false,
|
|
188
|
+
* CreationDate: "2015-07-17T20:23:41.616Z",
|
|
189
|
+
* InventoryRetrievalParameters: {
|
|
190
|
+
* Format: "JSON"
|
|
191
191
|
* },
|
|
192
|
-
*
|
|
193
|
-
*
|
|
194
|
-
*
|
|
192
|
+
* JobId: "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",
|
|
193
|
+
* StatusCode: "InProgress",
|
|
194
|
+
* VaultARN: "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault"
|
|
195
195
|
* }
|
|
196
196
|
* *\/
|
|
197
|
-
* // example id: to-get-information-about-a-job-you-previously-initiated-1481840928592
|
|
198
197
|
* ```
|
|
199
198
|
*
|
|
199
|
+
* @public
|
|
200
200
|
*/
|
|
201
201
|
export declare class DescribeJobCommand extends DescribeJobCommand_base {
|
|
202
202
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -90,28 +90,28 @@ declare const DescribeVaultCommand_base: {
|
|
|
90
90
|
* @throws {@link GlacierServiceException}
|
|
91
91
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
92
92
|
*
|
|
93
|
-
*
|
|
93
|
+
*
|
|
94
94
|
* @example To retrieve information about a vault
|
|
95
95
|
* ```javascript
|
|
96
96
|
* // The example retrieves data about a vault named my-vault.
|
|
97
97
|
* const input = {
|
|
98
|
-
*
|
|
99
|
-
*
|
|
98
|
+
* accountId: "-",
|
|
99
|
+
* vaultName: "my-vault"
|
|
100
100
|
* };
|
|
101
101
|
* const command = new DescribeVaultCommand(input);
|
|
102
102
|
* const response = await client.send(command);
|
|
103
|
-
* /* response
|
|
103
|
+
* /* response is
|
|
104
104
|
* {
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
105
|
+
* CreationDate: "2016-09-23T19:27:18.665Z",
|
|
106
|
+
* NumberOfArchives: 0,
|
|
107
|
+
* SizeInBytes: 0,
|
|
108
|
+
* VaultARN: "arn:aws:glacier:us-west-2:111122223333:vaults/my-vault",
|
|
109
|
+
* VaultName: "my-vault"
|
|
110
110
|
* }
|
|
111
111
|
* *\/
|
|
112
|
-
* // example id: 3c1c6e9d-f5a2-427a-aa6a-f439eacfc05f
|
|
113
112
|
* ```
|
|
114
113
|
*
|
|
114
|
+
* @public
|
|
115
115
|
*/
|
|
116
116
|
export declare class DescribeVaultCommand extends DescribeVaultCommand_base {
|
|
117
117
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -72,30 +72,30 @@ declare const GetDataRetrievalPolicyCommand_base: {
|
|
|
72
72
|
* @throws {@link GlacierServiceException}
|
|
73
73
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
74
74
|
*
|
|
75
|
-
*
|
|
75
|
+
*
|
|
76
76
|
* @example To get the current data retrieval policy for an account
|
|
77
77
|
* ```javascript
|
|
78
78
|
* // The example returns the current data retrieval policy for the account.
|
|
79
79
|
* const input = {
|
|
80
|
-
*
|
|
80
|
+
* accountId: "-"
|
|
81
81
|
* };
|
|
82
82
|
* const command = new GetDataRetrievalPolicyCommand(input);
|
|
83
83
|
* const response = await client.send(command);
|
|
84
|
-
* /* response
|
|
84
|
+
* /* response is
|
|
85
85
|
* {
|
|
86
|
-
*
|
|
87
|
-
*
|
|
86
|
+
* Policy: {
|
|
87
|
+
* Rules: [
|
|
88
88
|
* {
|
|
89
|
-
*
|
|
90
|
-
*
|
|
89
|
+
* BytesPerHour: 10737418240,
|
|
90
|
+
* Strategy: "BytesPerHour"
|
|
91
91
|
* }
|
|
92
92
|
* ]
|
|
93
93
|
* }
|
|
94
94
|
* }
|
|
95
95
|
* *\/
|
|
96
|
-
* // example id: to-get-the-current-data-retrieval-policy-for-the-account-1481851580439
|
|
97
96
|
* ```
|
|
98
97
|
*
|
|
98
|
+
* @public
|
|
99
99
|
*/
|
|
100
100
|
export declare class GetDataRetrievalPolicyCommand extends GetDataRetrievalPolicyCommand_base {
|
|
101
101
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -79,6 +79,11 @@ declare const GetJobOutputCommand_base: {
|
|
|
79
79
|
* };
|
|
80
80
|
* const command = new GetJobOutputCommand(input);
|
|
81
81
|
* const response = await client.send(command);
|
|
82
|
+
* // consume or destroy the stream to free the socket.
|
|
83
|
+
* const bytes = await response.body.transformToByteArray();
|
|
84
|
+
* // const str = await response.body.transformToString();
|
|
85
|
+
* // response.body.destroy(); // only applicable to Node.js Readable streams.
|
|
86
|
+
*
|
|
82
87
|
* // { // GetJobOutputOutput
|
|
83
88
|
* // body: "<SdkStream>", // see \@smithy/types -> StreamingBlobPayloadOutputTypes
|
|
84
89
|
* // checksum: "STRING_VALUE",
|
|
@@ -113,29 +118,34 @@ declare const GetJobOutputCommand_base: {
|
|
|
113
118
|
* @throws {@link GlacierServiceException}
|
|
114
119
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
115
120
|
*
|
|
116
|
-
*
|
|
121
|
+
*
|
|
117
122
|
* @example To get the output of a previously initiated job
|
|
118
123
|
* ```javascript
|
|
119
124
|
* // The example downloads the output of a previously initiated inventory retrieval job that is identified by the job ID.
|
|
120
125
|
* const input = {
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
126
|
+
* accountId: "-",
|
|
127
|
+
* jobId: "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",
|
|
128
|
+
* range: "",
|
|
129
|
+
* vaultName: "my-vaul"
|
|
125
130
|
* };
|
|
126
131
|
* const command = new GetJobOutputCommand(input);
|
|
127
132
|
* const response = await client.send(command);
|
|
128
|
-
*
|
|
133
|
+
* // consume or destroy the stream to free the socket.
|
|
134
|
+
* const bytes = await response.body.transformToByteArray();
|
|
135
|
+
* // const str = await response.body.transformToString();
|
|
136
|
+
* // response.body.destroy(); // only applicable to Node.js Readable streams.
|
|
137
|
+
*
|
|
138
|
+
* /* response is
|
|
129
139
|
* {
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
140
|
+
* acceptRanges: "bytes",
|
|
141
|
+
* body: "inventory-data",
|
|
142
|
+
* contentType: "application/json",
|
|
143
|
+
* status: 200
|
|
134
144
|
* }
|
|
135
145
|
* *\/
|
|
136
|
-
* // example id: to-get-the-output-of-a-previously-initiated-job-1481848550859
|
|
137
146
|
* ```
|
|
138
147
|
*
|
|
148
|
+
* @public
|
|
139
149
|
*/
|
|
140
150
|
export declare class GetJobOutputCommand extends GetJobOutputCommand_base {
|
|
141
151
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -75,26 +75,26 @@ declare const GetVaultAccessPolicyCommand_base: {
|
|
|
75
75
|
* @throws {@link GlacierServiceException}
|
|
76
76
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
77
77
|
*
|
|
78
|
-
*
|
|
78
|
+
*
|
|
79
79
|
* @example To get the access-policy set on the vault
|
|
80
80
|
* ```javascript
|
|
81
81
|
* // The example retrieves the access-policy set on the vault named example-vault.
|
|
82
82
|
* const input = {
|
|
83
|
-
*
|
|
84
|
-
*
|
|
83
|
+
* accountId: "-",
|
|
84
|
+
* vaultName: "example-vault"
|
|
85
85
|
* };
|
|
86
86
|
* const command = new GetVaultAccessPolicyCommand(input);
|
|
87
87
|
* const response = await client.send(command);
|
|
88
|
-
* /* response
|
|
88
|
+
* /* response is
|
|
89
89
|
* {
|
|
90
|
-
*
|
|
91
|
-
*
|
|
90
|
+
* policy: {
|
|
91
|
+
* 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"}]}`
|
|
92
92
|
* }
|
|
93
93
|
* }
|
|
94
94
|
* *\/
|
|
95
|
-
* // example id: to--get-the-access-policy-set-on-the-vault-1481936004590
|
|
96
95
|
* ```
|
|
97
96
|
*
|
|
97
|
+
* @public
|
|
98
98
|
*/
|
|
99
99
|
export declare class GetVaultAccessPolicyCommand extends GetVaultAccessPolicyCommand_base {
|
|
100
100
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -98,27 +98,27 @@ declare const GetVaultLockCommand_base: {
|
|
|
98
98
|
* @throws {@link GlacierServiceException}
|
|
99
99
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
100
100
|
*
|
|
101
|
-
*
|
|
101
|
+
*
|
|
102
102
|
* @example To retrieve vault lock-policy related attributes that are set on a vault
|
|
103
103
|
* ```javascript
|
|
104
104
|
* // The example retrieves the attributes from the lock-policy subresource set on the vault named examplevault.
|
|
105
105
|
* const input = {
|
|
106
|
-
*
|
|
107
|
-
*
|
|
106
|
+
* accountId: "-",
|
|
107
|
+
* vaultName: "examplevault"
|
|
108
108
|
* };
|
|
109
109
|
* const command = new GetVaultLockCommand(input);
|
|
110
110
|
* const response = await client.send(command);
|
|
111
|
-
* /* response
|
|
111
|
+
* /* response is
|
|
112
112
|
* {
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
113
|
+
* CreationDate: "exampledate",
|
|
114
|
+
* ExpirationDate: "exampledate",
|
|
115
|
+
* 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"}}}]}`,
|
|
116
|
+
* State: "InProgress"
|
|
117
117
|
* }
|
|
118
118
|
* *\/
|
|
119
|
-
* // example id: to-retrieve-vault-lock-policy-related-attributes-that-are-set-on-a-vault-1481851363097
|
|
120
119
|
* ```
|
|
121
120
|
*
|
|
121
|
+
* @public
|
|
122
122
|
*/
|
|
123
123
|
export declare class GetVaultLockCommand extends GetVaultLockCommand_base {
|
|
124
124
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -88,30 +88,30 @@ declare const GetVaultNotificationsCommand_base: {
|
|
|
88
88
|
* @throws {@link GlacierServiceException}
|
|
89
89
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
90
90
|
*
|
|
91
|
-
*
|
|
91
|
+
*
|
|
92
92
|
* @example To get the notification-configuration for the specified vault
|
|
93
93
|
* ```javascript
|
|
94
94
|
* // The example retrieves the notification-configuration for the vault named my-vault.
|
|
95
95
|
* const input = {
|
|
96
|
-
*
|
|
97
|
-
*
|
|
96
|
+
* accountId: "-",
|
|
97
|
+
* vaultName: "my-vault"
|
|
98
98
|
* };
|
|
99
99
|
* const command = new GetVaultNotificationsCommand(input);
|
|
100
100
|
* const response = await client.send(command);
|
|
101
|
-
* /* response
|
|
101
|
+
* /* response is
|
|
102
102
|
* {
|
|
103
|
-
*
|
|
104
|
-
*
|
|
103
|
+
* vaultNotificationConfig: {
|
|
104
|
+
* Events: [
|
|
105
105
|
* "InventoryRetrievalCompleted",
|
|
106
106
|
* "ArchiveRetrievalCompleted"
|
|
107
107
|
* ],
|
|
108
|
-
*
|
|
108
|
+
* SNSTopic: "arn:aws:sns:us-west-2:0123456789012:my-vault"
|
|
109
109
|
* }
|
|
110
110
|
* }
|
|
111
111
|
* *\/
|
|
112
|
-
* // example id: to-get-the-notification-configuration-for-the-specified-vault-1481918746677
|
|
113
112
|
* ```
|
|
114
113
|
*
|
|
114
|
+
* @public
|
|
115
115
|
*/
|
|
116
116
|
export declare class GetVaultNotificationsCommand extends GetVaultNotificationsCommand_base {
|
|
117
117
|
/** @internal type navigation helper, not in runtime. */
|