@aws-sdk/client-s3 3.775.0 → 3.779.0

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

@@ -300,152 +300,146 @@ declare const PutObjectCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
- * @example To upload an object
+ *
+ * @example To create an object.
  * ```javascript
- * // The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.
+ * // The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
  * const input = {
- *   "Body": "HappyFace.jpg",
- *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg"
+ *   Body: "filetoupload",
+ *   Bucket: "examplebucket",
+ *   Key: "objectkey"
  * };
  * const command = new PutObjectCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk"
+ *   ETag: `"6805f2cfc46c0f04559748bb039d69ae"`,
+ *   VersionId: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ"
  * }
  * *\/
- * // example id: to-upload-an-object-1481760101010
  * ```
  *
  * @example To upload an object (specify optional headers)
  * ```javascript
  * // The following example uploads an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption.
  * const input = {
- *   "Body": "HappyFace.jpg",
- *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg",
- *   "ServerSideEncryption": "AES256",
- *   "StorageClass": "STANDARD_IA"
+ *   Body: "HappyFace.jpg",
+ *   Bucket: "examplebucket",
+ *   Key: "HappyFace.jpg",
+ *   ServerSideEncryption: "AES256",
+ *   StorageClass: "STANDARD_IA"
  * };
  * const command = new PutObjectCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "ServerSideEncryption": "AES256",
- *   "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp"
+ *   ETag: `"6805f2cfc46c0f04559748bb039d69ae"`,
+ *   ServerSideEncryption: "AES256",
+ *   VersionId: "CG612hodqujkf8FaaNfp8U..FIhLROcp"
  * }
  * *\/
- * // example id: to-upload-an-object-(specify-optional-headers)
  * ```
  *
- * @example To create an object.
+ * @example To upload an object
  * ```javascript
- * // The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
+ * // The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.
  * const input = {
- *   "Body": "filetoupload",
- *   "Bucket": "examplebucket",
- *   "Key": "objectkey"
+ *   Body: "HappyFace.jpg",
+ *   Bucket: "examplebucket",
+ *   Key: "HappyFace.jpg"
  * };
  * const command = new PutObjectCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ"
+ *   ETag: `"6805f2cfc46c0f04559748bb039d69ae"`,
+ *   VersionId: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk"
  * }
  * *\/
- * // example id: to-create-an-object-1483147613675
  * ```
  *
- * @example To upload an object and specify optional tags
+ * @example To upload an object and specify canned ACL.
  * ```javascript
- * // The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.
+ * // The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
  * const input = {
- *   "Body": "c:\\HappyFace.jpg",
- *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg",
- *   "Tagging": "key1=value1&key2=value2"
+ *   ACL: "authenticated-read",
+ *   Body: "filetoupload",
+ *   Bucket: "examplebucket",
+ *   Key: "exampleobject"
  * };
  * const command = new PutObjectCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a"
+ *   ETag: `"6805f2cfc46c0f04559748bb039d69ae"`,
+ *   VersionId: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr"
  * }
  * *\/
- * // example id: to-upload-an-object-and-specify-optional-tags-1481762310955
  * ```
  *
- * @example To upload an object and specify server-side encryption and object tags
+ * @example To upload an object and specify optional tags
  * ```javascript
- * // The following example uploads an object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
+ * // The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.
  * const input = {
- *   "Body": "filetoupload",
- *   "Bucket": "examplebucket",
- *   "Key": "exampleobject",
- *   "ServerSideEncryption": "AES256",
- *   "Tagging": "key1=value1&key2=value2"
+ *   Body: "c:\HappyFace.jpg",
+ *   Bucket: "examplebucket",
+ *   Key: "HappyFace.jpg",
+ *   Tagging: "key1=value1&key2=value2"
  * };
  * const command = new PutObjectCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "ServerSideEncryption": "AES256",
- *   "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt"
+ *   ETag: `"6805f2cfc46c0f04559748bb039d69ae"`,
+ *   VersionId: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a"
  * }
  * *\/
- * // example id: to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831
  * ```
  *
- * @example To upload object and specify user-defined metadata
+ * @example To upload an object and specify server-side encryption and object tags
  * ```javascript
- * // The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.
+ * // The following example uploads an object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
  * const input = {
- *   "Body": "filetoupload",
- *   "Bucket": "examplebucket",
- *   "Key": "exampleobject",
- *   "Metadata": {
- *     "metadata1": "value1",
- *     "metadata2": "value2"
- *   }
+ *   Body: "filetoupload",
+ *   Bucket: "examplebucket",
+ *   Key: "exampleobject",
+ *   ServerSideEncryption: "AES256",
+ *   Tagging: "key1=value1&key2=value2"
  * };
  * const command = new PutObjectCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0"
+ *   ETag: `"6805f2cfc46c0f04559748bb039d69ae"`,
+ *   ServerSideEncryption: "AES256",
+ *   VersionId: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt"
  * }
  * *\/
- * // example id: to-upload-object-and-specify-user-defined-metadata-1483396974757
  * ```
  *
- * @example To upload an object and specify canned ACL.
+ * @example To upload object and specify user-defined metadata
  * ```javascript
- * // The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
+ * // The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.
  * const input = {
- *   "ACL": "authenticated-read",
- *   "Body": "filetoupload",
- *   "Bucket": "examplebucket",
- *   "Key": "exampleobject"
+ *   Body: "filetoupload",
+ *   Bucket: "examplebucket",
+ *   Key: "exampleobject",
+ *   Metadata: {
+ *     metadata1: "value1",
+ *     metadata2: "value2"
+ *   }
  * };
  * const command = new PutObjectCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr"
+ *   ETag: `"6805f2cfc46c0f04559748bb039d69ae"`,
+ *   VersionId: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0"
  * }
  * *\/
- * // example id: to-upload-an-object-and-specify-canned-acl-1483397779571
  * ```
  *
+ * @public
  */
 export declare class PutObjectCommand extends PutObjectCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

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

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

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

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

@@ -123,36 +123,36 @@ declare const PutObjectTaggingCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To add tags to an existing object
  * ```javascript
  * // The following example adds tags to an existing object.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg",
- *   "Tagging": {
- *     "TagSet": [
+ *   Bucket: "examplebucket",
+ *   Key: "HappyFace.jpg",
+ *   Tagging: {
+ *     TagSet: [
  *       {
- *         "Key": "Key3",
- *         "Value": "Value3"
+ *         Key: "Key3",
+ *         Value: "Value3"
  *       },
  *       {
- *         "Key": "Key4",
- *         "Value": "Value4"
+ *         Key: "Key4",
+ *         Value: "Value4"
  *       }
  *     ]
  *   }
  * };
  * const command = new PutObjectTaggingCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "VersionId": "null"
+ *   VersionId: "null"
  * }
  * *\/
- * // example id: to-add-tags-to-an-existing-object-1481764668793
  * ```
  *
+ * @public
  */
 export declare class PutObjectTaggingCommand extends PutObjectTaggingCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

@@ -71,10 +71,9 @@ declare const RestoreObjectCommand_base: {
  *             </dd>
  *             <dt>Restoring objects</dt>
  *             <dd>
- *                <p>Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval
- *                   or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or
+ *                <p>Objects that you archive to the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or
  *                   S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the
- *                   S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive
+ *                   S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive
  *                   storage classes, you must first initiate a restore request, and then wait until a
  *                   temporary copy of the object is available. If you want a permanent copy of the
  *                   object, create a copy of it in the Amazon S3 Standard storage class in your S3 bucket.
@@ -90,8 +89,7 @@ declare const RestoreObjectCommand_base: {
  *                   <li>
  *                      <p>
  *                         <code>Expedited</code> - Expedited retrievals allow you to quickly access
- *                         your data stored in the S3 Glacier Flexible Retrieval Flexible Retrieval
- *                         storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests
+ *                         your data stored in the S3 Glacier Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests
  *                         for restoring archives are required. For all but the largest archived
  *                         objects (250 MB+), data accessed using Expedited retrievals is typically
  *                         made available within 1–5 minutes. Provisioned capacity ensures that
@@ -106,7 +104,7 @@ declare const RestoreObjectCommand_base: {
  *                         your archived objects within several hours. This is the default option for
  *                         retrieval requests that do not specify the retrieval option. Standard
  *                         retrievals typically finish within 3–5 hours for objects stored in the
- *                         S3 Glacier Flexible Retrieval Flexible Retrieval storage class or
+ *                         S3 Glacier Flexible Retrieval storage class or
  *                         S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for
  *                         objects stored in the S3 Glacier Deep Archive storage class or
  *                         S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored
@@ -118,7 +116,7 @@ declare const RestoreObjectCommand_base: {
  *                         S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage classes,
  *                         enabling you to retrieve large amounts, even petabytes, of data at no cost.
  *                         Bulk retrievals typically finish within 5–12 hours for objects stored in the
- *                         S3 Glacier Flexible Retrieval Flexible Retrieval storage class or
+ *                         S3 Glacier Flexible Retrieval storage class or
  *                         S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost
  *                         retrieval option when restoring objects from
  *                         S3 Glacier Deep Archive. They typically finish within 48 hours for
@@ -348,25 +346,28 @@ declare const RestoreObjectCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To restore an archived object
  * ```javascript
  * // The following example restores for one day an archived copy of an object back into Amazon S3 bucket.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "archivedobjectkey",
- *   "RestoreRequest": {
- *     "Days": 1,
- *     "GlacierJobParameters": {
- *       "Tier": "Expedited"
+ *   Bucket: "examplebucket",
+ *   Key: "archivedobjectkey",
+ *   RestoreRequest: {
+ *     Days: 1,
+ *     GlacierJobParameters: {
+ *       Tier: "Expedited"
  *     }
  *   }
  * };
  * const command = new RestoreObjectCommand(input);
- * await client.send(command);
- * // example id: to-restore-an-archived-object-1483049329953
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class RestoreObjectCommand extends RestoreObjectCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

@@ -272,27 +272,27 @@ declare const UploadPartCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To upload a part
  * ```javascript
  * // The following example uploads part 1 of a multipart upload. The example specifies a file name for the part data. The Upload ID is same that is returned by the initiate multipart upload.
  * const input = {
- *   "Body": "fileToUpload",
- *   "Bucket": "examplebucket",
- *   "Key": "examplelargeobject",
- *   "PartNumber": "1",
- *   "UploadId": "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
+ *   Body: "fileToUpload",
+ *   Bucket: "examplebucket",
+ *   Key: "examplelargeobject",
+ *   PartNumber: 1,
+ *   UploadId: "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
  * };
  * const command = new UploadPartCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\""
+ *   ETag: `"d8c2eafd90c266e19ab9dcacc479f8af"`
  * }
  * *\/
- * // example id: to-upload-a-part-1481847914943
  * ```
  *
+ * @public
  */
 export declare class UploadPartCommand extends UploadPartCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -312,54 +312,53 @@ declare const UploadPartCopyCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To upload a part by copying byte range from an existing object as data source
  * ```javascript
  * // The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as data source.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "CopySource": "/bucketname/sourceobjectkey",
- *   "CopySourceRange": "bytes=1-100000",
- *   "Key": "examplelargeobject",
- *   "PartNumber": "2",
- *   "UploadId": "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"
+ *   Bucket: "examplebucket",
+ *   CopySource: "/bucketname/sourceobjectkey",
+ *   CopySourceRange: "bytes=1-100000",
+ *   Key: "examplelargeobject",
+ *   PartNumber: 2,
+ *   UploadId: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"
  * };
  * const command = new UploadPartCopyCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "CopyPartResult": {
- *     "ETag": "\"65d16d19e65a7508a51f043180edcc36\"",
- *     "LastModified": "2016-12-29T21:44:28.000Z"
+ *   CopyPartResult: {
+ *     ETag: `"65d16d19e65a7508a51f043180edcc36"`,
+ *     LastModified: "2016-12-29T21:44:28.000Z"
  *   }
  * }
  * *\/
- * // example id: to-upload-a-part-by-copying-byte-range-from-an-existing-object-as-data-source-1483048068594
  * ```
  *
  * @example To upload a part by copying data from an existing object as data source
  * ```javascript
  * // The following example uploads a part of a multipart upload by copying data from an existing object as data source.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "CopySource": "/bucketname/sourceobjectkey",
- *   "Key": "examplelargeobject",
- *   "PartNumber": "1",
- *   "UploadId": "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"
+ *   Bucket: "examplebucket",
+ *   CopySource: "/bucketname/sourceobjectkey",
+ *   Key: "examplelargeobject",
+ *   PartNumber: 1,
+ *   UploadId: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"
  * };
  * const command = new UploadPartCopyCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "CopyPartResult": {
- *     "ETag": "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
- *     "LastModified": "2016-12-29T21:24:43.000Z"
+ *   CopyPartResult: {
+ *     ETag: `"b0c6f0e7e054ab8fa2536a2677f8734d"`,
+ *     LastModified: "2016-12-29T21:24:43.000Z"
  *   }
  * }
  * *\/
- * // example id: to-upload-a-part-by-copying-data-from-an-existing-object-as-data-source-1483046746348
  * ```
  *
+ * @public
  */
 export declare class UploadPartCopyCommand extends UploadPartCopyCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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