@aws-sdk/client-s3 3.306.0 → 3.309.0

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

@@ -62,39 +62,39 @@ export interface DeleteObjectTaggingCommandOutput extends DeleteObjectTaggingOut
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
  *
- * @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

@@ -229,53 +229,53 @@ export interface GetObjectCommandOutput extends __WithSdkStreamMixin<GetObjectOu
  *  <p>The specified key does not exist.</p>
  *
  *
- * @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/ListBucketsCommand.d.ts

@@ -41,37 +41,6 @@ export interface ListBucketsCommandOutput extends ListBucketsOutput, __MetadataB
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
  *
- * @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.
- * const input = undefined;
- * const command = new ListBucketsCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "Buckets": [
- *     {
- *       "CreationDate": "2012-02-15T21: 03: 02.000Z",
- *       "Name": "examplebucket"
- *     },
- *     {
- *       "CreationDate": "2011-07-24T19: 33: 50.000Z",
- *       "Name": "examplebucket2"
- *     },
- *     {
- *       "CreationDate": "2010-12-17T00: 56: 49.000Z",
- *       "Name": "examplebucket3"
- *     }
- *   ],
- *   "Owner": {
- *     "DisplayName": "own-display-name",
- *     "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31"
- *   }
- * }
- * *\/
- * // example id: to-list-object-versions-1481910996058
- * ```
- *
  * @example To list all buckets
  * ```javascript
  * // The following example returns all the buckets owned by the sender of this request.

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

@@ -92,7 +92,7 @@ export interface ListObjectsV2CommandOutput extends ListObjectsV2Output, __Metad
  * ```javascript
  * // The following example retrieves object list. The request specifies max keys to limit response to include only 2 object keys.
  * const input = {
- *   "Bucket": "examplebucket",
+ *   "Bucket": "DOC-EXAMPLE-BUCKET",
  *   "MaxKeys": "2"
  * };
  * const command = new ListObjectsV2Command(input);
@@ -118,7 +118,7 @@ export interface ListObjectsV2CommandOutput extends ListObjectsV2Output, __Metad
  *   "IsTruncated": true,
  *   "KeyCount": "2",
  *   "MaxKeys": "2",
- *   "Name": "examplebucket",
+ *   "Name": "DOC-EXAMPLE-BUCKET",
  *   "NextContinuationToken": "1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI/EyIJg==",
  *   "Prefix": ""
  * }

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

@@ -177,68 +177,67 @@ export interface PutObjectCommandOutput extends PutObjectOutput, __MetadataBeare
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
  *
- * @example To upload an object
+ * @example To upload object and specify user-defined metadata
  * ```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. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.
  * const input = {
- *   "Body": "HappyFace.jpg",
+ *   "Body": "filetoupload",
  *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg"
+ *   "Key": "exampleobject",
+ *   "Metadata": {
+ *     "metadata1": "value1",
+ *     "metadata2": "value2"
+ *   }
  * };
  * const command = new PutObjectCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
  *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk"
+ *   "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0"
  * }
  * *\/
- * // example id: to-upload-an-object-1481760101010
+ * // example id: to-upload-object-and-specify-user-defined-metadata-1483396974757
  * ```
  *
- * @example To upload object and specify user-defined metadata
+ * @example To upload an object and specify optional 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 optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.
  * const input = {
- *   "Body": "filetoupload",
+ *   "Body": "c:\\HappyFace.jpg",
  *   "Bucket": "examplebucket",
- *   "Key": "exampleobject",
- *   "Metadata": {
- *     "metadata1": "value1",
- *     "metadata2": "value2"
- *   }
+ *   "Key": "HappyFace.jpg",
+ *   "Tagging": "key1=value1&key2=value2"
  * };
  * const command = new PutObjectCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
  *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0"
+ *   "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a"
  * }
  * *\/
- * // example id: to-upload-object-and-specify-user-defined-metadata-1483396974757
+ * // example id: to-upload-an-object-and-specify-optional-tags-1481762310955
  * ```
  *
- * @example To upload an object (specify optional headers)
+ * @example To upload an object and specify canned ACL.
  * ```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.
+ * // 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": "HappyFace.jpg",
+ *   "ACL": "authenticated-read",
+ *   "Body": "filetoupload",
  *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg",
- *   "ServerSideEncryption": "AES256",
- *   "StorageClass": "STANDARD_IA"
+ *   "Key": "exampleobject"
  * };
  * const command = new PutObjectCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
  *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "ServerSideEncryption": "AES256",
- *   "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp"
+ *   "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr"
  * }
  * *\/
- * // example id: to-upload-an-object-(specify-optional-headers)
+ * // example id: to-upload-an-object-and-specify-canned-acl-1483397779571
  * ```
  *
  * @example To create an object.
@@ -260,66 +259,67 @@ export interface PutObjectCommandOutput extends PutObjectOutput, __MetadataBeare
  * // example id: to-create-an-object-1483147613675
  * ```
  *
- * @example To upload an object and specify server-side encryption and object tags
+ * @example To upload an object
  * ```javascript
- * // The following example uploads and 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 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",
+ *   "Body": "HappyFace.jpg",
  *   "Bucket": "examplebucket",
- *   "Key": "exampleobject",
- *   "ServerSideEncryption": "AES256",
- *   "Tagging": "key1=value1&key2=value2"
+ *   "Key": "HappyFace.jpg"
  * };
  * const command = new PutObjectCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
  *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "ServerSideEncryption": "AES256",
- *   "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt"
+ *   "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk"
  * }
  * *\/
- * // example id: to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831
+ * // example id: to-upload-an-object-1481760101010
  * ```
  *
- * @example To upload an object and specify optional tags
+ * @example To upload an object (specify optional headers)
  * ```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 an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption.
  * const input = {
- *   "Body": "c:\\HappyFace.jpg",
+ *   "Body": "HappyFace.jpg",
  *   "Bucket": "examplebucket",
  *   "Key": "HappyFace.jpg",
- *   "Tagging": "key1=value1&key2=value2"
+ *   "ServerSideEncryption": "AES256",
+ *   "StorageClass": "STANDARD_IA"
  * };
  * const command = new PutObjectCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
  *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a"
+ *   "ServerSideEncryption": "AES256",
+ *   "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp"
  * }
  * *\/
- * // example id: to-upload-an-object-and-specify-optional-tags-1481762310955
+ * // example id: to-upload-an-object-(specify-optional-headers)
  * ```
  *
- * @example To upload an object and specify canned ACL.
+ * @example To upload an object and specify server-side encryption and object tags
  * ```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 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 = {
- *   "ACL": "authenticated-read",
  *   "Body": "filetoupload",
  *   "Bucket": "examplebucket",
- *   "Key": "exampleobject"
+ *   "Key": "exampleobject",
+ *   "ServerSideEncryption": "AES256",
+ *   "Tagging": "key1=value1&key2=value2"
  * };
  * const command = new PutObjectCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
  *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr"
+ *   "ServerSideEncryption": "AES256",
+ *   "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt"
  * }
  * *\/
- * // example id: to-upload-an-object-and-specify-canned-acl-1483397779571
+ * // example id: to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831
  * ```
  *
  */

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

@@ -226,15 +226,14 @@ export interface UploadPartCopyCommandOutput extends UploadPartCopyOutput, __Met
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
  *
- * @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);
@@ -242,22 +241,23 @@ export interface UploadPartCopyCommandOutput extends UploadPartCopyOutput, __Met
  * /* 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);
@@ -265,12 +265,12 @@ export interface UploadPartCopyCommandOutput extends UploadPartCopyOutput, __Met
  * /* 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
  * ```
  *
  */