@aws-sdk/client-s3 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.
Files changed (94) hide show
  1. package/dist-types/commands/AbortMultipartUploadCommand.d.ts +6 -0
  2. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +19 -0
  3. package/dist-types/commands/CopyObjectCommand.d.ts +23 -0
  4. package/dist-types/commands/CreateBucketCommand.d.ts +6 -0
  5. package/dist-types/commands/CreateMultipartUploadCommand.d.ts +18 -0
  6. package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +4 -0
  7. package/dist-types/commands/DeleteBucketCommand.d.ts +4 -0
  8. package/dist-types/commands/DeleteBucketCorsCommand.d.ts +4 -0
  9. package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +4 -0
  10. package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +4 -0
  11. package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +4 -0
  12. package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +4 -0
  13. package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +4 -0
  14. package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +4 -0
  15. package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +4 -0
  16. package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +4 -0
  17. package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +4 -0
  19. package/dist-types/commands/DeleteObjectCommand.d.ts +18 -10
  20. package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +17 -11
  21. package/dist-types/commands/DeleteObjectsCommand.d.ts +22 -0
  22. package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +4 -0
  23. package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +6 -0
  24. package/dist-types/commands/GetBucketAclCommand.d.ts +21 -0
  25. package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +37 -0
  26. package/dist-types/commands/GetBucketCorsCommand.d.ts +23 -0
  27. package/dist-types/commands/GetBucketEncryptionCommand.d.ts +16 -0
  28. package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +31 -0
  29. package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +33 -0
  30. package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +58 -0
  31. package/dist-types/commands/GetBucketLocationCommand.d.ts +6 -0
  32. package/dist-types/commands/GetBucketLoggingCommand.d.ts +21 -0
  33. package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +26 -0
  34. package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +63 -0
  35. package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +12 -0
  36. package/dist-types/commands/GetBucketPolicyCommand.d.ts +6 -0
  37. package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +8 -0
  38. package/dist-types/commands/GetBucketReplicationCommand.d.ts +69 -0
  39. package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +6 -0
  40. package/dist-types/commands/GetBucketTaggingCommand.d.ts +11 -0
  41. package/dist-types/commands/GetBucketVersioningCommand.d.ts +7 -0
  42. package/dist-types/commands/GetBucketWebsiteCommand.d.ts +30 -0
  43. package/dist-types/commands/GetObjectAclCommand.d.ts +22 -0
  44. package/dist-types/commands/GetObjectAttributesCommand.d.ts +35 -0
  45. package/dist-types/commands/GetObjectCommand.d.ts +43 -0
  46. package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +8 -0
  47. package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +15 -0
  48. package/dist-types/commands/GetObjectRetentionCommand.d.ts +9 -0
  49. package/dist-types/commands/GetObjectTaggingCommand.d.ts +12 -0
  50. package/dist-types/commands/GetObjectTorrentCommand.d.ts +7 -0
  51. package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +11 -0
  52. package/dist-types/commands/HeadBucketCommand.d.ts +4 -0
  53. package/dist-types/commands/HeadObjectCommand.d.ts +41 -0
  54. package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +42 -0
  55. package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +36 -0
  56. package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +38 -0
  57. package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +31 -0
  58. package/dist-types/commands/ListBucketsCommand.d.ts +15 -31
  59. package/dist-types/commands/ListMultipartUploadsCommand.d.ts +37 -0
  60. package/dist-types/commands/ListObjectVersionsCommand.d.ts +50 -0
  61. package/dist-types/commands/ListObjectsCommand.d.ts +34 -0
  62. package/dist-types/commands/ListObjectsV2Command.d.ts +38 -2
  63. package/dist-types/commands/ListPartsCommand.d.ts +37 -0
  64. package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +4 -0
  65. package/dist-types/commands/PutBucketAclCommand.d.ts +4 -0
  66. package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +4 -0
  67. package/dist-types/commands/PutBucketCorsCommand.d.ts +4 -0
  68. package/dist-types/commands/PutBucketEncryptionCommand.d.ts +4 -0
  69. package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +4 -0
  70. package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +4 -0
  71. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +4 -0
  72. package/dist-types/commands/PutBucketLoggingCommand.d.ts +4 -0
  73. package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +4 -0
  74. package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +4 -0
  75. package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +4 -0
  76. package/dist-types/commands/PutBucketPolicyCommand.d.ts +4 -0
  77. package/dist-types/commands/PutBucketReplicationCommand.d.ts +4 -0
  78. package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +4 -0
  79. package/dist-types/commands/PutBucketTaggingCommand.d.ts +4 -0
  80. package/dist-types/commands/PutBucketVersioningCommand.d.ts +4 -0
  81. package/dist-types/commands/PutBucketWebsiteCommand.d.ts +4 -0
  82. package/dist-types/commands/PutObjectAclCommand.d.ts +6 -0
  83. package/dist-types/commands/PutObjectCommand.d.ts +68 -49
  84. package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +6 -0
  85. package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +6 -0
  86. package/dist-types/commands/PutObjectRetentionCommand.d.ts +6 -0
  87. package/dist-types/commands/PutObjectTaggingCommand.d.ts +6 -0
  88. package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +4 -0
  89. package/dist-types/commands/RestoreObjectCommand.d.ts +7 -0
  90. package/dist-types/commands/SelectObjectContentCommand.d.ts +26 -0
  91. package/dist-types/commands/UploadPartCommand.d.ts +16 -0
  92. package/dist-types/commands/UploadPartCopyCommand.d.ts +33 -13
  93. package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +4 -0
  94. package/package.json +21 -21
@@ -61,6 +61,15 @@ export interface GetBucketTaggingCommandOutput extends GetBucketTaggingOutput, _
61
61
  * };
62
62
  * const command = new GetBucketTaggingCommand(input);
63
63
  * const response = await client.send(command);
64
+ * // { // GetBucketTaggingOutput
65
+ * // TagSet: [ // TagSet // required
66
+ * // { // Tag
67
+ * // Key: "STRING_VALUE", // required
68
+ * // Value: "STRING_VALUE", // required
69
+ * // },
70
+ * // ],
71
+ * // };
72
+ *
64
73
  * ```
65
74
  *
66
75
  * @param GetBucketTaggingCommandInput - {@link GetBucketTaggingCommandInput}
@@ -69,6 +78,8 @@ export interface GetBucketTaggingCommandOutput extends GetBucketTaggingOutput, _
69
78
  * @see {@link GetBucketTaggingCommandOutput} for command's `response` shape.
70
79
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
71
80
  *
81
+ * @throws {@link S3ServiceException}
82
+ * <p>Base exception class for all service exceptions from S3 service.</p>
72
83
  *
73
84
  * @example To get tag set associated with a bucket
74
85
  * ```javascript
@@ -54,6 +54,11 @@ export interface GetBucketVersioningCommandOutput extends GetBucketVersioningOut
54
54
  * };
55
55
  * const command = new GetBucketVersioningCommand(input);
56
56
  * const response = await client.send(command);
57
+ * // { // GetBucketVersioningOutput
58
+ * // Status: "Enabled" || "Suspended",
59
+ * // MFADelete: "Enabled" || "Disabled",
60
+ * // };
61
+ *
57
62
  * ```
58
63
  *
59
64
  * @param GetBucketVersioningCommandInput - {@link GetBucketVersioningCommandInput}
@@ -62,6 +67,8 @@ export interface GetBucketVersioningCommandOutput extends GetBucketVersioningOut
62
67
  * @see {@link GetBucketVersioningCommandOutput} for command's `response` shape.
63
68
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
64
69
  *
70
+ * @throws {@link S3ServiceException}
71
+ * <p>Base exception class for all service exceptions from S3 service.</p>
65
72
  *
66
73
  * @example To get bucket versioning configuration
67
74
  * ```javascript
@@ -52,6 +52,34 @@ export interface GetBucketWebsiteCommandOutput extends GetBucketWebsiteOutput, _
52
52
  * };
53
53
  * const command = new GetBucketWebsiteCommand(input);
54
54
  * const response = await client.send(command);
55
+ * // { // GetBucketWebsiteOutput
56
+ * // RedirectAllRequestsTo: { // RedirectAllRequestsTo
57
+ * // HostName: "STRING_VALUE", // required
58
+ * // Protocol: "http" || "https",
59
+ * // },
60
+ * // IndexDocument: { // IndexDocument
61
+ * // Suffix: "STRING_VALUE", // required
62
+ * // },
63
+ * // ErrorDocument: { // ErrorDocument
64
+ * // Key: "STRING_VALUE", // required
65
+ * // },
66
+ * // RoutingRules: [ // RoutingRules
67
+ * // { // RoutingRule
68
+ * // Condition: { // Condition
69
+ * // HttpErrorCodeReturnedEquals: "STRING_VALUE",
70
+ * // KeyPrefixEquals: "STRING_VALUE",
71
+ * // },
72
+ * // Redirect: { // Redirect
73
+ * // HostName: "STRING_VALUE",
74
+ * // HttpRedirectCode: "STRING_VALUE",
75
+ * // Protocol: "http" || "https",
76
+ * // ReplaceKeyPrefixWith: "STRING_VALUE",
77
+ * // ReplaceKeyWith: "STRING_VALUE",
78
+ * // },
79
+ * // },
80
+ * // ],
81
+ * // };
82
+ *
55
83
  * ```
56
84
  *
57
85
  * @param GetBucketWebsiteCommandInput - {@link GetBucketWebsiteCommandInput}
@@ -60,6 +88,8 @@ export interface GetBucketWebsiteCommandOutput extends GetBucketWebsiteOutput, _
60
88
  * @see {@link GetBucketWebsiteCommandOutput} for command's `response` shape.
61
89
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
62
90
  *
91
+ * @throws {@link S3ServiceException}
92
+ * <p>Base exception class for all service exceptions from S3 service.</p>
63
93
  *
64
94
  * @example To get bucket website configuration
65
95
  * ```javascript
@@ -75,6 +75,26 @@ export interface GetObjectAclCommandOutput extends GetObjectAclOutput, __Metadat
75
75
  * };
76
76
  * const command = new GetObjectAclCommand(input);
77
77
  * const response = await client.send(command);
78
+ * // { // GetObjectAclOutput
79
+ * // Owner: { // Owner
80
+ * // DisplayName: "STRING_VALUE",
81
+ * // ID: "STRING_VALUE",
82
+ * // },
83
+ * // Grants: [ // Grants
84
+ * // { // Grant
85
+ * // Grantee: { // Grantee
86
+ * // DisplayName: "STRING_VALUE",
87
+ * // EmailAddress: "STRING_VALUE",
88
+ * // ID: "STRING_VALUE",
89
+ * // URI: "STRING_VALUE",
90
+ * // Type: "CanonicalUser" || "AmazonCustomerByEmail" || "Group", // required
91
+ * // },
92
+ * // Permission: "FULL_CONTROL" || "WRITE" || "WRITE_ACP" || "READ" || "READ_ACP",
93
+ * // },
94
+ * // ],
95
+ * // RequestCharged: "requester",
96
+ * // };
97
+ *
78
98
  * ```
79
99
  *
80
100
  * @param GetObjectAclCommandInput - {@link GetObjectAclCommandInput}
@@ -86,6 +106,8 @@ export interface GetObjectAclCommandOutput extends GetObjectAclOutput, __Metadat
86
106
  * @throws {@link NoSuchKey} (client fault)
87
107
  * <p>The specified key does not exist.</p>
88
108
  *
109
+ * @throws {@link S3ServiceException}
110
+ * <p>Base exception class for all service exceptions from S3 service.</p>
89
111
  *
90
112
  * @example To retrieve object ACL
91
113
  * ```javascript
@@ -192,6 +192,39 @@ export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOut
192
192
  * };
193
193
  * const command = new GetObjectAttributesCommand(input);
194
194
  * const response = await client.send(command);
195
+ * // { // GetObjectAttributesOutput
196
+ * // DeleteMarker: true || false,
197
+ * // LastModified: new Date("TIMESTAMP"),
198
+ * // VersionId: "STRING_VALUE",
199
+ * // RequestCharged: "requester",
200
+ * // ETag: "STRING_VALUE",
201
+ * // Checksum: { // Checksum
202
+ * // ChecksumCRC32: "STRING_VALUE",
203
+ * // ChecksumCRC32C: "STRING_VALUE",
204
+ * // ChecksumSHA1: "STRING_VALUE",
205
+ * // ChecksumSHA256: "STRING_VALUE",
206
+ * // },
207
+ * // ObjectParts: { // GetObjectAttributesParts
208
+ * // TotalPartsCount: Number("int"),
209
+ * // PartNumberMarker: "STRING_VALUE",
210
+ * // NextPartNumberMarker: "STRING_VALUE",
211
+ * // MaxParts: Number("int"),
212
+ * // IsTruncated: true || false,
213
+ * // Parts: [ // PartsList
214
+ * // { // ObjectPart
215
+ * // PartNumber: Number("int"),
216
+ * // Size: Number("long"),
217
+ * // ChecksumCRC32: "STRING_VALUE",
218
+ * // ChecksumCRC32C: "STRING_VALUE",
219
+ * // ChecksumSHA1: "STRING_VALUE",
220
+ * // ChecksumSHA256: "STRING_VALUE",
221
+ * // },
222
+ * // ],
223
+ * // },
224
+ * // StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW",
225
+ * // ObjectSize: Number("long"),
226
+ * // };
227
+ *
195
228
  * ```
196
229
  *
197
230
  * @param GetObjectAttributesCommandInput - {@link GetObjectAttributesCommandInput}
@@ -203,6 +236,8 @@ export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOut
203
236
  * @throws {@link NoSuchKey} (client fault)
204
237
  * <p>The specified key does not exist.</p>
205
238
  *
239
+ * @throws {@link S3ServiceException}
240
+ * <p>Base exception class for all service exceptions from S3 service.</p>
206
241
  *
207
242
  */
208
243
  export declare class GetObjectAttributesCommand extends $Command<GetObjectAttributesCommandInput, GetObjectAttributesCommandOutput, S3ClientResolvedConfig> {
@@ -212,6 +212,47 @@ export interface GetObjectCommandOutput extends __WithSdkStreamMixin<GetObjectOu
212
212
  * };
213
213
  * const command = new GetObjectCommand(input);
214
214
  * const response = await client.send(command);
215
+ * // { // GetObjectOutput
216
+ * // Body: "STREAMING_BLOB_VALUE",
217
+ * // DeleteMarker: true || false,
218
+ * // AcceptRanges: "STRING_VALUE",
219
+ * // Expiration: "STRING_VALUE",
220
+ * // Restore: "STRING_VALUE",
221
+ * // LastModified: new Date("TIMESTAMP"),
222
+ * // ContentLength: Number("long"),
223
+ * // ETag: "STRING_VALUE",
224
+ * // ChecksumCRC32: "STRING_VALUE",
225
+ * // ChecksumCRC32C: "STRING_VALUE",
226
+ * // ChecksumSHA1: "STRING_VALUE",
227
+ * // ChecksumSHA256: "STRING_VALUE",
228
+ * // MissingMeta: Number("int"),
229
+ * // VersionId: "STRING_VALUE",
230
+ * // CacheControl: "STRING_VALUE",
231
+ * // ContentDisposition: "STRING_VALUE",
232
+ * // ContentEncoding: "STRING_VALUE",
233
+ * // ContentLanguage: "STRING_VALUE",
234
+ * // ContentRange: "STRING_VALUE",
235
+ * // ContentType: "STRING_VALUE",
236
+ * // Expires: new Date("TIMESTAMP"),
237
+ * // WebsiteRedirectLocation: "STRING_VALUE",
238
+ * // ServerSideEncryption: "AES256" || "aws:kms",
239
+ * // Metadata: { // Metadata
240
+ * // "<keys>": "STRING_VALUE",
241
+ * // },
242
+ * // SSECustomerAlgorithm: "STRING_VALUE",
243
+ * // SSECustomerKeyMD5: "STRING_VALUE",
244
+ * // SSEKMSKeyId: "STRING_VALUE",
245
+ * // BucketKeyEnabled: true || false,
246
+ * // StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW",
247
+ * // RequestCharged: "requester",
248
+ * // ReplicationStatus: "COMPLETE" || "PENDING" || "FAILED" || "REPLICA",
249
+ * // PartsCount: Number("int"),
250
+ * // TagCount: Number("int"),
251
+ * // ObjectLockMode: "GOVERNANCE" || "COMPLIANCE",
252
+ * // ObjectLockRetainUntilDate: new Date("TIMESTAMP"),
253
+ * // ObjectLockLegalHoldStatus: "ON" || "OFF",
254
+ * // };
255
+ *
215
256
  * ```
216
257
  *
217
258
  * @param GetObjectCommandInput - {@link GetObjectCommandInput}
@@ -226,6 +267,8 @@ export interface GetObjectCommandOutput extends __WithSdkStreamMixin<GetObjectOu
226
267
  * @throws {@link NoSuchKey} (client fault)
227
268
  * <p>The specified key does not exist.</p>
228
269
  *
270
+ * @throws {@link S3ServiceException}
271
+ * <p>Base exception class for all service exceptions from S3 service.</p>
229
272
  *
230
273
  * @example To retrieve an object
231
274
  * ```javascript
@@ -45,6 +45,12 @@ export interface GetObjectLegalHoldCommandOutput extends GetObjectLegalHoldOutpu
45
45
  * };
46
46
  * const command = new GetObjectLegalHoldCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // { // GetObjectLegalHoldOutput
49
+ * // LegalHold: { // ObjectLockLegalHold
50
+ * // Status: "ON" || "OFF",
51
+ * // },
52
+ * // };
53
+ *
48
54
  * ```
49
55
  *
50
56
  * @param GetObjectLegalHoldCommandInput - {@link GetObjectLegalHoldCommandInput}
@@ -53,6 +59,8 @@ export interface GetObjectLegalHoldCommandOutput extends GetObjectLegalHoldOutpu
53
59
  * @see {@link GetObjectLegalHoldCommandOutput} for command's `response` shape.
54
60
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
55
61
  *
62
+ * @throws {@link S3ServiceException}
63
+ * <p>Base exception class for all service exceptions from S3 service.</p>
56
64
  *
57
65
  */
58
66
  export declare class GetObjectLegalHoldCommand extends $Command<GetObjectLegalHoldCommandInput, GetObjectLegalHoldCommandOutput, S3ClientResolvedConfig> {
@@ -43,6 +43,19 @@ export interface GetObjectLockConfigurationCommandOutput extends GetObjectLockCo
43
43
  * };
44
44
  * const command = new GetObjectLockConfigurationCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // GetObjectLockConfigurationOutput
47
+ * // ObjectLockConfiguration: { // ObjectLockConfiguration
48
+ * // ObjectLockEnabled: "Enabled",
49
+ * // Rule: { // ObjectLockRule
50
+ * // DefaultRetention: { // DefaultRetention
51
+ * // Mode: "GOVERNANCE" || "COMPLIANCE",
52
+ * // Days: Number("int"),
53
+ * // Years: Number("int"),
54
+ * // },
55
+ * // },
56
+ * // },
57
+ * // };
58
+ *
46
59
  * ```
47
60
  *
48
61
  * @param GetObjectLockConfigurationCommandInput - {@link GetObjectLockConfigurationCommandInput}
@@ -51,6 +64,8 @@ export interface GetObjectLockConfigurationCommandOutput extends GetObjectLockCo
51
64
  * @see {@link GetObjectLockConfigurationCommandOutput} for command's `response` shape.
52
65
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
53
66
  *
67
+ * @throws {@link S3ServiceException}
68
+ * <p>Base exception class for all service exceptions from S3 service.</p>
54
69
  *
55
70
  */
56
71
  export declare class GetObjectLockConfigurationCommand extends $Command<GetObjectLockConfigurationCommandInput, GetObjectLockConfigurationCommandOutput, S3ClientResolvedConfig> {
@@ -44,6 +44,13 @@ export interface GetObjectRetentionCommandOutput extends GetObjectRetentionOutpu
44
44
  * };
45
45
  * const command = new GetObjectRetentionCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // { // GetObjectRetentionOutput
48
+ * // Retention: { // ObjectLockRetention
49
+ * // Mode: "GOVERNANCE" || "COMPLIANCE",
50
+ * // RetainUntilDate: new Date("TIMESTAMP"),
51
+ * // },
52
+ * // };
53
+ *
47
54
  * ```
48
55
  *
49
56
  * @param GetObjectRetentionCommandInput - {@link GetObjectRetentionCommandInput}
@@ -52,6 +59,8 @@ export interface GetObjectRetentionCommandOutput extends GetObjectRetentionOutpu
52
59
  * @see {@link GetObjectRetentionCommandOutput} for command's `response` shape.
53
60
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
54
61
  *
62
+ * @throws {@link S3ServiceException}
63
+ * <p>Base exception class for all service exceptions from S3 service.</p>
55
64
  *
56
65
  */
57
66
  export declare class GetObjectRetentionCommand extends $Command<GetObjectRetentionCommandInput, GetObjectRetentionCommandOutput, S3ClientResolvedConfig> {
@@ -63,6 +63,16 @@ export interface GetObjectTaggingCommandOutput extends GetObjectTaggingOutput, _
63
63
  * };
64
64
  * const command = new GetObjectTaggingCommand(input);
65
65
  * const response = await client.send(command);
66
+ * // { // GetObjectTaggingOutput
67
+ * // VersionId: "STRING_VALUE",
68
+ * // TagSet: [ // TagSet // required
69
+ * // { // Tag
70
+ * // Key: "STRING_VALUE", // required
71
+ * // Value: "STRING_VALUE", // required
72
+ * // },
73
+ * // ],
74
+ * // };
75
+ *
66
76
  * ```
67
77
  *
68
78
  * @param GetObjectTaggingCommandInput - {@link GetObjectTaggingCommandInput}
@@ -71,6 +81,8 @@ export interface GetObjectTaggingCommandOutput extends GetObjectTaggingOutput, _
71
81
  * @see {@link GetObjectTaggingCommandOutput} for command's `response` shape.
72
82
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
73
83
  *
84
+ * @throws {@link S3ServiceException}
85
+ * <p>Base exception class for all service exceptions from S3 service.</p>
74
86
  *
75
87
  * @example To retrieve tag set of a specific object version
76
88
  * ```javascript
@@ -50,6 +50,11 @@ export interface GetObjectTorrentCommandOutput extends __WithSdkStreamMixin<GetO
50
50
  * };
51
51
  * const command = new GetObjectTorrentCommand(input);
52
52
  * const response = await client.send(command);
53
+ * // { // GetObjectTorrentOutput
54
+ * // Body: "STREAMING_BLOB_VALUE",
55
+ * // RequestCharged: "requester",
56
+ * // };
57
+ *
53
58
  * ```
54
59
  *
55
60
  * @param GetObjectTorrentCommandInput - {@link GetObjectTorrentCommandInput}
@@ -58,6 +63,8 @@ export interface GetObjectTorrentCommandOutput extends __WithSdkStreamMixin<GetO
58
63
  * @see {@link GetObjectTorrentCommandOutput} for command's `response` shape.
59
64
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
60
65
  *
66
+ * @throws {@link S3ServiceException}
67
+ * <p>Base exception class for all service exceptions from S3 service.</p>
61
68
  *
62
69
  * @example To retrieve torrent files for an object
63
70
  * ```javascript
@@ -68,6 +68,15 @@ export interface GetPublicAccessBlockCommandOutput extends GetPublicAccessBlockO
68
68
  * };
69
69
  * const command = new GetPublicAccessBlockCommand(input);
70
70
  * const response = await client.send(command);
71
+ * // { // GetPublicAccessBlockOutput
72
+ * // PublicAccessBlockConfiguration: { // PublicAccessBlockConfiguration
73
+ * // BlockPublicAcls: true || false,
74
+ * // IgnorePublicAcls: true || false,
75
+ * // BlockPublicPolicy: true || false,
76
+ * // RestrictPublicBuckets: true || false,
77
+ * // },
78
+ * // };
79
+ *
71
80
  * ```
72
81
  *
73
82
  * @param GetPublicAccessBlockCommandInput - {@link GetPublicAccessBlockCommandInput}
@@ -76,6 +85,8 @@ export interface GetPublicAccessBlockCommandOutput extends GetPublicAccessBlockO
76
85
  * @see {@link GetPublicAccessBlockCommandOutput} for command's `response` shape.
77
86
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
78
87
  *
88
+ * @throws {@link S3ServiceException}
89
+ * <p>Base exception class for all service exceptions from S3 service.</p>
79
90
  *
80
91
  */
81
92
  export declare class GetPublicAccessBlockCommand extends $Command<GetPublicAccessBlockCommandInput, GetPublicAccessBlockCommandOutput, S3ClientResolvedConfig> {
@@ -42,6 +42,8 @@ export interface HeadBucketCommandOutput extends __MetadataBearer {
42
42
  * };
43
43
  * const command = new HeadBucketCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // {};
46
+ *
45
47
  * ```
46
48
  *
47
49
  * @param HeadBucketCommandInput - {@link HeadBucketCommandInput}
@@ -53,6 +55,8 @@ export interface HeadBucketCommandOutput extends __MetadataBearer {
53
55
  * @throws {@link NotFound} (client fault)
54
56
  * <p>The specified content does not exist.</p>
55
57
  *
58
+ * @throws {@link S3ServiceException}
59
+ * <p>Base exception class for all service exceptions from S3 service.</p>
56
60
  *
57
61
  * @example To determine if bucket exists
58
62
  * ```javascript
@@ -154,6 +154,45 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
154
154
  * };
155
155
  * const command = new HeadObjectCommand(input);
156
156
  * const response = await client.send(command);
157
+ * // { // HeadObjectOutput
158
+ * // DeleteMarker: true || false,
159
+ * // AcceptRanges: "STRING_VALUE",
160
+ * // Expiration: "STRING_VALUE",
161
+ * // Restore: "STRING_VALUE",
162
+ * // ArchiveStatus: "ARCHIVE_ACCESS" || "DEEP_ARCHIVE_ACCESS",
163
+ * // LastModified: new Date("TIMESTAMP"),
164
+ * // ContentLength: Number("long"),
165
+ * // ChecksumCRC32: "STRING_VALUE",
166
+ * // ChecksumCRC32C: "STRING_VALUE",
167
+ * // ChecksumSHA1: "STRING_VALUE",
168
+ * // ChecksumSHA256: "STRING_VALUE",
169
+ * // ETag: "STRING_VALUE",
170
+ * // MissingMeta: Number("int"),
171
+ * // VersionId: "STRING_VALUE",
172
+ * // CacheControl: "STRING_VALUE",
173
+ * // ContentDisposition: "STRING_VALUE",
174
+ * // ContentEncoding: "STRING_VALUE",
175
+ * // ContentLanguage: "STRING_VALUE",
176
+ * // ContentType: "STRING_VALUE",
177
+ * // Expires: new Date("TIMESTAMP"),
178
+ * // WebsiteRedirectLocation: "STRING_VALUE",
179
+ * // ServerSideEncryption: "AES256" || "aws:kms",
180
+ * // Metadata: { // Metadata
181
+ * // "<keys>": "STRING_VALUE",
182
+ * // },
183
+ * // SSECustomerAlgorithm: "STRING_VALUE",
184
+ * // SSECustomerKeyMD5: "STRING_VALUE",
185
+ * // SSEKMSKeyId: "STRING_VALUE",
186
+ * // BucketKeyEnabled: true || false,
187
+ * // StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW",
188
+ * // RequestCharged: "requester",
189
+ * // ReplicationStatus: "COMPLETE" || "PENDING" || "FAILED" || "REPLICA",
190
+ * // PartsCount: Number("int"),
191
+ * // ObjectLockMode: "GOVERNANCE" || "COMPLIANCE",
192
+ * // ObjectLockRetainUntilDate: new Date("TIMESTAMP"),
193
+ * // ObjectLockLegalHoldStatus: "ON" || "OFF",
194
+ * // };
195
+ *
157
196
  * ```
158
197
  *
159
198
  * @param HeadObjectCommandInput - {@link HeadObjectCommandInput}
@@ -165,6 +204,8 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
165
204
  * @throws {@link NotFound} (client fault)
166
205
  * <p>The specified content does not exist.</p>
167
206
  *
207
+ * @throws {@link S3ServiceException}
208
+ * <p>Base exception class for all service exceptions from S3 service.</p>
168
209
  *
169
210
  * @example To retrieve metadata of an object without returning the object itself
170
211
  * ```javascript
@@ -68,6 +68,46 @@ export interface ListBucketAnalyticsConfigurationsCommandOutput extends ListBuck
68
68
  * };
69
69
  * const command = new ListBucketAnalyticsConfigurationsCommand(input);
70
70
  * const response = await client.send(command);
71
+ * // { // ListBucketAnalyticsConfigurationsOutput
72
+ * // IsTruncated: true || false,
73
+ * // ContinuationToken: "STRING_VALUE",
74
+ * // NextContinuationToken: "STRING_VALUE",
75
+ * // AnalyticsConfigurationList: [ // AnalyticsConfigurationList
76
+ * // { // AnalyticsConfiguration
77
+ * // Id: "STRING_VALUE", // required
78
+ * // Filter: { // AnalyticsFilter Union: only one key present
79
+ * // Prefix: "STRING_VALUE",
80
+ * // Tag: { // Tag
81
+ * // Key: "STRING_VALUE", // required
82
+ * // Value: "STRING_VALUE", // required
83
+ * // },
84
+ * // And: { // AnalyticsAndOperator
85
+ * // Prefix: "STRING_VALUE",
86
+ * // Tags: [ // TagSet
87
+ * // {
88
+ * // Key: "STRING_VALUE", // required
89
+ * // Value: "STRING_VALUE", // required
90
+ * // },
91
+ * // ],
92
+ * // },
93
+ * // },
94
+ * // StorageClassAnalysis: { // StorageClassAnalysis
95
+ * // DataExport: { // StorageClassAnalysisDataExport
96
+ * // OutputSchemaVersion: "V_1", // required
97
+ * // Destination: { // AnalyticsExportDestination
98
+ * // S3BucketDestination: { // AnalyticsS3BucketDestination
99
+ * // Format: "CSV", // required
100
+ * // BucketAccountId: "STRING_VALUE",
101
+ * // Bucket: "STRING_VALUE", // required
102
+ * // Prefix: "STRING_VALUE",
103
+ * // },
104
+ * // },
105
+ * // },
106
+ * // },
107
+ * // },
108
+ * // ],
109
+ * // };
110
+ *
71
111
  * ```
72
112
  *
73
113
  * @param ListBucketAnalyticsConfigurationsCommandInput - {@link ListBucketAnalyticsConfigurationsCommandInput}
@@ -76,6 +116,8 @@ export interface ListBucketAnalyticsConfigurationsCommandOutput extends ListBuck
76
116
  * @see {@link ListBucketAnalyticsConfigurationsCommandOutput} for command's `response` shape.
77
117
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
78
118
  *
119
+ * @throws {@link S3ServiceException}
120
+ * <p>Base exception class for all service exceptions from S3 service.</p>
79
121
  *
80
122
  */
81
123
  export declare class ListBucketAnalyticsConfigurationsCommand extends $Command<ListBucketAnalyticsConfigurationsCommandInput, ListBucketAnalyticsConfigurationsCommandOutput, S3ClientResolvedConfig> {
@@ -54,6 +54,40 @@ export interface ListBucketIntelligentTieringConfigurationsCommandOutput extends
54
54
  * };
55
55
  * const command = new ListBucketIntelligentTieringConfigurationsCommand(input);
56
56
  * const response = await client.send(command);
57
+ * // { // ListBucketIntelligentTieringConfigurationsOutput
58
+ * // IsTruncated: true || false,
59
+ * // ContinuationToken: "STRING_VALUE",
60
+ * // NextContinuationToken: "STRING_VALUE",
61
+ * // IntelligentTieringConfigurationList: [ // IntelligentTieringConfigurationList
62
+ * // { // IntelligentTieringConfiguration
63
+ * // Id: "STRING_VALUE", // required
64
+ * // Filter: { // IntelligentTieringFilter
65
+ * // Prefix: "STRING_VALUE",
66
+ * // Tag: { // Tag
67
+ * // Key: "STRING_VALUE", // required
68
+ * // Value: "STRING_VALUE", // required
69
+ * // },
70
+ * // And: { // IntelligentTieringAndOperator
71
+ * // Prefix: "STRING_VALUE",
72
+ * // Tags: [ // TagSet
73
+ * // {
74
+ * // Key: "STRING_VALUE", // required
75
+ * // Value: "STRING_VALUE", // required
76
+ * // },
77
+ * // ],
78
+ * // },
79
+ * // },
80
+ * // Status: "Enabled" || "Disabled", // required
81
+ * // Tierings: [ // TieringList // required
82
+ * // { // Tiering
83
+ * // Days: Number("int"), // required
84
+ * // AccessTier: "ARCHIVE_ACCESS" || "DEEP_ARCHIVE_ACCESS", // required
85
+ * // },
86
+ * // ],
87
+ * // },
88
+ * // ],
89
+ * // };
90
+ *
57
91
  * ```
58
92
  *
59
93
  * @param ListBucketIntelligentTieringConfigurationsCommandInput - {@link ListBucketIntelligentTieringConfigurationsCommandInput}
@@ -62,6 +96,8 @@ export interface ListBucketIntelligentTieringConfigurationsCommandOutput extends
62
96
  * @see {@link ListBucketIntelligentTieringConfigurationsCommandOutput} for command's `response` shape.
63
97
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
64
98
  *
99
+ * @throws {@link S3ServiceException}
100
+ * <p>Base exception class for all service exceptions from S3 service.</p>
65
101
  *
66
102
  */
67
103
  export declare class ListBucketIntelligentTieringConfigurationsCommand extends $Command<ListBucketIntelligentTieringConfigurationsCommandInput, ListBucketIntelligentTieringConfigurationsCommandOutput, S3ClientResolvedConfig> {
@@ -67,6 +67,42 @@ export interface ListBucketInventoryConfigurationsCommandOutput extends ListBuck
67
67
  * };
68
68
  * const command = new ListBucketInventoryConfigurationsCommand(input);
69
69
  * const response = await client.send(command);
70
+ * // { // ListBucketInventoryConfigurationsOutput
71
+ * // ContinuationToken: "STRING_VALUE",
72
+ * // InventoryConfigurationList: [ // InventoryConfigurationList
73
+ * // { // InventoryConfiguration
74
+ * // Destination: { // InventoryDestination
75
+ * // S3BucketDestination: { // InventoryS3BucketDestination
76
+ * // AccountId: "STRING_VALUE",
77
+ * // Bucket: "STRING_VALUE", // required
78
+ * // Format: "CSV" || "ORC" || "Parquet", // required
79
+ * // Prefix: "STRING_VALUE",
80
+ * // Encryption: { // InventoryEncryption
81
+ * // SSES3: {},
82
+ * // SSEKMS: { // SSEKMS
83
+ * // KeyId: "STRING_VALUE", // required
84
+ * // },
85
+ * // },
86
+ * // },
87
+ * // },
88
+ * // IsEnabled: true || false, // required
89
+ * // Filter: { // InventoryFilter
90
+ * // Prefix: "STRING_VALUE", // required
91
+ * // },
92
+ * // Id: "STRING_VALUE", // required
93
+ * // IncludedObjectVersions: "All" || "Current", // required
94
+ * // OptionalFields: [ // InventoryOptionalFields
95
+ * // "Size" || "LastModifiedDate" || "StorageClass" || "ETag" || "IsMultipartUploaded" || "ReplicationStatus" || "EncryptionStatus" || "ObjectLockRetainUntilDate" || "ObjectLockMode" || "ObjectLockLegalHoldStatus" || "IntelligentTieringAccessTier" || "BucketKeyStatus" || "ChecksumAlgorithm",
96
+ * // ],
97
+ * // Schedule: { // InventorySchedule
98
+ * // Frequency: "Daily" || "Weekly", // required
99
+ * // },
100
+ * // },
101
+ * // ],
102
+ * // IsTruncated: true || false,
103
+ * // NextContinuationToken: "STRING_VALUE",
104
+ * // };
105
+ *
70
106
  * ```
71
107
  *
72
108
  * @param ListBucketInventoryConfigurationsCommandInput - {@link ListBucketInventoryConfigurationsCommandInput}
@@ -75,6 +111,8 @@ export interface ListBucketInventoryConfigurationsCommandOutput extends ListBuck
75
111
  * @see {@link ListBucketInventoryConfigurationsCommandOutput} for command's `response` shape.
76
112
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
77
113
  *
114
+ * @throws {@link S3ServiceException}
115
+ * <p>Base exception class for all service exceptions from S3 service.</p>
78
116
  *
79
117
  */
80
118
  export declare class ListBucketInventoryConfigurationsCommand extends $Command<ListBucketInventoryConfigurationsCommandInput, ListBucketInventoryConfigurationsCommandOutput, S3ClientResolvedConfig> {