@aws-sdk/client-glacier 3.321.1 → 3.326.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 +4 -0
- package/dist-types/commands/AbortVaultLockCommand.d.ts +4 -0
- package/dist-types/commands/AddTagsToVaultCommand.d.ts +4 -0
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +8 -0
- package/dist-types/commands/CompleteVaultLockCommand.d.ts +4 -0
- package/dist-types/commands/CreateVaultCommand.d.ts +6 -0
- package/dist-types/commands/DeleteArchiveCommand.d.ts +4 -0
- package/dist-types/commands/DeleteVaultAccessPolicyCommand.d.ts +4 -0
- package/dist-types/commands/DeleteVaultCommand.d.ts +4 -0
- package/dist-types/commands/DeleteVaultNotificationsCommand.d.ts +4 -0
- package/dist-types/commands/DescribeJobCommand.d.ts +84 -0
- package/dist-types/commands/DescribeVaultCommand.d.ts +11 -0
- package/dist-types/commands/GetDataRetrievalPolicyCommand.d.ts +13 -0
- package/dist-types/commands/GetJobOutputCommand.d.ts +12 -0
- package/dist-types/commands/GetVaultAccessPolicyCommand.d.ts +8 -0
- package/dist-types/commands/GetVaultLockCommand.d.ts +9 -0
- package/dist-types/commands/GetVaultNotificationsCommand.d.ts +11 -0
- package/dist-types/commands/InitiateJobCommand.d.ts +8 -0
- package/dist-types/commands/InitiateMultipartUploadCommand.d.ts +7 -0
- package/dist-types/commands/InitiateVaultLockCommand.d.ts +6 -0
- package/dist-types/commands/ListJobsCommand.d.ts +89 -0
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +15 -0
- package/dist-types/commands/ListPartsCommand.d.ts +17 -0
- package/dist-types/commands/ListProvisionedCapacityCommand.d.ts +12 -0
- package/dist-types/commands/ListTagsForVaultCommand.d.ts +8 -0
- package/dist-types/commands/ListVaultsCommand.d.ts +16 -0
- package/dist-types/commands/PurchaseProvisionedCapacityCommand.d.ts +6 -0
- package/dist-types/commands/RemoveTagsFromVaultCommand.d.ts +4 -0
- package/dist-types/commands/SetDataRetrievalPolicyCommand.d.ts +4 -0
- package/dist-types/commands/SetVaultAccessPolicyCommand.d.ts +4 -0
- package/dist-types/commands/SetVaultNotificationsCommand.d.ts +4 -0
- package/dist-types/commands/UploadArchiveCommand.d.ts +8 -0
- package/dist-types/commands/UploadMultipartPartCommand.d.ts +6 -0
- package/package.json +17 -17
|
@@ -50,6 +50,8 @@ export interface AbortMultipartUploadCommandOutput extends __MetadataBearer {
|
|
|
50
50
|
* };
|
|
51
51
|
* const command = new AbortMultipartUploadCommand(input);
|
|
52
52
|
* const response = await client.send(command);
|
|
53
|
+
* // {};
|
|
54
|
+
*
|
|
53
55
|
* ```
|
|
54
56
|
*
|
|
55
57
|
* @param AbortMultipartUploadCommandInput - {@link AbortMultipartUploadCommandInput}
|
|
@@ -71,6 +73,8 @@ export interface AbortMultipartUploadCommandOutput extends __MetadataBearer {
|
|
|
71
73
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
72
74
|
* <p>Returned if the service cannot complete the request.</p>
|
|
73
75
|
*
|
|
76
|
+
* @throws {@link GlacierServiceException}
|
|
77
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
74
78
|
*
|
|
75
79
|
* @example To abort a multipart upload identified by the upload ID
|
|
76
80
|
* ```javascript
|
|
@@ -45,6 +45,8 @@ export interface AbortVaultLockCommandOutput extends __MetadataBearer {
|
|
|
45
45
|
* };
|
|
46
46
|
* const command = new AbortVaultLockCommand(input);
|
|
47
47
|
* const response = await client.send(command);
|
|
48
|
+
* // {};
|
|
49
|
+
*
|
|
48
50
|
* ```
|
|
49
51
|
*
|
|
50
52
|
* @param AbortVaultLockCommandInput - {@link AbortVaultLockCommandInput}
|
|
@@ -66,6 +68,8 @@ export interface AbortVaultLockCommandOutput extends __MetadataBearer {
|
|
|
66
68
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
67
69
|
* <p>Returned if the service cannot complete the request.</p>
|
|
68
70
|
*
|
|
71
|
+
* @throws {@link GlacierServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
69
73
|
*
|
|
70
74
|
* @example To abort a vault lock
|
|
71
75
|
* ```javascript
|
|
@@ -40,6 +40,8 @@ export interface AddTagsToVaultCommandOutput extends __MetadataBearer {
|
|
|
40
40
|
* };
|
|
41
41
|
* const command = new AddTagsToVaultCommand(input);
|
|
42
42
|
* const response = await client.send(command);
|
|
43
|
+
* // {};
|
|
44
|
+
*
|
|
43
45
|
* ```
|
|
44
46
|
*
|
|
45
47
|
* @param AddTagsToVaultCommandInput - {@link AddTagsToVaultCommandInput}
|
|
@@ -64,6 +66,8 @@ export interface AddTagsToVaultCommandOutput extends __MetadataBearer {
|
|
|
64
66
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
65
67
|
* <p>Returned if the service cannot complete the request.</p>
|
|
66
68
|
*
|
|
69
|
+
* @throws {@link GlacierServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
67
71
|
*
|
|
68
72
|
* @example To add tags to a vault
|
|
69
73
|
* ```javascript
|
|
@@ -72,6 +72,12 @@ export interface CompleteMultipartUploadCommandOutput extends ArchiveCreationOut
|
|
|
72
72
|
* };
|
|
73
73
|
* const command = new CompleteMultipartUploadCommand(input);
|
|
74
74
|
* const response = await client.send(command);
|
|
75
|
+
* // { // ArchiveCreationOutput
|
|
76
|
+
* // location: "STRING_VALUE",
|
|
77
|
+
* // checksum: "STRING_VALUE",
|
|
78
|
+
* // archiveId: "STRING_VALUE",
|
|
79
|
+
* // };
|
|
80
|
+
*
|
|
75
81
|
* ```
|
|
76
82
|
*
|
|
77
83
|
* @param CompleteMultipartUploadCommandInput - {@link CompleteMultipartUploadCommandInput}
|
|
@@ -93,6 +99,8 @@ export interface CompleteMultipartUploadCommandOutput extends ArchiveCreationOut
|
|
|
93
99
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
94
100
|
* <p>Returned if the service cannot complete the request.</p>
|
|
95
101
|
*
|
|
102
|
+
* @throws {@link GlacierServiceException}
|
|
103
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
96
104
|
*
|
|
97
105
|
* @example To complete a multipart upload
|
|
98
106
|
* ```javascript
|
|
@@ -46,6 +46,8 @@ export interface CompleteVaultLockCommandOutput extends __MetadataBearer {
|
|
|
46
46
|
* };
|
|
47
47
|
* const command = new CompleteVaultLockCommand(input);
|
|
48
48
|
* const response = await client.send(command);
|
|
49
|
+
* // {};
|
|
50
|
+
*
|
|
49
51
|
* ```
|
|
50
52
|
*
|
|
51
53
|
* @param CompleteVaultLockCommandInput - {@link CompleteVaultLockCommandInput}
|
|
@@ -67,6 +69,8 @@ export interface CompleteVaultLockCommandOutput extends __MetadataBearer {
|
|
|
67
69
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
68
70
|
* <p>Returned if the service cannot complete the request.</p>
|
|
69
71
|
*
|
|
72
|
+
* @throws {@link GlacierServiceException}
|
|
73
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
70
74
|
*
|
|
71
75
|
* @example To complete a vault lock
|
|
72
76
|
* ```javascript
|
|
@@ -55,6 +55,10 @@ export interface CreateVaultCommandOutput extends CreateVaultOutput, __MetadataB
|
|
|
55
55
|
* };
|
|
56
56
|
* const command = new CreateVaultCommand(input);
|
|
57
57
|
* const response = await client.send(command);
|
|
58
|
+
* // { // CreateVaultOutput
|
|
59
|
+
* // location: "STRING_VALUE",
|
|
60
|
+
* // };
|
|
61
|
+
*
|
|
58
62
|
* ```
|
|
59
63
|
*
|
|
60
64
|
* @param CreateVaultCommandInput - {@link CreateVaultCommandInput}
|
|
@@ -75,6 +79,8 @@ export interface CreateVaultCommandOutput extends CreateVaultOutput, __MetadataB
|
|
|
75
79
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
76
80
|
* <p>Returned if the service cannot complete the request.</p>
|
|
77
81
|
*
|
|
82
|
+
* @throws {@link GlacierServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
78
84
|
*
|
|
79
85
|
* @example To create a new vault
|
|
80
86
|
* ```javascript
|
|
@@ -59,6 +59,8 @@ export interface DeleteArchiveCommandOutput extends __MetadataBearer {
|
|
|
59
59
|
* };
|
|
60
60
|
* const command = new DeleteArchiveCommand(input);
|
|
61
61
|
* const response = await client.send(command);
|
|
62
|
+
* // {};
|
|
63
|
+
*
|
|
62
64
|
* ```
|
|
63
65
|
*
|
|
64
66
|
* @param DeleteArchiveCommandInput - {@link DeleteArchiveCommandInput}
|
|
@@ -80,6 +82,8 @@ export interface DeleteArchiveCommandOutput extends __MetadataBearer {
|
|
|
80
82
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
81
83
|
* <p>Returned if the service cannot complete the request.</p>
|
|
82
84
|
*
|
|
85
|
+
* @throws {@link GlacierServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
83
87
|
*
|
|
84
88
|
* @example To delete an archive
|
|
85
89
|
* ```javascript
|
|
@@ -38,6 +38,8 @@ export interface DeleteVaultAccessPolicyCommandOutput extends __MetadataBearer {
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new DeleteVaultAccessPolicyCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // {};
|
|
42
|
+
*
|
|
41
43
|
* ```
|
|
42
44
|
*
|
|
43
45
|
* @param DeleteVaultAccessPolicyCommandInput - {@link DeleteVaultAccessPolicyCommandInput}
|
|
@@ -59,6 +61,8 @@ export interface DeleteVaultAccessPolicyCommandOutput extends __MetadataBearer {
|
|
|
59
61
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
60
62
|
* <p>Returned if the service cannot complete the request.</p>
|
|
61
63
|
*
|
|
64
|
+
* @throws {@link GlacierServiceException}
|
|
65
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
62
66
|
*
|
|
63
67
|
* @example To delete the vault access policy
|
|
64
68
|
* ```javascript
|
|
@@ -51,6 +51,8 @@ export interface DeleteVaultCommandOutput extends __MetadataBearer {
|
|
|
51
51
|
* };
|
|
52
52
|
* const command = new DeleteVaultCommand(input);
|
|
53
53
|
* const response = await client.send(command);
|
|
54
|
+
* // {};
|
|
55
|
+
*
|
|
54
56
|
* ```
|
|
55
57
|
*
|
|
56
58
|
* @param DeleteVaultCommandInput - {@link DeleteVaultCommandInput}
|
|
@@ -72,6 +74,8 @@ export interface DeleteVaultCommandOutput extends __MetadataBearer {
|
|
|
72
74
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
73
75
|
* <p>Returned if the service cannot complete the request.</p>
|
|
74
76
|
*
|
|
77
|
+
* @throws {@link GlacierServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
75
79
|
*
|
|
76
80
|
* @example To delete a vault
|
|
77
81
|
* ```javascript
|
|
@@ -44,6 +44,8 @@ export interface DeleteVaultNotificationsCommandOutput extends __MetadataBearer
|
|
|
44
44
|
* };
|
|
45
45
|
* const command = new DeleteVaultNotificationsCommand(input);
|
|
46
46
|
* const response = await client.send(command);
|
|
47
|
+
* // {};
|
|
48
|
+
*
|
|
47
49
|
* ```
|
|
48
50
|
*
|
|
49
51
|
* @param DeleteVaultNotificationsCommandInput - {@link DeleteVaultNotificationsCommandInput}
|
|
@@ -65,6 +67,8 @@ export interface DeleteVaultNotificationsCommandOutput extends __MetadataBearer
|
|
|
65
67
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
66
68
|
* <p>Returned if the service cannot complete the request.</p>
|
|
67
69
|
*
|
|
70
|
+
* @throws {@link GlacierServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
68
72
|
*
|
|
69
73
|
* @example To delete the notification configuration set for a vault
|
|
70
74
|
* ```javascript
|
|
@@ -56,6 +56,88 @@ export interface DescribeJobCommandOutput extends GlacierJobDescription, __Metad
|
|
|
56
56
|
* };
|
|
57
57
|
* const command = new DescribeJobCommand(input);
|
|
58
58
|
* const response = await client.send(command);
|
|
59
|
+
* // { // GlacierJobDescription
|
|
60
|
+
* // JobId: "STRING_VALUE",
|
|
61
|
+
* // JobDescription: "STRING_VALUE",
|
|
62
|
+
* // Action: "ArchiveRetrieval" || "InventoryRetrieval" || "Select",
|
|
63
|
+
* // ArchiveId: "STRING_VALUE",
|
|
64
|
+
* // VaultARN: "STRING_VALUE",
|
|
65
|
+
* // CreationDate: "STRING_VALUE",
|
|
66
|
+
* // Completed: true || false,
|
|
67
|
+
* // StatusCode: "InProgress" || "Succeeded" || "Failed",
|
|
68
|
+
* // StatusMessage: "STRING_VALUE",
|
|
69
|
+
* // ArchiveSizeInBytes: Number("long"),
|
|
70
|
+
* // InventorySizeInBytes: Number("long"),
|
|
71
|
+
* // SNSTopic: "STRING_VALUE",
|
|
72
|
+
* // CompletionDate: "STRING_VALUE",
|
|
73
|
+
* // SHA256TreeHash: "STRING_VALUE",
|
|
74
|
+
* // ArchiveSHA256TreeHash: "STRING_VALUE",
|
|
75
|
+
* // RetrievalByteRange: "STRING_VALUE",
|
|
76
|
+
* // Tier: "STRING_VALUE",
|
|
77
|
+
* // InventoryRetrievalParameters: { // InventoryRetrievalJobDescription
|
|
78
|
+
* // Format: "STRING_VALUE",
|
|
79
|
+
* // StartDate: "STRING_VALUE",
|
|
80
|
+
* // EndDate: "STRING_VALUE",
|
|
81
|
+
* // Limit: "STRING_VALUE",
|
|
82
|
+
* // Marker: "STRING_VALUE",
|
|
83
|
+
* // },
|
|
84
|
+
* // JobOutputPath: "STRING_VALUE",
|
|
85
|
+
* // SelectParameters: { // SelectParameters
|
|
86
|
+
* // InputSerialization: { // InputSerialization
|
|
87
|
+
* // csv: { // CSVInput
|
|
88
|
+
* // FileHeaderInfo: "USE" || "IGNORE" || "NONE",
|
|
89
|
+
* // Comments: "STRING_VALUE",
|
|
90
|
+
* // QuoteEscapeCharacter: "STRING_VALUE",
|
|
91
|
+
* // RecordDelimiter: "STRING_VALUE",
|
|
92
|
+
* // FieldDelimiter: "STRING_VALUE",
|
|
93
|
+
* // QuoteCharacter: "STRING_VALUE",
|
|
94
|
+
* // },
|
|
95
|
+
* // },
|
|
96
|
+
* // ExpressionType: "SQL",
|
|
97
|
+
* // Expression: "STRING_VALUE",
|
|
98
|
+
* // OutputSerialization: { // OutputSerialization
|
|
99
|
+
* // csv: { // CSVOutput
|
|
100
|
+
* // QuoteFields: "ALWAYS" || "ASNEEDED",
|
|
101
|
+
* // QuoteEscapeCharacter: "STRING_VALUE",
|
|
102
|
+
* // RecordDelimiter: "STRING_VALUE",
|
|
103
|
+
* // FieldDelimiter: "STRING_VALUE",
|
|
104
|
+
* // QuoteCharacter: "STRING_VALUE",
|
|
105
|
+
* // },
|
|
106
|
+
* // },
|
|
107
|
+
* // },
|
|
108
|
+
* // OutputLocation: { // OutputLocation
|
|
109
|
+
* // S3: { // S3Location
|
|
110
|
+
* // BucketName: "STRING_VALUE",
|
|
111
|
+
* // Prefix: "STRING_VALUE",
|
|
112
|
+
* // Encryption: { // Encryption
|
|
113
|
+
* // EncryptionType: "aws:kms" || "AES256",
|
|
114
|
+
* // KMSKeyId: "STRING_VALUE",
|
|
115
|
+
* // KMSContext: "STRING_VALUE",
|
|
116
|
+
* // },
|
|
117
|
+
* // CannedACL: "private" || "public-read" || "public-read-write" || "aws-exec-read" || "authenticated-read" || "bucket-owner-read" || "bucket-owner-full-control",
|
|
118
|
+
* // AccessControlList: [ // AccessControlPolicyList
|
|
119
|
+
* // { // Grant
|
|
120
|
+
* // Grantee: { // Grantee
|
|
121
|
+
* // Type: "AmazonCustomerByEmail" || "CanonicalUser" || "Group", // required
|
|
122
|
+
* // DisplayName: "STRING_VALUE",
|
|
123
|
+
* // URI: "STRING_VALUE",
|
|
124
|
+
* // ID: "STRING_VALUE",
|
|
125
|
+
* // EmailAddress: "STRING_VALUE",
|
|
126
|
+
* // },
|
|
127
|
+
* // Permission: "FULL_CONTROL" || "WRITE" || "WRITE_ACP" || "READ" || "READ_ACP",
|
|
128
|
+
* // },
|
|
129
|
+
* // ],
|
|
130
|
+
* // Tagging: { // hashmap
|
|
131
|
+
* // "<keys>": "STRING_VALUE",
|
|
132
|
+
* // },
|
|
133
|
+
* // UserMetadata: {
|
|
134
|
+
* // "<keys>": "STRING_VALUE",
|
|
135
|
+
* // },
|
|
136
|
+
* // StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA",
|
|
137
|
+
* // },
|
|
138
|
+
* // },
|
|
139
|
+
* // };
|
|
140
|
+
*
|
|
59
141
|
* ```
|
|
60
142
|
*
|
|
61
143
|
* @param DescribeJobCommandInput - {@link DescribeJobCommandInput}
|
|
@@ -77,6 +159,8 @@ export interface DescribeJobCommandOutput extends GlacierJobDescription, __Metad
|
|
|
77
159
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
78
160
|
* <p>Returned if the service cannot complete the request.</p>
|
|
79
161
|
*
|
|
162
|
+
* @throws {@link GlacierServiceException}
|
|
163
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
80
164
|
*
|
|
81
165
|
* @example To get information about a previously initiated job
|
|
82
166
|
* ```javascript
|
|
@@ -49,6 +49,15 @@ export interface DescribeVaultCommandOutput extends DescribeVaultOutput, __Metad
|
|
|
49
49
|
* };
|
|
50
50
|
* const command = new DescribeVaultCommand(input);
|
|
51
51
|
* const response = await client.send(command);
|
|
52
|
+
* // { // DescribeVaultOutput
|
|
53
|
+
* // VaultARN: "STRING_VALUE",
|
|
54
|
+
* // VaultName: "STRING_VALUE",
|
|
55
|
+
* // CreationDate: "STRING_VALUE",
|
|
56
|
+
* // LastInventoryDate: "STRING_VALUE",
|
|
57
|
+
* // NumberOfArchives: Number("long"),
|
|
58
|
+
* // SizeInBytes: Number("long"),
|
|
59
|
+
* // };
|
|
60
|
+
*
|
|
52
61
|
* ```
|
|
53
62
|
*
|
|
54
63
|
* @param DescribeVaultCommandInput - {@link DescribeVaultCommandInput}
|
|
@@ -70,6 +79,8 @@ export interface DescribeVaultCommandOutput extends DescribeVaultOutput, __Metad
|
|
|
70
79
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
71
80
|
* <p>Returned if the service cannot complete the request.</p>
|
|
72
81
|
*
|
|
82
|
+
* @throws {@link GlacierServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
73
84
|
*
|
|
74
85
|
* @example To retrieve information about a vault
|
|
75
86
|
* ```javascript
|
|
@@ -33,6 +33,17 @@ export interface GetDataRetrievalPolicyCommandOutput extends GetDataRetrievalPol
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new GetDataRetrievalPolicyCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // GetDataRetrievalPolicyOutput
|
|
37
|
+
* // Policy: { // DataRetrievalPolicy
|
|
38
|
+
* // Rules: [ // DataRetrievalRulesList
|
|
39
|
+
* // { // DataRetrievalRule
|
|
40
|
+
* // Strategy: "STRING_VALUE",
|
|
41
|
+
* // BytesPerHour: Number("long"),
|
|
42
|
+
* // },
|
|
43
|
+
* // ],
|
|
44
|
+
* // },
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
36
47
|
* ```
|
|
37
48
|
*
|
|
38
49
|
* @param GetDataRetrievalPolicyCommandInput - {@link GetDataRetrievalPolicyCommandInput}
|
|
@@ -50,6 +61,8 @@ export interface GetDataRetrievalPolicyCommandOutput extends GetDataRetrievalPol
|
|
|
50
61
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
51
62
|
* <p>Returned if the service cannot complete the request.</p>
|
|
52
63
|
*
|
|
64
|
+
* @throws {@link GlacierServiceException}
|
|
65
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
53
66
|
*
|
|
54
67
|
* @example To get the current data retrieval policy for an account
|
|
55
68
|
* ```javascript
|
|
@@ -70,6 +70,16 @@ export interface GetJobOutputCommandOutput extends __WithSdkStreamMixin<GetJobOu
|
|
|
70
70
|
* };
|
|
71
71
|
* const command = new GetJobOutputCommand(input);
|
|
72
72
|
* const response = await client.send(command);
|
|
73
|
+
* // { // GetJobOutputOutput
|
|
74
|
+
* // body: "STREAMING_BLOB_VALUE",
|
|
75
|
+
* // checksum: "STRING_VALUE",
|
|
76
|
+
* // status: Number("int"),
|
|
77
|
+
* // contentRange: "STRING_VALUE",
|
|
78
|
+
* // acceptRanges: "STRING_VALUE",
|
|
79
|
+
* // contentType: "STRING_VALUE",
|
|
80
|
+
* // archiveDescription: "STRING_VALUE",
|
|
81
|
+
* // };
|
|
82
|
+
*
|
|
73
83
|
* ```
|
|
74
84
|
*
|
|
75
85
|
* @param GetJobOutputCommandInput - {@link GetJobOutputCommandInput}
|
|
@@ -91,6 +101,8 @@ export interface GetJobOutputCommandOutput extends __WithSdkStreamMixin<GetJobOu
|
|
|
91
101
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
92
102
|
* <p>Returned if the service cannot complete the request.</p>
|
|
93
103
|
*
|
|
104
|
+
* @throws {@link GlacierServiceException}
|
|
105
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
94
106
|
*
|
|
95
107
|
* @example To get the output of a previously initiated job
|
|
96
108
|
* ```javascript
|
|
@@ -37,6 +37,12 @@ export interface GetVaultAccessPolicyCommandOutput extends GetVaultAccessPolicyO
|
|
|
37
37
|
* };
|
|
38
38
|
* const command = new GetVaultAccessPolicyCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
40
|
+
* // { // GetVaultAccessPolicyOutput
|
|
41
|
+
* // policy: { // VaultAccessPolicy
|
|
42
|
+
* // Policy: "STRING_VALUE",
|
|
43
|
+
* // },
|
|
44
|
+
* // };
|
|
45
|
+
*
|
|
40
46
|
* ```
|
|
41
47
|
*
|
|
42
48
|
* @param GetVaultAccessPolicyCommandInput - {@link GetVaultAccessPolicyCommandInput}
|
|
@@ -58,6 +64,8 @@ export interface GetVaultAccessPolicyCommandOutput extends GetVaultAccessPolicyO
|
|
|
58
64
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
59
65
|
* <p>Returned if the service cannot complete the request.</p>
|
|
60
66
|
*
|
|
67
|
+
* @throws {@link GlacierServiceException}
|
|
68
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
61
69
|
*
|
|
62
70
|
* @example To get the access-policy set on the vault
|
|
63
71
|
* ```javascript
|
|
@@ -59,6 +59,13 @@ export interface GetVaultLockCommandOutput extends GetVaultLockOutput, __Metadat
|
|
|
59
59
|
* };
|
|
60
60
|
* const command = new GetVaultLockCommand(input);
|
|
61
61
|
* const response = await client.send(command);
|
|
62
|
+
* // { // GetVaultLockOutput
|
|
63
|
+
* // Policy: "STRING_VALUE",
|
|
64
|
+
* // State: "STRING_VALUE",
|
|
65
|
+
* // ExpirationDate: "STRING_VALUE",
|
|
66
|
+
* // CreationDate: "STRING_VALUE",
|
|
67
|
+
* // };
|
|
68
|
+
*
|
|
62
69
|
* ```
|
|
63
70
|
*
|
|
64
71
|
* @param GetVaultLockCommandInput - {@link GetVaultLockCommandInput}
|
|
@@ -80,6 +87,8 @@ export interface GetVaultLockCommandOutput extends GetVaultLockOutput, __Metadat
|
|
|
80
87
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
81
88
|
* <p>Returned if the service cannot complete the request.</p>
|
|
82
89
|
*
|
|
90
|
+
* @throws {@link GlacierServiceException}
|
|
91
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
83
92
|
*
|
|
84
93
|
* @example To retrieve vault lock-policy related attributes that are set on a vault
|
|
85
94
|
* ```javascript
|
|
@@ -47,6 +47,15 @@ export interface GetVaultNotificationsCommandOutput extends GetVaultNotification
|
|
|
47
47
|
* };
|
|
48
48
|
* const command = new GetVaultNotificationsCommand(input);
|
|
49
49
|
* const response = await client.send(command);
|
|
50
|
+
* // { // GetVaultNotificationsOutput
|
|
51
|
+
* // vaultNotificationConfig: { // VaultNotificationConfig
|
|
52
|
+
* // SNSTopic: "STRING_VALUE",
|
|
53
|
+
* // Events: [ // NotificationEventList
|
|
54
|
+
* // "STRING_VALUE",
|
|
55
|
+
* // ],
|
|
56
|
+
* // },
|
|
57
|
+
* // };
|
|
58
|
+
*
|
|
50
59
|
* ```
|
|
51
60
|
*
|
|
52
61
|
* @param GetVaultNotificationsCommandInput - {@link GetVaultNotificationsCommandInput}
|
|
@@ -68,6 +77,8 @@ export interface GetVaultNotificationsCommandOutput extends GetVaultNotification
|
|
|
68
77
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
69
78
|
* <p>Returned if the service cannot complete the request.</p>
|
|
70
79
|
*
|
|
80
|
+
* @throws {@link GlacierServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
71
82
|
*
|
|
72
83
|
* @example To get the notification-configuration for the specified vault
|
|
73
84
|
* ```javascript
|
|
@@ -105,6 +105,12 @@ export interface InitiateJobCommandOutput extends InitiateJobOutput, __MetadataB
|
|
|
105
105
|
* };
|
|
106
106
|
* const command = new InitiateJobCommand(input);
|
|
107
107
|
* const response = await client.send(command);
|
|
108
|
+
* // { // InitiateJobOutput
|
|
109
|
+
* // location: "STRING_VALUE",
|
|
110
|
+
* // jobId: "STRING_VALUE",
|
|
111
|
+
* // jobOutputPath: "STRING_VALUE",
|
|
112
|
+
* // };
|
|
113
|
+
*
|
|
108
114
|
* ```
|
|
109
115
|
*
|
|
110
116
|
* @param InitiateJobCommandInput - {@link InitiateJobCommandInput}
|
|
@@ -135,6 +141,8 @@ export interface InitiateJobCommandOutput extends InitiateJobOutput, __MetadataB
|
|
|
135
141
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
136
142
|
* <p>Returned if the service cannot complete the request.</p>
|
|
137
143
|
*
|
|
144
|
+
* @throws {@link GlacierServiceException}
|
|
145
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
138
146
|
*
|
|
139
147
|
* @example To initiate an inventory-retrieval job
|
|
140
148
|
* ```javascript
|
|
@@ -67,6 +67,11 @@ export interface InitiateMultipartUploadCommandOutput extends InitiateMultipartU
|
|
|
67
67
|
* };
|
|
68
68
|
* const command = new InitiateMultipartUploadCommand(input);
|
|
69
69
|
* const response = await client.send(command);
|
|
70
|
+
* // { // InitiateMultipartUploadOutput
|
|
71
|
+
* // location: "STRING_VALUE",
|
|
72
|
+
* // uploadId: "STRING_VALUE",
|
|
73
|
+
* // };
|
|
74
|
+
*
|
|
70
75
|
* ```
|
|
71
76
|
*
|
|
72
77
|
* @param InitiateMultipartUploadCommandInput - {@link InitiateMultipartUploadCommandInput}
|
|
@@ -88,6 +93,8 @@ export interface InitiateMultipartUploadCommandOutput extends InitiateMultipartU
|
|
|
88
93
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
89
94
|
* <p>Returned if the service cannot complete the request.</p>
|
|
90
95
|
*
|
|
96
|
+
* @throws {@link GlacierServiceException}
|
|
97
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
91
98
|
*
|
|
92
99
|
* @example To initiate a multipart upload
|
|
93
100
|
* ```javascript
|
|
@@ -69,6 +69,10 @@ export interface InitiateVaultLockCommandOutput extends InitiateVaultLockOutput,
|
|
|
69
69
|
* };
|
|
70
70
|
* const command = new InitiateVaultLockCommand(input);
|
|
71
71
|
* const response = await client.send(command);
|
|
72
|
+
* // { // InitiateVaultLockOutput
|
|
73
|
+
* // lockId: "STRING_VALUE",
|
|
74
|
+
* // };
|
|
75
|
+
*
|
|
72
76
|
* ```
|
|
73
77
|
*
|
|
74
78
|
* @param InitiateVaultLockCommandInput - {@link InitiateVaultLockCommandInput}
|
|
@@ -90,6 +94,8 @@ export interface InitiateVaultLockCommandOutput extends InitiateVaultLockOutput,
|
|
|
90
94
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
91
95
|
* <p>Returned if the service cannot complete the request.</p>
|
|
92
96
|
*
|
|
97
|
+
* @throws {@link GlacierServiceException}
|
|
98
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
93
99
|
*
|
|
94
100
|
* @example To initiate the vault locking process
|
|
95
101
|
* ```javascript
|
|
@@ -71,6 +71,93 @@ export interface ListJobsCommandOutput extends ListJobsOutput, __MetadataBearer
|
|
|
71
71
|
* };
|
|
72
72
|
* const command = new ListJobsCommand(input);
|
|
73
73
|
* const response = await client.send(command);
|
|
74
|
+
* // { // ListJobsOutput
|
|
75
|
+
* // JobList: [ // JobList
|
|
76
|
+
* // { // GlacierJobDescription
|
|
77
|
+
* // JobId: "STRING_VALUE",
|
|
78
|
+
* // JobDescription: "STRING_VALUE",
|
|
79
|
+
* // Action: "ArchiveRetrieval" || "InventoryRetrieval" || "Select",
|
|
80
|
+
* // ArchiveId: "STRING_VALUE",
|
|
81
|
+
* // VaultARN: "STRING_VALUE",
|
|
82
|
+
* // CreationDate: "STRING_VALUE",
|
|
83
|
+
* // Completed: true || false,
|
|
84
|
+
* // StatusCode: "InProgress" || "Succeeded" || "Failed",
|
|
85
|
+
* // StatusMessage: "STRING_VALUE",
|
|
86
|
+
* // ArchiveSizeInBytes: Number("long"),
|
|
87
|
+
* // InventorySizeInBytes: Number("long"),
|
|
88
|
+
* // SNSTopic: "STRING_VALUE",
|
|
89
|
+
* // CompletionDate: "STRING_VALUE",
|
|
90
|
+
* // SHA256TreeHash: "STRING_VALUE",
|
|
91
|
+
* // ArchiveSHA256TreeHash: "STRING_VALUE",
|
|
92
|
+
* // RetrievalByteRange: "STRING_VALUE",
|
|
93
|
+
* // Tier: "STRING_VALUE",
|
|
94
|
+
* // InventoryRetrievalParameters: { // InventoryRetrievalJobDescription
|
|
95
|
+
* // Format: "STRING_VALUE",
|
|
96
|
+
* // StartDate: "STRING_VALUE",
|
|
97
|
+
* // EndDate: "STRING_VALUE",
|
|
98
|
+
* // Limit: "STRING_VALUE",
|
|
99
|
+
* // Marker: "STRING_VALUE",
|
|
100
|
+
* // },
|
|
101
|
+
* // JobOutputPath: "STRING_VALUE",
|
|
102
|
+
* // SelectParameters: { // SelectParameters
|
|
103
|
+
* // InputSerialization: { // InputSerialization
|
|
104
|
+
* // csv: { // CSVInput
|
|
105
|
+
* // FileHeaderInfo: "USE" || "IGNORE" || "NONE",
|
|
106
|
+
* // Comments: "STRING_VALUE",
|
|
107
|
+
* // QuoteEscapeCharacter: "STRING_VALUE",
|
|
108
|
+
* // RecordDelimiter: "STRING_VALUE",
|
|
109
|
+
* // FieldDelimiter: "STRING_VALUE",
|
|
110
|
+
* // QuoteCharacter: "STRING_VALUE",
|
|
111
|
+
* // },
|
|
112
|
+
* // },
|
|
113
|
+
* // ExpressionType: "SQL",
|
|
114
|
+
* // Expression: "STRING_VALUE",
|
|
115
|
+
* // OutputSerialization: { // OutputSerialization
|
|
116
|
+
* // csv: { // CSVOutput
|
|
117
|
+
* // QuoteFields: "ALWAYS" || "ASNEEDED",
|
|
118
|
+
* // QuoteEscapeCharacter: "STRING_VALUE",
|
|
119
|
+
* // RecordDelimiter: "STRING_VALUE",
|
|
120
|
+
* // FieldDelimiter: "STRING_VALUE",
|
|
121
|
+
* // QuoteCharacter: "STRING_VALUE",
|
|
122
|
+
* // },
|
|
123
|
+
* // },
|
|
124
|
+
* // },
|
|
125
|
+
* // OutputLocation: { // OutputLocation
|
|
126
|
+
* // S3: { // S3Location
|
|
127
|
+
* // BucketName: "STRING_VALUE",
|
|
128
|
+
* // Prefix: "STRING_VALUE",
|
|
129
|
+
* // Encryption: { // Encryption
|
|
130
|
+
* // EncryptionType: "aws:kms" || "AES256",
|
|
131
|
+
* // KMSKeyId: "STRING_VALUE",
|
|
132
|
+
* // KMSContext: "STRING_VALUE",
|
|
133
|
+
* // },
|
|
134
|
+
* // CannedACL: "private" || "public-read" || "public-read-write" || "aws-exec-read" || "authenticated-read" || "bucket-owner-read" || "bucket-owner-full-control",
|
|
135
|
+
* // AccessControlList: [ // AccessControlPolicyList
|
|
136
|
+
* // { // Grant
|
|
137
|
+
* // Grantee: { // Grantee
|
|
138
|
+
* // Type: "AmazonCustomerByEmail" || "CanonicalUser" || "Group", // required
|
|
139
|
+
* // DisplayName: "STRING_VALUE",
|
|
140
|
+
* // URI: "STRING_VALUE",
|
|
141
|
+
* // ID: "STRING_VALUE",
|
|
142
|
+
* // EmailAddress: "STRING_VALUE",
|
|
143
|
+
* // },
|
|
144
|
+
* // Permission: "FULL_CONTROL" || "WRITE" || "WRITE_ACP" || "READ" || "READ_ACP",
|
|
145
|
+
* // },
|
|
146
|
+
* // ],
|
|
147
|
+
* // Tagging: { // hashmap
|
|
148
|
+
* // "<keys>": "STRING_VALUE",
|
|
149
|
+
* // },
|
|
150
|
+
* // UserMetadata: {
|
|
151
|
+
* // "<keys>": "STRING_VALUE",
|
|
152
|
+
* // },
|
|
153
|
+
* // StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA",
|
|
154
|
+
* // },
|
|
155
|
+
* // },
|
|
156
|
+
* // },
|
|
157
|
+
* // ],
|
|
158
|
+
* // Marker: "STRING_VALUE",
|
|
159
|
+
* // };
|
|
160
|
+
*
|
|
74
161
|
* ```
|
|
75
162
|
*
|
|
76
163
|
* @param ListJobsCommandInput - {@link ListJobsCommandInput}
|
|
@@ -92,6 +179,8 @@ export interface ListJobsCommandOutput extends ListJobsOutput, __MetadataBearer
|
|
|
92
179
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
93
180
|
* <p>Returned if the service cannot complete the request.</p>
|
|
94
181
|
*
|
|
182
|
+
* @throws {@link GlacierServiceException}
|
|
183
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
95
184
|
*
|
|
96
185
|
* @example To list jobs for a vault
|
|
97
186
|
* ```javascript
|
|
@@ -59,6 +59,19 @@ export interface ListMultipartUploadsCommandOutput extends ListMultipartUploadsO
|
|
|
59
59
|
* };
|
|
60
60
|
* const command = new ListMultipartUploadsCommand(input);
|
|
61
61
|
* const response = await client.send(command);
|
|
62
|
+
* // { // ListMultipartUploadsOutput
|
|
63
|
+
* // UploadsList: [ // UploadsList
|
|
64
|
+
* // { // UploadListElement
|
|
65
|
+
* // MultipartUploadId: "STRING_VALUE",
|
|
66
|
+
* // VaultARN: "STRING_VALUE",
|
|
67
|
+
* // ArchiveDescription: "STRING_VALUE",
|
|
68
|
+
* // PartSizeInBytes: Number("long"),
|
|
69
|
+
* // CreationDate: "STRING_VALUE",
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // Marker: "STRING_VALUE",
|
|
73
|
+
* // };
|
|
74
|
+
*
|
|
62
75
|
* ```
|
|
63
76
|
*
|
|
64
77
|
* @param ListMultipartUploadsCommandInput - {@link ListMultipartUploadsCommandInput}
|
|
@@ -80,6 +93,8 @@ export interface ListMultipartUploadsCommandOutput extends ListMultipartUploadsO
|
|
|
80
93
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
81
94
|
* <p>Returned if the service cannot complete the request.</p>
|
|
82
95
|
*
|
|
96
|
+
* @throws {@link GlacierServiceException}
|
|
97
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
83
98
|
*
|
|
84
99
|
* @example To list all the in-progress multipart uploads for a vault
|
|
85
100
|
* ```javascript
|
|
@@ -56,6 +56,21 @@ export interface ListPartsCommandOutput extends ListPartsOutput, __MetadataBeare
|
|
|
56
56
|
* };
|
|
57
57
|
* const command = new ListPartsCommand(input);
|
|
58
58
|
* const response = await client.send(command);
|
|
59
|
+
* // { // ListPartsOutput
|
|
60
|
+
* // MultipartUploadId: "STRING_VALUE",
|
|
61
|
+
* // VaultARN: "STRING_VALUE",
|
|
62
|
+
* // ArchiveDescription: "STRING_VALUE",
|
|
63
|
+
* // PartSizeInBytes: Number("long"),
|
|
64
|
+
* // CreationDate: "STRING_VALUE",
|
|
65
|
+
* // Parts: [ // PartList
|
|
66
|
+
* // { // PartListElement
|
|
67
|
+
* // RangeInBytes: "STRING_VALUE",
|
|
68
|
+
* // SHA256TreeHash: "STRING_VALUE",
|
|
69
|
+
* // },
|
|
70
|
+
* // ],
|
|
71
|
+
* // Marker: "STRING_VALUE",
|
|
72
|
+
* // };
|
|
73
|
+
*
|
|
59
74
|
* ```
|
|
60
75
|
*
|
|
61
76
|
* @param ListPartsCommandInput - {@link ListPartsCommandInput}
|
|
@@ -77,6 +92,8 @@ export interface ListPartsCommandOutput extends ListPartsOutput, __MetadataBeare
|
|
|
77
92
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
78
93
|
* <p>Returned if the service cannot complete the request.</p>
|
|
79
94
|
*
|
|
95
|
+
* @throws {@link GlacierServiceException}
|
|
96
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
80
97
|
*
|
|
81
98
|
* @example To list the parts of an archive that have been uploaded in a multipart upload
|
|
82
99
|
* ```javascript
|
|
@@ -32,6 +32,16 @@ export interface ListProvisionedCapacityCommandOutput extends ListProvisionedCap
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new ListProvisionedCapacityCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // ListProvisionedCapacityOutput
|
|
36
|
+
* // ProvisionedCapacityList: [ // ProvisionedCapacityList
|
|
37
|
+
* // { // ProvisionedCapacityDescription
|
|
38
|
+
* // CapacityId: "STRING_VALUE",
|
|
39
|
+
* // StartDate: "STRING_VALUE",
|
|
40
|
+
* // ExpirationDate: "STRING_VALUE",
|
|
41
|
+
* // },
|
|
42
|
+
* // ],
|
|
43
|
+
* // };
|
|
44
|
+
*
|
|
35
45
|
* ```
|
|
36
46
|
*
|
|
37
47
|
* @param ListProvisionedCapacityCommandInput - {@link ListProvisionedCapacityCommandInput}
|
|
@@ -49,6 +59,8 @@ export interface ListProvisionedCapacityCommandOutput extends ListProvisionedCap
|
|
|
49
59
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
50
60
|
* <p>Returned if the service cannot complete the request.</p>
|
|
51
61
|
*
|
|
62
|
+
* @throws {@link GlacierServiceException}
|
|
63
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
52
64
|
*
|
|
53
65
|
* @example To list the provisioned capacity units for an account
|
|
54
66
|
* ```javascript
|
|
@@ -34,6 +34,12 @@ export interface ListTagsForVaultCommandOutput extends ListTagsForVaultOutput, _
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new ListTagsForVaultCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // ListTagsForVaultOutput
|
|
38
|
+
* // Tags: { // TagMap
|
|
39
|
+
* // "<keys>": "STRING_VALUE",
|
|
40
|
+
* // },
|
|
41
|
+
* // };
|
|
42
|
+
*
|
|
37
43
|
* ```
|
|
38
44
|
*
|
|
39
45
|
* @param ListTagsForVaultCommandInput - {@link ListTagsForVaultCommandInput}
|
|
@@ -55,6 +61,8 @@ export interface ListTagsForVaultCommandOutput extends ListTagsForVaultOutput, _
|
|
|
55
61
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
56
62
|
* <p>Returned if the service cannot complete the request.</p>
|
|
57
63
|
*
|
|
64
|
+
* @throws {@link GlacierServiceException}
|
|
65
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
58
66
|
*
|
|
59
67
|
* @example To list the tags for a vault
|
|
60
68
|
* ```javascript
|
|
@@ -51,6 +51,20 @@ export interface ListVaultsCommandOutput extends ListVaultsOutput, __MetadataBea
|
|
|
51
51
|
* };
|
|
52
52
|
* const command = new ListVaultsCommand(input);
|
|
53
53
|
* const response = await client.send(command);
|
|
54
|
+
* // { // ListVaultsOutput
|
|
55
|
+
* // VaultList: [ // VaultList
|
|
56
|
+
* // { // DescribeVaultOutput
|
|
57
|
+
* // VaultARN: "STRING_VALUE",
|
|
58
|
+
* // VaultName: "STRING_VALUE",
|
|
59
|
+
* // CreationDate: "STRING_VALUE",
|
|
60
|
+
* // LastInventoryDate: "STRING_VALUE",
|
|
61
|
+
* // NumberOfArchives: Number("long"),
|
|
62
|
+
* // SizeInBytes: Number("long"),
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // Marker: "STRING_VALUE",
|
|
66
|
+
* // };
|
|
67
|
+
*
|
|
54
68
|
* ```
|
|
55
69
|
*
|
|
56
70
|
* @param ListVaultsCommandInput - {@link ListVaultsCommandInput}
|
|
@@ -72,6 +86,8 @@ export interface ListVaultsCommandOutput extends ListVaultsOutput, __MetadataBea
|
|
|
72
86
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
73
87
|
* <p>Returned if the service cannot complete the request.</p>
|
|
74
88
|
*
|
|
89
|
+
* @throws {@link GlacierServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
75
91
|
*
|
|
76
92
|
* @example To list all vaults owned by the calling user's account
|
|
77
93
|
* ```javascript
|
|
@@ -31,6 +31,10 @@ export interface PurchaseProvisionedCapacityCommandOutput extends PurchaseProvis
|
|
|
31
31
|
* };
|
|
32
32
|
* const command = new PurchaseProvisionedCapacityCommand(input);
|
|
33
33
|
* const response = await client.send(command);
|
|
34
|
+
* // { // PurchaseProvisionedCapacityOutput
|
|
35
|
+
* // capacityId: "STRING_VALUE",
|
|
36
|
+
* // };
|
|
37
|
+
*
|
|
34
38
|
* ```
|
|
35
39
|
*
|
|
36
40
|
* @param PurchaseProvisionedCapacityCommandInput - {@link PurchaseProvisionedCapacityCommandInput}
|
|
@@ -51,6 +55,8 @@ export interface PurchaseProvisionedCapacityCommandOutput extends PurchaseProvis
|
|
|
51
55
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
52
56
|
* <p>Returned if the service cannot complete the request.</p>
|
|
53
57
|
*
|
|
58
|
+
* @throws {@link GlacierServiceException}
|
|
59
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
54
60
|
*
|
|
55
61
|
* @example To purchases a provisioned capacity unit for an AWS account
|
|
56
62
|
* ```javascript
|
|
@@ -38,6 +38,8 @@ export interface RemoveTagsFromVaultCommandOutput extends __MetadataBearer {
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new RemoveTagsFromVaultCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // {};
|
|
42
|
+
*
|
|
41
43
|
* ```
|
|
42
44
|
*
|
|
43
45
|
* @param RemoveTagsFromVaultCommandInput - {@link RemoveTagsFromVaultCommandInput}
|
|
@@ -59,6 +61,8 @@ export interface RemoveTagsFromVaultCommandOutput extends __MetadataBearer {
|
|
|
59
61
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
60
62
|
* <p>Returned if the service cannot complete the request.</p>
|
|
61
63
|
*
|
|
64
|
+
* @throws {@link GlacierServiceException}
|
|
65
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
62
66
|
*
|
|
63
67
|
* @example To remove tags from a vault
|
|
64
68
|
* ```javascript
|
|
@@ -44,6 +44,8 @@ export interface SetDataRetrievalPolicyCommandOutput extends __MetadataBearer {
|
|
|
44
44
|
* };
|
|
45
45
|
* const command = new SetDataRetrievalPolicyCommand(input);
|
|
46
46
|
* const response = await client.send(command);
|
|
47
|
+
* // {};
|
|
48
|
+
*
|
|
47
49
|
* ```
|
|
48
50
|
*
|
|
49
51
|
* @param SetDataRetrievalPolicyCommandInput - {@link SetDataRetrievalPolicyCommandInput}
|
|
@@ -61,6 +63,8 @@ export interface SetDataRetrievalPolicyCommandOutput extends __MetadataBearer {
|
|
|
61
63
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
62
64
|
* <p>Returned if the service cannot complete the request.</p>
|
|
63
65
|
*
|
|
66
|
+
* @throws {@link GlacierServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
64
68
|
*
|
|
65
69
|
* @example To set and then enact a data retrieval policy
|
|
66
70
|
* ```javascript
|
|
@@ -40,6 +40,8 @@ export interface SetVaultAccessPolicyCommandOutput extends __MetadataBearer {
|
|
|
40
40
|
* };
|
|
41
41
|
* const command = new SetVaultAccessPolicyCommand(input);
|
|
42
42
|
* const response = await client.send(command);
|
|
43
|
+
* // {};
|
|
44
|
+
*
|
|
43
45
|
* ```
|
|
44
46
|
*
|
|
45
47
|
* @param SetVaultAccessPolicyCommandInput - {@link SetVaultAccessPolicyCommandInput}
|
|
@@ -61,6 +63,8 @@ export interface SetVaultAccessPolicyCommandOutput extends __MetadataBearer {
|
|
|
61
63
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
62
64
|
* <p>Returned if the service cannot complete the request.</p>
|
|
63
65
|
*
|
|
66
|
+
* @throws {@link GlacierServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
64
68
|
*
|
|
65
69
|
* @example To set the access-policy on a vault
|
|
66
70
|
* ```javascript
|
|
@@ -75,6 +75,8 @@ export interface SetVaultNotificationsCommandOutput extends __MetadataBearer {
|
|
|
75
75
|
* };
|
|
76
76
|
* const command = new SetVaultNotificationsCommand(input);
|
|
77
77
|
* const response = await client.send(command);
|
|
78
|
+
* // {};
|
|
79
|
+
*
|
|
78
80
|
* ```
|
|
79
81
|
*
|
|
80
82
|
* @param SetVaultNotificationsCommandInput - {@link SetVaultNotificationsCommandInput}
|
|
@@ -96,6 +98,8 @@ export interface SetVaultNotificationsCommandOutput extends __MetadataBearer {
|
|
|
96
98
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
97
99
|
* <p>Returned if the service cannot complete the request.</p>
|
|
98
100
|
*
|
|
101
|
+
* @throws {@link GlacierServiceException}
|
|
102
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
99
103
|
*
|
|
100
104
|
* @example To configure a vault to post a message to an Amazon SNS topic when jobs complete
|
|
101
105
|
* ```javascript
|
|
@@ -76,6 +76,12 @@ export interface UploadArchiveCommandOutput extends ArchiveCreationOutput, __Met
|
|
|
76
76
|
* };
|
|
77
77
|
* const command = new UploadArchiveCommand(input);
|
|
78
78
|
* const response = await client.send(command);
|
|
79
|
+
* // { // ArchiveCreationOutput
|
|
80
|
+
* // location: "STRING_VALUE",
|
|
81
|
+
* // checksum: "STRING_VALUE",
|
|
82
|
+
* // archiveId: "STRING_VALUE",
|
|
83
|
+
* // };
|
|
84
|
+
*
|
|
79
85
|
* ```
|
|
80
86
|
*
|
|
81
87
|
* @param UploadArchiveCommandInput - {@link UploadArchiveCommandInput}
|
|
@@ -101,6 +107,8 @@ export interface UploadArchiveCommandOutput extends ArchiveCreationOutput, __Met
|
|
|
101
107
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
102
108
|
* <p>Returned if the service cannot complete the request.</p>
|
|
103
109
|
*
|
|
110
|
+
* @throws {@link GlacierServiceException}
|
|
111
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
104
112
|
*
|
|
105
113
|
* @example To upload an archive
|
|
106
114
|
* ```javascript
|
|
@@ -96,6 +96,10 @@ export interface UploadMultipartPartCommandOutput extends UploadMultipartPartOut
|
|
|
96
96
|
* };
|
|
97
97
|
* const command = new UploadMultipartPartCommand(input);
|
|
98
98
|
* const response = await client.send(command);
|
|
99
|
+
* // { // UploadMultipartPartOutput
|
|
100
|
+
* // checksum: "STRING_VALUE",
|
|
101
|
+
* // };
|
|
102
|
+
*
|
|
99
103
|
* ```
|
|
100
104
|
*
|
|
101
105
|
* @param UploadMultipartPartCommandInput - {@link UploadMultipartPartCommandInput}
|
|
@@ -121,6 +125,8 @@ export interface UploadMultipartPartCommandOutput extends UploadMultipartPartOut
|
|
|
121
125
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
122
126
|
* <p>Returned if the service cannot complete the request.</p>
|
|
123
127
|
*
|
|
128
|
+
* @throws {@link GlacierServiceException}
|
|
129
|
+
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
124
130
|
*
|
|
125
131
|
* @example To upload the first part of an archive
|
|
126
132
|
* ```javascript
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-glacier",
|
|
3
3
|
"description": "AWS SDK for JavaScript Glacier Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.326.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -23,34 +23,34 @@
|
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
24
|
"@aws-sdk/body-checksum-browser": "3.310.0",
|
|
25
25
|
"@aws-sdk/body-checksum-node": "3.310.0",
|
|
26
|
-
"@aws-sdk/client-sts": "3.
|
|
26
|
+
"@aws-sdk/client-sts": "3.326.0",
|
|
27
27
|
"@aws-sdk/config-resolver": "3.310.0",
|
|
28
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
28
|
+
"@aws-sdk/credential-provider-node": "3.326.0",
|
|
29
29
|
"@aws-sdk/fetch-http-handler": "3.310.0",
|
|
30
30
|
"@aws-sdk/hash-node": "3.310.0",
|
|
31
31
|
"@aws-sdk/invalid-dependency": "3.310.0",
|
|
32
|
-
"@aws-sdk/middleware-content-length": "3.
|
|
33
|
-
"@aws-sdk/middleware-endpoint": "3.
|
|
34
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
35
|
-
"@aws-sdk/middleware-logger": "3.
|
|
36
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
37
|
-
"@aws-sdk/middleware-retry": "3.
|
|
38
|
-
"@aws-sdk/middleware-sdk-glacier": "3.
|
|
39
|
-
"@aws-sdk/middleware-serde": "3.
|
|
40
|
-
"@aws-sdk/middleware-signing": "3.
|
|
41
|
-
"@aws-sdk/middleware-stack": "3.
|
|
42
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
32
|
+
"@aws-sdk/middleware-content-length": "3.325.0",
|
|
33
|
+
"@aws-sdk/middleware-endpoint": "3.325.0",
|
|
34
|
+
"@aws-sdk/middleware-host-header": "3.325.0",
|
|
35
|
+
"@aws-sdk/middleware-logger": "3.325.0",
|
|
36
|
+
"@aws-sdk/middleware-recursion-detection": "3.325.0",
|
|
37
|
+
"@aws-sdk/middleware-retry": "3.325.0",
|
|
38
|
+
"@aws-sdk/middleware-sdk-glacier": "3.326.0",
|
|
39
|
+
"@aws-sdk/middleware-serde": "3.325.0",
|
|
40
|
+
"@aws-sdk/middleware-signing": "3.325.0",
|
|
41
|
+
"@aws-sdk/middleware-stack": "3.325.0",
|
|
42
|
+
"@aws-sdk/middleware-user-agent": "3.325.0",
|
|
43
43
|
"@aws-sdk/node-config-provider": "3.310.0",
|
|
44
44
|
"@aws-sdk/node-http-handler": "3.321.1",
|
|
45
45
|
"@aws-sdk/protocol-http": "3.310.0",
|
|
46
|
-
"@aws-sdk/smithy-client": "3.
|
|
46
|
+
"@aws-sdk/smithy-client": "3.325.0",
|
|
47
47
|
"@aws-sdk/types": "3.310.0",
|
|
48
48
|
"@aws-sdk/url-parser": "3.310.0",
|
|
49
49
|
"@aws-sdk/util-base64": "3.310.0",
|
|
50
50
|
"@aws-sdk/util-body-length-browser": "3.310.0",
|
|
51
51
|
"@aws-sdk/util-body-length-node": "3.310.0",
|
|
52
|
-
"@aws-sdk/util-defaults-mode-browser": "3.
|
|
53
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
52
|
+
"@aws-sdk/util-defaults-mode-browser": "3.325.0",
|
|
53
|
+
"@aws-sdk/util-defaults-mode-node": "3.325.0",
|
|
54
54
|
"@aws-sdk/util-endpoints": "3.319.0",
|
|
55
55
|
"@aws-sdk/util-retry": "3.310.0",
|
|
56
56
|
"@aws-sdk/util-stream-browser": "3.310.0",
|