@aws-sdk/client-s3 3.775.0 → 3.777.0

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

@@ -149,20 +149,23 @@ declare const AbortMultipartUploadCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To abort a multipart upload
  * ```javascript
  * // The following example aborts a multipart upload.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "bigobject",
- *   "UploadId": "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
+ *   Bucket: "examplebucket",
+ *   Key: "bigobject",
+ *   UploadId: "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
  * };
  * const command = new AbortMultipartUploadCommand(input);
- * await client.send(command);
- * // example id: to-abort-a-multipart-upload-1481853354987
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class AbortMultipartUploadCommand extends AbortMultipartUploadCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -267,40 +267,40 @@ declare const CompleteMultipartUploadCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To complete multipart upload
  * ```javascript
  * // The following example completes a multipart upload.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "bigobject",
- *   "MultipartUpload": {
- *     "Parts": [
+ *   Bucket: "examplebucket",
+ *   Key: "bigobject",
+ *   MultipartUpload: {
+ *     Parts: [
  *       {
- *         "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"",
- *         "PartNumber": "1"
+ *         ETag: `"d8c2eafd90c266e19ab9dcacc479f8af"`,
+ *         PartNumber: 1
  *       },
  *       {
- *         "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"",
- *         "PartNumber": "2"
+ *         ETag: `"d8c2eafd90c266e19ab9dcacc479f8af"`,
+ *         PartNumber: 2
  *       }
  *     ]
  *   },
- *   "UploadId": "7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
+ *   UploadId: "7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
  * };
  * const command = new CompleteMultipartUploadCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Bucket": "acexamplebucket",
- *   "ETag": "\"4d9031c7644d8081c2829f4ea23c55f7-2\"",
- *   "Key": "bigobject",
- *   "Location": "https://examplebucket.s3.<Region>.amazonaws.com/bigobject"
+ *   Bucket: "acexamplebucket",
+ *   ETag: `"4d9031c7644d8081c2829f4ea23c55f7-2"`,
+ *   Key: "bigobject",
+ *   Location: "https://examplebucket.s3.<Region>.amazonaws.com/bigobject"
  * }
  * *\/
- * // example id: to-complete-multipart-upload-1481851590483
  * ```
  *
+ * @public
  */
 export declare class CompleteMultipartUploadCommand extends CompleteMultipartUploadCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -322,28 +322,28 @@ declare const CopyObjectCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To copy an object
  * ```javascript
  * // The following example copies an object from one bucket to another.
  * const input = {
- *   "Bucket": "destinationbucket",
- *   "CopySource": "/sourcebucket/HappyFacejpg",
- *   "Key": "HappyFaceCopyjpg"
+ *   Bucket: "destinationbucket",
+ *   CopySource: "/sourcebucket/HappyFacejpg",
+ *   Key: "HappyFaceCopyjpg"
  * };
  * const command = new CopyObjectCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "CopyObjectResult": {
- *     "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *     "LastModified": "2016-12-15T17:38:53.000Z"
+ *   CopyObjectResult: {
+ *     ETag: `"6805f2cfc46c0f04559748bb039d69ae"`,
+ *     LastModified: "2016-12-15T17:38:53.000Z"
  *   }
  * }
  * *\/
- * // example id: to-copy-an-object-1481823186878
  * ```
  *
+ * @public
  */
 export declare class CopyObjectCommand extends CopyObjectCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -231,42 +231,41 @@ declare const CreateBucketCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
- * @example To create a bucket
+ *
+ * @example To create a bucket in a specific region
  * ```javascript
- * // The following example creates a bucket.
+ * // The following example creates a bucket. The request specifies an AWS region where to create the bucket.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket",
+ *   CreateBucketConfiguration: {
+ *     LocationConstraint: "eu-west-1"
+ *   }
  * };
  * const command = new CreateBucketCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Location": "/examplebucket"
+ *   Location: "http://examplebucket.<Region>.s3.amazonaws.com/"
  * }
  * *\/
- * // example id: to-create-a-bucket--1472851826060
  * ```
  *
- * @example To create a bucket in a specific region
+ * @example To create a bucket
  * ```javascript
- * // The following example creates a bucket. The request specifies an AWS region where to create the bucket.
+ * // The following example creates a bucket.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "CreateBucketConfiguration": {
- *     "LocationConstraint": "eu-west-1"
- *   }
+ *   Bucket: "examplebucket"
  * };
  * const command = new CreateBucketCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Location": "http://examplebucket.<Region>.s3.amazonaws.com/"
+ *   Location: "/examplebucket"
  * }
  * *\/
- * // example id: to-create-a-bucket-in-a-specific-region-1483399072992
  * ```
  *
+ * @public
  */
 export declare class CreateBucketCommand extends CreateBucketCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

@@ -365,26 +365,26 @@ declare const CreateMultipartUploadCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To initiate a multipart upload
  * ```javascript
  * // The following example initiates a multipart upload.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "largeobject"
+ *   Bucket: "examplebucket",
+ *   Key: "largeobject"
  * };
  * const command = new CreateMultipartUploadCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Bucket": "examplebucket",
- *   "Key": "largeobject",
- *   "UploadId": "ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--"
+ *   Bucket: "examplebucket",
+ *   Key: "largeobject",
+ *   UploadId: "ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--"
  * }
  * *\/
- * // example id: to-initiate-a-multipart-upload-1481836794513
  * ```
  *
+ * @public
  */
 export declare class CreateMultipartUploadCommand extends CreateMultipartUploadCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

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

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

@@ -110,18 +110,21 @@ declare const DeleteBucketCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To delete a bucket
  * ```javascript
  * // The following example deletes the specified bucket.
  * const input = {
- *   "Bucket": "forrandall2"
+ *   Bucket: "forrandall2"
  * };
  * const command = new DeleteBucketCommand(input);
- * await client.send(command);
- * // example id: to-delete-a-bucket-1473108514262
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteBucketCommand extends DeleteBucketCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -76,18 +76,21 @@ declare const DeleteBucketCorsCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To delete cors configuration on a bucket.
  * ```javascript
  * // The following example deletes CORS configuration on a bucket.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket"
  * };
  * const command = new DeleteBucketCorsCommand(input);
- * await client.send(command);
- * // example id: to-delete-cors-configuration-on-a-bucket-1483042856112
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteBucketCorsCommand extends DeleteBucketCorsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

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

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

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

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

@@ -122,18 +122,21 @@ declare const DeleteBucketLifecycleCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To delete lifecycle configuration on a bucket.
  * ```javascript
  * // The following example deletes lifecycle configuration on a bucket.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket"
  * };
  * const command = new DeleteBucketLifecycleCommand(input);
- * await client.send(command);
- * // example id: to-delete-lifecycle-configuration-on-a-bucket-1483043310583
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteBucketLifecycleCommand extends DeleteBucketLifecycleCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

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

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

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

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

@@ -119,18 +119,21 @@ declare const DeleteBucketPolicyCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To delete bucket policy
  * ```javascript
  * // The following example deletes bucket policy on the specified bucket.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket"
  * };
  * const command = new DeleteBucketPolicyCommand(input);
- * await client.send(command);
- * // example id: to-delete-bucket-policy-1483043406577
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteBucketPolicyCommand extends DeleteBucketPolicyCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -80,18 +80,21 @@ declare const DeleteBucketReplicationCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To delete bucket replication configuration
  * ```javascript
  * // The following example deletes replication configuration set on bucket.
  * const input = {
- *   "Bucket": "example"
+ *   Bucket: "example"
  * };
  * const command = new DeleteBucketReplicationCommand(input);
- * await client.send(command);
- * // example id: to-delete-bucket-replication-configuration-1483043684668
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteBucketReplicationCommand extends DeleteBucketReplicationCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -72,18 +72,21 @@ declare const DeleteBucketTaggingCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To delete bucket tags
  * ```javascript
  * // The following example deletes bucket tags.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket"
  * };
  * const command = new DeleteBucketTaggingCommand(input);
- * await client.send(command);
- * // example id: to-delete-bucket-tags-1483043846509
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteBucketTaggingCommand extends DeleteBucketTaggingCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -79,18 +79,21 @@ declare const DeleteBucketWebsiteCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To delete bucket website configuration
  * ```javascript
  * // The following example deletes bucket website configuration.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket"
  * };
  * const command = new DeleteBucketWebsiteCommand(input);
- * await client.send(command);
- * // example id: to-delete-bucket-website-configuration-1483043937825
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteBucketWebsiteCommand extends DeleteBucketWebsiteCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -164,31 +164,36 @@ declare const DeleteObjectCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
- * @example To delete an object
+ *
+ * @example To delete an object (from a non-versioned bucket)
  * ```javascript
- * // The following example deletes an object from an S3 bucket.
+ * // The following example deletes an object from a non-versioned bucket.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "objectkey.jpg"
+ *   Bucket: "ExampleBucket",
+ *   Key: "HappyFace.jpg"
  * };
  * const command = new DeleteObjectCommand(input);
- * await client.send(command);
- * // example id: to-delete-an-object-1472850136595
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
- * @example To delete an object (from a non-versioned bucket)
+ * @example To delete an object
  * ```javascript
- * // The following example deletes an object from a non-versioned bucket.
+ * // The following example deletes an object from an S3 bucket.
  * const input = {
- *   "Bucket": "ExampleBucket",
- *   "Key": "HappyFace.jpg"
+ *   Bucket: "examplebucket",
+ *   Key: "objectkey.jpg"
  * };
  * const command = new DeleteObjectCommand(input);
- * await client.send(command);
- * // example id: to-delete-an-object-from-a-non-versioned-bucket-1481588533089
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteObjectCommand extends DeleteObjectCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -79,42 +79,41 @@ declare const DeleteObjectTaggingCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To remove tag set from an object
  * ```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.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg"
+ *   Bucket: "examplebucket",
+ *   Key: "HappyFace.jpg"
  * };
  * const command = new DeleteObjectTaggingCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "VersionId": "null"
+ *   VersionId: "null"
  * }
  * *\/
- * // example id: to-remove-tag-set-from-an-object-1483145342862
  * ```
  *
  * @example To remove tag set from an object version
  * ```javascript
  * // 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",
- *   "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
+ *   Bucket: "examplebucket",
+ *   Key: "HappyFace.jpg",
+ *   VersionId: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
  * };
  * const command = new DeleteObjectTaggingCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
+ *   VersionId: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
  * }
  * *\/
- * // example id: to-remove-tag-set-from-an-object-version-1483145285913
  * ```
  *
+ * @public
  */
 export declare class DeleteObjectTaggingCommand extends DeleteObjectTaggingCommand_base {
     /** @internal type navigation helper, not in runtime. */