@aws-sdk/client-s3 3.774.0 → 3.777.0

package/dist-types/commands/GetBucketWebsiteCommand.d.ts

@@ -101,28 +101,28 @@ declare const GetBucketWebsiteCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To get bucket website configuration
  * ```javascript
  * // The following example retrieves website configuration of a bucket.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket"
  * };
  * const command = new GetBucketWebsiteCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ErrorDocument": {
- *     "Key": "error.html"
+ *   ErrorDocument: {
+ *     Key: "error.html"
  *   },
- *   "IndexDocument": {
- *     "Suffix": "index.html"
+ *   IndexDocument: {
+ *     Suffix: "index.html"
  *   }
  * }
  * *\/
- * // example id: to-get-bucket-website-configuration-1483037016926
  * ```
  *
+ * @public
  */
 export declare class GetBucketWebsiteCommand extends GetBucketWebsiteCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetObjectAclCommand.d.ts

@@ -118,61 +118,61 @@ declare const GetObjectAclCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To retrieve object ACL
  * ```javascript
  * // The following example retrieves access control list (ACL) of an object.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg"
+ *   Bucket: "examplebucket",
+ *   Key: "HappyFace.jpg"
  * };
  * const command = new GetObjectAclCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Grants": [
+ *   Grants: [
  *     {
- *       "Grantee": {
- *         "DisplayName": "owner-display-name",
- *         "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
- *         "Type": "CanonicalUser"
+ *       Grantee: {
+ *         DisplayName: "owner-display-name",
+ *         ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
+ *         Type: "CanonicalUser"
  *       },
- *       "Permission": "WRITE"
+ *       Permission: "WRITE"
  *     },
  *     {
- *       "Grantee": {
- *         "DisplayName": "owner-display-name",
- *         "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
- *         "Type": "CanonicalUser"
+ *       Grantee: {
+ *         DisplayName: "owner-display-name",
+ *         ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
+ *         Type: "CanonicalUser"
  *       },
- *       "Permission": "WRITE_ACP"
+ *       Permission: "WRITE_ACP"
  *     },
  *     {
- *       "Grantee": {
- *         "DisplayName": "owner-display-name",
- *         "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
- *         "Type": "CanonicalUser"
+ *       Grantee: {
+ *         DisplayName: "owner-display-name",
+ *         ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
+ *         Type: "CanonicalUser"
  *       },
- *       "Permission": "READ"
+ *       Permission: "READ"
  *     },
  *     {
- *       "Grantee": {
- *         "DisplayName": "owner-display-name",
- *         "ID": "852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
- *         "Type": "CanonicalUser"
+ *       Grantee: {
+ *         DisplayName: "owner-display-name",
+ *         ID: "852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
+ *         Type: "CanonicalUser"
  *       },
- *       "Permission": "READ_ACP"
+ *       Permission: "READ_ACP"
  *     }
  *   ],
- *   "Owner": {
- *     "DisplayName": "owner-display-name",
- *     "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
+ *   Owner: {
+ *     DisplayName: "owner-display-name",
+ *     ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
  *   }
  * }
  * *\/
- * // example id: to-retrieve-object-acl-1481833557740
  * ```
  *
+ * @public
  */
 export declare class GetObjectAclCommand extends GetObjectAclCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetObjectAttributesCommand.d.ts

@@ -312,6 +312,7 @@ declare const GetObjectAttributesCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetObjectAttributesCommand extends GetObjectAttributesCommand_base {

package/dist-types/commands/GetObjectCommand.d.ts

@@ -235,6 +235,11 @@ declare const GetObjectCommand_base: {
  * };
  * const command = new GetObjectCommand(input);
  * const response = await client.send(command);
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.Body.transformToByteArray();
+ * // const str = await response.Body.transformToString();
+ * // response.Body.destroy(); // only applicable to Node.js Readable streams.
+ *
  * // { // GetObjectOutput
  * //   Body: "<SdkStream>", // see \@smithy/types -> StreamingBlobPayloadOutputTypes
  * //   DeleteMarker: true || false,
@@ -303,56 +308,65 @@ declare const GetObjectCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
- * @example To retrieve an object
+ *
+ * @example To retrieve a byte range of an object
  * ```javascript
- * // The following example retrieves an object for an S3 bucket.
+ * // The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg"
+ *   Bucket: "examplebucket",
+ *   Key: "SampleFile.txt",
+ *   Range: "bytes=0-9"
  * };
  * const command = new GetObjectCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.Body.transformToByteArray();
+ * // const str = await response.Body.transformToString();
+ * // response.Body.destroy(); // only applicable to Node.js Readable streams.
+ *
+ * /* response is
  * {
- *   "AcceptRanges": "bytes",
- *   "ContentLength": "3191",
- *   "ContentType": "image/jpeg",
- *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "LastModified": "2016-12-15T01:19:41.000Z",
- *   "Metadata": {},
- *   "TagCount": 2,
- *   "VersionId": "null"
+ *   AcceptRanges: "bytes",
+ *   ContentLength: 10,
+ *   ContentRange: "bytes 0-9/43",
+ *   ContentType: "text/plain",
+ *   ETag: `"0d94420ffd0bc68cd3d152506b97a9cc"`,
+ *   LastModified: "2014-10-09T22:57:28.000Z",
+ *   Metadata:   { /* empty *\/ },
+ *   VersionId: "null"
  * }
  * *\/
- * // example id: to-retrieve-an-object-1481827837012
  * ```
  *
- * @example To retrieve a byte range of an object
+ * @example To retrieve an object
  * ```javascript
- * // The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.
+ * // The following example retrieves an object for an S3 bucket.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "SampleFile.txt",
- *   "Range": "bytes=0-9"
+ *   Bucket: "examplebucket",
+ *   Key: "HappyFace.jpg"
  * };
  * const command = new GetObjectCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.Body.transformToByteArray();
+ * // const str = await response.Body.transformToString();
+ * // response.Body.destroy(); // only applicable to Node.js Readable streams.
+ *
+ * /* response is
  * {
- *   "AcceptRanges": "bytes",
- *   "ContentLength": "10",
- *   "ContentRange": "bytes 0-9/43",
- *   "ContentType": "text/plain",
- *   "ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
- *   "LastModified": "2014-10-09T22:57:28.000Z",
- *   "Metadata": {},
- *   "VersionId": "null"
+ *   AcceptRanges: "bytes",
+ *   ContentLength: 3191,
+ *   ContentType: "image/jpeg",
+ *   ETag: `"6805f2cfc46c0f04559748bb039d69ae"`,
+ *   LastModified: "2016-12-15T01:19:41.000Z",
+ *   Metadata:   { /* empty *\/ },
+ *   TagCount: 2,
+ *   VersionId: "null"
  * }
  * *\/
- * // example id: to-retrieve-a-byte-range-of-an-object--1481832674603
  * ```
  *
+ * @public
  */
 export declare class GetObjectCommand extends GetObjectCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetObjectLegalHoldCommand.d.ts

@@ -73,6 +73,7 @@ declare const GetObjectLegalHoldCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetObjectLegalHoldCommand extends GetObjectLegalHoldCommand_base {

package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts

@@ -77,6 +77,7 @@ declare const GetObjectLockConfigurationCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetObjectLockConfigurationCommand extends GetObjectLockConfigurationCommand_base {

package/dist-types/commands/GetObjectRetentionCommand.d.ts

@@ -74,6 +74,7 @@ declare const GetObjectRetentionCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetObjectRetentionCommand extends GetObjectRetentionCommand_base {

package/dist-types/commands/GetObjectTaggingCommand.d.ts

@@ -95,58 +95,57 @@ declare const GetObjectTaggingCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To retrieve tag set of a specific object version
  * ```javascript
  * // The following example retrieves tag set of an object. The request specifies object version.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "exampleobject",
- *   "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
+ *   Bucket: "examplebucket",
+ *   Key: "exampleobject",
+ *   VersionId: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
  * };
  * const command = new GetObjectTaggingCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "TagSet": [
+ *   TagSet: [
  *     {
- *       "Key": "Key1",
- *       "Value": "Value1"
+ *       Key: "Key1",
+ *       Value: "Value1"
  *     }
  *   ],
- *   "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
+ *   VersionId: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
  * }
  * *\/
- * // example id: to-retrieve-tag-set-of-a-specific-object-version-1483400283663
  * ```
  *
  * @example To retrieve tag set of an object
  * ```javascript
  * // The following example retrieves tag set of an object.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg"
+ *   Bucket: "examplebucket",
+ *   Key: "HappyFace.jpg"
  * };
  * const command = new GetObjectTaggingCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "TagSet": [
+ *   TagSet: [
  *     {
- *       "Key": "Key4",
- *       "Value": "Value4"
+ *       Key: "Key4",
+ *       Value: "Value4"
  *     },
  *     {
- *       "Key": "Key3",
- *       "Value": "Value3"
+ *       Key: "Key3",
+ *       Value: "Value3"
  *     }
  *   ],
- *   "VersionId": "null"
+ *   VersionId: "null"
  * }
  * *\/
- * // example id: to-retrieve-tag-set-of-an-object-1481833847896
  * ```
  *
+ * @public
  */
 export declare class GetObjectTaggingCommand extends GetObjectTaggingCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetObjectTorrentCommand.d.ts

@@ -62,6 +62,11 @@ declare const GetObjectTorrentCommand_base: {
  * };
  * const command = new GetObjectTorrentCommand(input);
  * const response = await client.send(command);
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.Body.transformToByteArray();
+ * // const str = await response.Body.transformToString();
+ * // response.Body.destroy(); // only applicable to Node.js Readable streams.
+ *
  * // { // GetObjectTorrentOutput
  * //   Body: "<SdkStream>", // see \@smithy/types -> StreamingBlobPayloadOutputTypes
  * //   RequestCharged: "requester",
@@ -78,19 +83,27 @@ declare const GetObjectTorrentCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To retrieve torrent files for an object
  * ```javascript
  * // The following example retrieves torrent files of an object.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg"
+ *   Bucket: "examplebucket",
+ *   Key: "HappyFace.jpg"
  * };
  * const command = new GetObjectTorrentCommand(input);
- * await client.send(command);
- * // example id: to-retrieve-torrent-files-for-an-object-1481834115959
+ * const response = await client.send(command);
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.Body.transformToByteArray();
+ * // const str = await response.Body.transformToString();
+ * // response.Body.destroy(); // only applicable to Node.js Readable streams.
+ *
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class GetObjectTorrentCommand extends GetObjectTorrentCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetPublicAccessBlockCommand.d.ts

@@ -99,6 +99,7 @@ declare const GetPublicAccessBlockCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetPublicAccessBlockCommand extends GetPublicAccessBlockCommand_base {

package/dist-types/commands/HeadBucketCommand.d.ts

@@ -129,18 +129,21 @@ declare const HeadBucketCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To determine if bucket exists
  * ```javascript
  * // This operation checks to see if a bucket exists.
  * const input = {
- *   "Bucket": "acl1"
+ *   Bucket: "acl1"
  * };
  * const command = new HeadBucketCommand(input);
- * await client.send(command);
- * // example id: to-determine-if-bucket-exists-1473110292262
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class HeadBucketCommand extends HeadBucketCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/HeadObjectCommand.d.ts

@@ -278,30 +278,30 @@ declare const HeadObjectCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To retrieve metadata of an object without returning the object itself
  * ```javascript
  * // The following example retrieves an object metadata.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg"
+ *   Bucket: "examplebucket",
+ *   Key: "HappyFace.jpg"
  * };
  * const command = new HeadObjectCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "AcceptRanges": "bytes",
- *   "ContentLength": "3191",
- *   "ContentType": "image/jpeg",
- *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "LastModified": "2016-12-15T01:19:41.000Z",
- *   "Metadata": {},
- *   "VersionId": "null"
+ *   AcceptRanges: "bytes",
+ *   ContentLength: 3191,
+ *   ContentType: "image/jpeg",
+ *   ETag: `"6805f2cfc46c0f04559748bb039d69ae"`,
+ *   LastModified: "2016-12-15T01:19:41.000Z",
+ *   Metadata:   { /* empty *\/ },
+ *   VersionId: "null"
  * }
  * *\/
- * // example id: to-retrieve-metadata-of-an-object-without-returning-the-object-itself-1481834820480
  * ```
  *
+ * @public
  */
 export declare class HeadObjectCommand extends HeadObjectCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts

@@ -130,6 +130,7 @@ declare const ListBucketAnalyticsConfigurationsCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class ListBucketAnalyticsConfigurationsCommand extends ListBucketAnalyticsConfigurationsCommand_base {

package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts

@@ -109,6 +109,7 @@ declare const ListBucketIntelligentTieringConfigurationsCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class ListBucketIntelligentTieringConfigurationsCommand extends ListBucketIntelligentTieringConfigurationsCommand_base {

package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts

@@ -125,6 +125,7 @@ declare const ListBucketInventoryConfigurationsCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class ListBucketInventoryConfigurationsCommand extends ListBucketInventoryConfigurationsCommand_base {

package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts

@@ -119,6 +119,7 @@ declare const ListBucketMetricsConfigurationsCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class ListBucketMetricsConfigurationsCommand extends ListBucketMetricsConfigurationsCommand_base {

package/dist-types/commands/ListBucketsCommand.d.ts

@@ -82,38 +82,38 @@ declare const ListBucketsCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To list all buckets
  * ```javascript
  * // The following example returns all the buckets owned by the sender of this request.
- * const input = {};
+ * const input = { /* empty *\/ };
  * const command = new ListBucketsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Buckets": [
+ *   Buckets: [
  *     {
- *       "CreationDate": "2012-02-15T21:03:02.000Z",
- *       "Name": "examplebucket"
+ *       CreationDate: "2012-02-15T21:03:02.000Z",
+ *       Name: "examplebucket"
  *     },
  *     {
- *       "CreationDate": "2011-07-24T19:33:50.000Z",
- *       "Name": "examplebucket2"
+ *       CreationDate: "2011-07-24T19:33:50.000Z",
+ *       Name: "examplebucket2"
  *     },
  *     {
- *       "CreationDate": "2010-12-17T00:56:49.000Z",
- *       "Name": "examplebucket3"
+ *       CreationDate: "2010-12-17T00:56:49.000Z",
+ *       Name: "examplebucket3"
  *     }
  *   ],
- *   "Owner": {
- *     "DisplayName": "own-display-name",
- *     "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31"
+ *   Owner: {
+ *     DisplayName: "own-display-name",
+ *     ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31"
  *   }
  * }
  * *\/
- * // example id: to-list-buckets-1481910996058
  * ```
  *
+ * @public
  */
 export declare class ListBucketsCommand extends ListBucketsCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/ListDirectoryBucketsCommand.d.ts

@@ -90,6 +90,7 @@ declare const ListDirectoryBucketsCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class ListDirectoryBucketsCommand extends ListDirectoryBucketsCommand_base {