@aws-sdk/client-s3 3.535.0 → 3.536.0

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

@@ -79,39 +79,39 @@ declare const DeleteObjectTaggingCommand_base: {
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
  * @public
- * @example To remove tag set from an object
+ * @example To remove tag set from an object version
  * ```javascript
- * // The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.
+ * // The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.
  * const input = {
  *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg"
+ *   "Key": "HappyFace.jpg",
+ *   "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
  * };
  * const command = new DeleteObjectTaggingCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "VersionId": "null"
+ *   "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
  * }
  * *\/
- * // example id: to-remove-tag-set-from-an-object-1483145342862
+ * // example id: to-remove-tag-set-from-an-object-version-1483145285913
  * ```
  *
- * @example To remove tag set from an object version
+ * @example To remove tag set from an object
  * ```javascript
- * // The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.
+ * // The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.
  * const input = {
  *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg",
- *   "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
+ *   "Key": "HappyFace.jpg"
  * };
  * const command = new DeleteObjectTaggingCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
+ *   "VersionId": "null"
  * }
  * *\/
- * // example id: to-remove-tag-set-from-an-object-version-1483145285913
+ * // example id: to-remove-tag-set-from-an-object-1483145342862
  * ```
  *
  */

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

@@ -275,53 +275,53 @@ declare const GetObjectCommand_base: {
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
  * @public
- * @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"
+ *   "Key": "HappyFace.jpg"
  * };
  * const command = new GetObjectCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
  *   "AcceptRanges": "bytes",
- *   "ContentLength": "10",
- *   "ContentRange": "bytes 0-9/43",
- *   "ContentType": "text/plain",
- *   "ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
- *   "LastModified": "Thu, 09 Oct 2014 22:57:28 GMT",
+ *   "ContentLength": "3191",
+ *   "ContentType": "image/jpeg",
+ *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
+ *   "LastModified": "Thu, 15 Dec 2016 01:19:41 GMT",
  *   "Metadata": {},
+ *   "TagCount": 2,
  *   "VersionId": "null"
  * }
  * *\/
- * // example id: to-retrieve-a-byte-range-of-an-object--1481832674603
+ * // example id: to-retrieve-an-object-1481827837012
  * ```
  *
- * @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"
+ *   "Key": "SampleFile.txt",
+ *   "Range": "bytes=0-9"
  * };
  * const command = new GetObjectCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
  *   "AcceptRanges": "bytes",
- *   "ContentLength": "3191",
- *   "ContentType": "image/jpeg",
- *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "LastModified": "Thu, 15 Dec 2016 01:19:41 GMT",
+ *   "ContentLength": "10",
+ *   "ContentRange": "bytes 0-9/43",
+ *   "ContentType": "text/plain",
+ *   "ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
+ *   "LastModified": "Thu, 09 Oct 2014 22:57:28 GMT",
  *   "Metadata": {},
- *   "TagCount": 2,
  *   "VersionId": "null"
  * }
  * *\/
- * // example id: to-retrieve-an-object-1481827837012
+ * // example id: to-retrieve-a-byte-range-of-an-object--1481832674603
  * ```
  *
  */

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

@@ -95,13 +95,12 @@ declare const GetObjectTaggingCommand_base: {
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
  * @public
- * @example To retrieve tag set of a specific object version
+ * @example To retrieve tag set of an object
  * ```javascript
- * // The following example retrieves tag set of an object. The request specifies object version.
+ * // The following example retrieves tag set of an object.
  * const input = {
  *   "Bucket": "examplebucket",
- *   "Key": "exampleobject",
- *   "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
+ *   "Key": "HappyFace.jpg"
  * };
  * const command = new GetObjectTaggingCommand(input);
  * const response = await client.send(command);
@@ -109,22 +108,27 @@ declare const GetObjectTaggingCommand_base: {
  * {
  *   "TagSet": [
  *     {
- *       "Key": "Key1",
- *       "Value": "Value1"
+ *       "Key": "Key4",
+ *       "Value": "Value4"
+ *     },
+ *     {
+ *       "Key": "Key3",
+ *       "Value": "Value3"
  *     }
  *   ],
- *   "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
+ *   "VersionId": "null"
  * }
  * *\/
- * // example id: to-retrieve-tag-set-of-a-specific-object-version-1483400283663
+ * // example id: to-retrieve-tag-set-of-an-object-1481833847896
  * ```
  *
- * @example To retrieve tag set of an object
+ * @example To retrieve tag set of a specific object version
  * ```javascript
- * // The following example retrieves tag set of an object.
+ * // The following example retrieves tag set of an object. The request specifies object version.
  * const input = {
  *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg"
+ *   "Key": "exampleobject",
+ *   "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
  * };
  * const command = new GetObjectTaggingCommand(input);
  * const response = await client.send(command);
@@ -132,18 +136,14 @@ declare const GetObjectTaggingCommand_base: {
  * {
  *   "TagSet": [
  *     {
- *       "Key": "Key4",
- *       "Value": "Value4"
- *     },
- *     {
- *       "Key": "Key3",
- *       "Value": "Value3"
+ *       "Key": "Key1",
+ *       "Value": "Value1"
  *     }
  *   ],
- *   "VersionId": "null"
+ *   "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
  * }
  * *\/
- * // example id: to-retrieve-tag-set-of-an-object-1481833847896
+ * // example id: to-retrieve-tag-set-of-a-specific-object-version-1483400283663
  * ```
  *
  */

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

@@ -154,7 +154,7 @@ declare const ListObjectVersionsCommand_base: {
  * @public
  * @example To list object versions
  * ```javascript
- * // The following example return versions of an object with specific key name prefix. The request limits the number of items returned to two. If there are are more than two object version, S3 returns NextToken in the response. You can specify this token value in your next request to fetch next set of object versions.
+ * // The following example returns versions of an object with specific key name prefix.
  * const input = {
  *   "Bucket": "examplebucket",
  *   "Prefix": "HappyFace.jpg"

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

@@ -233,23 +233,26 @@ declare const PutObjectCommand_base: {
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
  * @public
- * @example To create an object.
+ * @example To upload an object and specify server-side encryption and object tags
  * ```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. 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": "objectkey"
+ *   "Key": "exampleobject",
+ *   "ServerSideEncryption": "AES256",
+ *   "Tagging": "key1=value1&key2=value2"
  * };
  * const command = new PutObjectCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
  *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ"
+ *   "ServerSideEncryption": "AES256",
+ *   "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt"
  * }
  * *\/
- * // example id: to-create-an-object-1483147613675
+ * // example id: to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831
  * ```
  *
  * @example To upload object and specify user-defined metadata
@@ -275,6 +278,26 @@ declare const PutObjectCommand_base: {
  * // example id: to-upload-object-and-specify-user-defined-metadata-1483396974757
  * ```
  *
+ * @example To upload an object and specify canned ACL.
+ * ```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.
+ * const input = {
+ *   "ACL": "authenticated-read",
+ *   "Body": "filetoupload",
+ *   "Bucket": "examplebucket",
+ *   "Key": "exampleobject"
+ * };
+ * const command = new PutObjectCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
+ *   "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr"
+ * }
+ * *\/
+ * // example id: to-upload-an-object-and-specify-canned-acl-1483397779571
+ * ```
+ *
  * @example To upload 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.
@@ -294,24 +317,23 @@ declare const PutObjectCommand_base: {
  * // example id: to-upload-an-object-1481760101010
  * ```
  *
- * @example To upload an object and specify canned ACL.
+ * @example To create an object.
  * ```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. If the bucket is versioning enabled, S3 returns version ID in response.
  * const input = {
- *   "ACL": "authenticated-read",
  *   "Body": "filetoupload",
  *   "Bucket": "examplebucket",
- *   "Key": "exampleobject"
+ *   "Key": "objectkey"
  * };
  * const command = new PutObjectCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
  *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr"
+ *   "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ"
  * }
  * *\/
- * // example id: to-upload-an-object-and-specify-canned-acl-1483397779571
+ * // example id: to-create-an-object-1483147613675
  * ```
  *
  * @example To upload an object (specify optional headers)
@@ -356,28 +378,6 @@ declare const PutObjectCommand_base: {
  * // example id: to-upload-an-object-and-specify-optional-tags-1481762310955
  * ```
  *
- * @example To upload an object and specify server-side encryption and object 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.
- * const input = {
- *   "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 ==
- * {
- *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "ServerSideEncryption": "AES256",
- *   "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt"
- * }
- * *\/
- * // example id: to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831
- * ```
- *
  */
 export declare class PutObjectCommand extends PutObjectCommand_base {
 }

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

@@ -263,15 +263,14 @@ declare const UploadPartCopyCommand_base: {
  * <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
+ * @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 a specified byte range from an existing object as data source.
+ * // 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",
- *   "CopySourceRange": "bytes=1-100000",
  *   "Key": "examplelargeobject",
- *   "PartNumber": "2",
+ *   "PartNumber": "1",
  *   "UploadId": "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"
  * };
  * const command = new UploadPartCopyCommand(input);
@@ -279,22 +278,23 @@ declare const UploadPartCopyCommand_base: {
  * /* response ==
  * {
  *   "CopyPartResult": {
- *     "ETag": "\"65d16d19e65a7508a51f043180edcc36\"",
- *     "LastModified": "2016-12-29T21:44:28.000Z"
+ *     "ETag": "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
+ *     "LastModified": "2016-12-29T21:24:43.000Z"
  *   }
  * }
  * *\/
- * // example id: to-upload-a-part-by-copying-byte-range-from-an-existing-object-as-data-source-1483048068594
+ * // example id: to-upload-a-part-by-copying-data-from-an-existing-object-as-data-source-1483046746348
  * ```
  *
- * @example To upload a part by copying data from an existing object as data source
+ * @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 data from an existing object as data source.
+ * // 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": "1",
+ *   "PartNumber": "2",
  *   "UploadId": "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"
  * };
  * const command = new UploadPartCopyCommand(input);
@@ -302,12 +302,12 @@ declare const UploadPartCopyCommand_base: {
  * /* response ==
  * {
  *   "CopyPartResult": {
- *     "ETag": "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
- *     "LastModified": "2016-12-29T21:24:43.000Z"
+ *     "ETag": "\"65d16d19e65a7508a51f043180edcc36\"",
+ *     "LastModified": "2016-12-29T21:44:28.000Z"
  *   }
  * }
  * *\/
- * // example id: to-upload-a-part-by-copying-data-from-an-existing-object-as-data-source-1483046746348
+ * // example id: to-upload-a-part-by-copying-byte-range-from-an-existing-object-as-data-source-1483048068594
  * ```
  *
  */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-s3",
   "description": "AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native",
-  "version": "3.535.0",
+  "version": "3.536.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-s3",