@aws-sdk/client-s3 3.288.0 → 3.289.0

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

@@ -67,6 +67,19 @@ export interface AbortMultipartUploadCommandOutput extends AbortMultipartUploadO
  * @see {@link AbortMultipartUploadCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To abort a multipart upload
+ * ```javascript
+ * // The following example aborts a multipart upload.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "Key": "bigobject",
+ *   "UploadId": "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
+ * };
+ * const command = new AbortMultipartUploadCommand(input);
+ * await client.send(command);
+ * // example id: to-abort-a-multipart-upload-1481853354987
+ * ```
+ *
  */
 export declare class AbortMultipartUploadCommand extends $Command<AbortMultipartUploadCommandInput, AbortMultipartUploadCommandOutput, S3ClientResolvedConfig> {
     readonly input: AbortMultipartUploadCommandInput;

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

@@ -139,6 +139,39 @@ export interface CompleteMultipartUploadCommandOutput extends CompleteMultipartU
  * @see {@link CompleteMultipartUploadCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To complete multipart upload
+ * ```javascript
+ * // The following example completes a multipart upload.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "Key": "bigobject",
+ *   "MultipartUpload": {
+ *     "Parts": [
+ *       {
+ *         "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"",
+ *         "PartNumber": "1"
+ *       },
+ *       {
+ *         "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"",
+ *         "PartNumber": "2"
+ *       }
+ *     ]
+ *   },
+ *   "UploadId": "7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
+ * };
+ * const command = new CompleteMultipartUploadCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Bucket": "acexamplebucket",
+ *   "ETag": "\"4d9031c7644d8081c2829f4ea23c55f7-2\"",
+ *   "Key": "bigobject",
+ *   "Location": "https://examplebucket.s3.<Region>.amazonaws.com/bigobject"
+ * }
+ * *\/
+ * // example id: to-complete-multipart-upload-1481851590483
+ * ```
+ *
  */
 export declare class CompleteMultipartUploadCommand extends $Command<CompleteMultipartUploadCommandInput, CompleteMultipartUploadCommandOutput, S3ClientResolvedConfig> {
     readonly input: CompleteMultipartUploadCommandInput;

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

@@ -212,6 +212,27 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea
  * @see {@link CopyObjectCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @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"
+ * };
+ * const command = new CopyObjectCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CopyObjectResult": {
+ *     "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
+ *     "LastModified": "2016-12-15T17:38:53.000Z"
+ *   }
+ * }
+ * *\/
+ * // example id: to-copy-an-object-1481823186878
+ * ```
+ *
  */
 export declare class CopyObjectCommand extends $Command<CopyObjectCommandInput, CopyObjectCommandOutput, S3ClientResolvedConfig> {
     readonly input: CopyObjectCommandInput;

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

@@ -174,6 +174,41 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat
  * @see {@link CreateBucketCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To create a bucket in a specific region
+ * ```javascript
+ * // The following example creates a bucket. The request specifies an AWS region where to create the bucket.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "CreateBucketConfiguration": {
+ *     "LocationConstraint": "eu-west-1"
+ *   }
+ * };
+ * const command = new CreateBucketCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Location": "http://examplebucket.<Region>.s3.amazonaws.com/"
+ * }
+ * *\/
+ * // example id: to-create-a-bucket-in-a-specific-region-1483399072992
+ * ```
+ *
+ * @example To create a bucket
+ * ```javascript
+ * // The following example creates a bucket.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new CreateBucketCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Location": "/examplebucket"
+ * }
+ * *\/
+ * // example id: to-create-a-bucket--1472851826060
+ * ```
+ *
  */
 export declare class CreateBucketCommand extends $Command<CreateBucketCommandInput, CreateBucketCommandOutput, S3ClientResolvedConfig> {
     readonly input: CreateBucketCommandInput;

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

@@ -296,6 +296,25 @@ export interface CreateMultipartUploadCommandOutput extends CreateMultipartUploa
  * @see {@link CreateMultipartUploadCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To initiate a multipart upload
+ * ```javascript
+ * // The following example initiates a multipart upload.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "Key": "largeobject"
+ * };
+ * const command = new CreateMultipartUploadCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Bucket": "examplebucket",
+ *   "Key": "largeobject",
+ *   "UploadId": "ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--"
+ * }
+ * *\/
+ * // example id: to-initiate-a-multipart-upload-1481836794513
+ * ```
+ *
  */
 export declare class CreateMultipartUploadCommand extends $Command<CreateMultipartUploadCommandInput, CreateMultipartUploadCommandOutput, S3ClientResolvedConfig> {
     readonly input: CreateMultipartUploadCommandInput;

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

@@ -45,6 +45,17 @@ export interface DeleteBucketCommandOutput extends __MetadataBearer {
  * @see {@link DeleteBucketCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To delete a bucket
+ * ```javascript
+ * // The following example deletes the specified bucket.
+ * const input = {
+ *   "Bucket": "forrandall2"
+ * };
+ * const command = new DeleteBucketCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-a-bucket-1473108514262
+ * ```
+ *
  */
 export declare class DeleteBucketCommand extends $Command<DeleteBucketCommandInput, DeleteBucketCommandOutput, S3ClientResolvedConfig> {
     readonly input: DeleteBucketCommandInput;

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

@@ -49,6 +49,17 @@ export interface DeleteBucketCorsCommandOutput extends __MetadataBearer {
  * @see {@link DeleteBucketCorsCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To delete cors configuration on a bucket.
+ * ```javascript
+ * // The following example deletes CORS configuration on a bucket.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new DeleteBucketCorsCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-cors-configuration-on-a-bucket-1483042856112
+ * ```
+ *
  */
 export declare class DeleteBucketCorsCommand extends $Command<DeleteBucketCorsCommandInput, DeleteBucketCorsCommandOutput, S3ClientResolvedConfig> {
     readonly input: DeleteBucketCorsCommandInput;

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

@@ -52,6 +52,17 @@ export interface DeleteBucketLifecycleCommandOutput extends __MetadataBearer {
  * @see {@link DeleteBucketLifecycleCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To delete lifecycle configuration on a bucket.
+ * ```javascript
+ * // The following example deletes lifecycle configuration on a bucket.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new DeleteBucketLifecycleCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-lifecycle-configuration-on-a-bucket-1483043310583
+ * ```
+ *
  */
 export declare class DeleteBucketLifecycleCommand extends $Command<DeleteBucketLifecycleCommandInput, DeleteBucketLifecycleCommandOutput, S3ClientResolvedConfig> {
     readonly input: DeleteBucketLifecycleCommandInput;

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

@@ -58,6 +58,17 @@ export interface DeleteBucketPolicyCommandOutput extends __MetadataBearer {
  * @see {@link DeleteBucketPolicyCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To delete bucket policy
+ * ```javascript
+ * // The following example deletes bucket policy on the specified bucket.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new DeleteBucketPolicyCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-bucket-policy-1483043406577
+ * ```
+ *
  */
 export declare class DeleteBucketPolicyCommand extends $Command<DeleteBucketPolicyCommandInput, DeleteBucketPolicyCommandOutput, S3ClientResolvedConfig> {
     readonly input: DeleteBucketPolicyCommandInput;

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

@@ -52,6 +52,17 @@ export interface DeleteBucketReplicationCommandOutput extends __MetadataBearer {
  * @see {@link DeleteBucketReplicationCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To delete bucket replication configuration
+ * ```javascript
+ * // The following example deletes replication configuration set on bucket.
+ * const input = {
+ *   "Bucket": "example"
+ * };
+ * const command = new DeleteBucketReplicationCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-bucket-replication-configuration-1483043684668
+ * ```
+ *
  */
 export declare class DeleteBucketReplicationCommand extends $Command<DeleteBucketReplicationCommandInput, DeleteBucketReplicationCommandOutput, S3ClientResolvedConfig> {
     readonly input: DeleteBucketReplicationCommandInput;

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

@@ -45,6 +45,17 @@ export interface DeleteBucketTaggingCommandOutput extends __MetadataBearer {
  * @see {@link DeleteBucketTaggingCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To delete bucket tags
+ * ```javascript
+ * // The following example deletes bucket tags.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new DeleteBucketTaggingCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-bucket-tags-1483043846509
+ * ```
+ *
  */
 export declare class DeleteBucketTaggingCommand extends $Command<DeleteBucketTaggingCommandInput, DeleteBucketTaggingCommandOutput, S3ClientResolvedConfig> {
     readonly input: DeleteBucketTaggingCommandInput;

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

@@ -52,6 +52,17 @@ export interface DeleteBucketWebsiteCommandOutput extends __MetadataBearer {
  * @see {@link DeleteBucketWebsiteCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To delete bucket website configuration
+ * ```javascript
+ * // The following example deletes bucket website configuration.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new DeleteBucketWebsiteCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-bucket-website-configuration-1483043937825
+ * ```
+ *
  */
 export declare class DeleteBucketWebsiteCommand extends $Command<DeleteBucketWebsiteCommandInput, DeleteBucketWebsiteCommandOutput, S3ClientResolvedConfig> {
     readonly input: DeleteBucketWebsiteCommandInput;

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

@@ -54,6 +54,30 @@ export interface DeleteObjectCommandOutput extends DeleteObjectOutput, __Metadat
  * @see {@link DeleteObjectCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To delete an object (from a non-versioned bucket)
+ * ```javascript
+ * // The following example deletes an object from a non-versioned bucket.
+ * const input = {
+ *   "Bucket": "ExampleBucket",
+ *   "Key": "HappyFace.jpg"
+ * };
+ * const command = new DeleteObjectCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-an-object-from-a-non-versioned-bucket-1481588533089
+ * ```
+ *
+ * @example To delete an object
+ * ```javascript
+ * // The following example deletes an object from an S3 bucket.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "Key": "objectkey.jpg"
+ * };
+ * const command = new DeleteObjectCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-an-object-1472850136595
+ * ```
+ *
  */
 export declare class DeleteObjectCommand extends $Command<DeleteObjectCommandInput, DeleteObjectCommandOutput, S3ClientResolvedConfig> {
     readonly input: DeleteObjectCommandInput;

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

@@ -50,6 +50,41 @@ export interface DeleteObjectTaggingCommandOutput extends DeleteObjectTaggingOut
  * @see {@link DeleteObjectTaggingCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @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"
+ * };
+ * const command = new DeleteObjectTaggingCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ * };
+ * const command = new DeleteObjectTaggingCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
+ * }
+ * *\/
+ * // example id: to-remove-tag-set-from-an-object-version-1483145285913
+ * ```
+ *
  */
 export declare class DeleteObjectTaggingCommand extends $Command<DeleteObjectTaggingCommandInput, DeleteObjectTaggingCommandOutput, S3ClientResolvedConfig> {
     readonly input: DeleteObjectTaggingCommandInput;

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

@@ -80,6 +80,82 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
  * @see {@link DeleteObjectsCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To delete multiple objects from a versioned bucket
+ * ```javascript
+ * // The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "Delete": {
+ *     "Objects": [
+ *       {
+ *         "Key": "objectkey1"
+ *       },
+ *       {
+ *         "Key": "objectkey2"
+ *       }
+ *     ],
+ *     "Quiet": false
+ *   }
+ * };
+ * const command = new DeleteObjectsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Deleted": [
+ *     {
+ *       "DeleteMarker": "true",
+ *       "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
+ *       "Key": "objectkey1"
+ *     },
+ *     {
+ *       "DeleteMarker": "true",
+ *       "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
+ *       "Key": "objectkey2"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-delete-multiple-objects-from-a-versioned-bucket-1483146248805
+ * ```
+ *
+ * @example To delete multiple object versions from a versioned bucket
+ * ```javascript
+ * // The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "Delete": {
+ *     "Objects": [
+ *       {
+ *         "Key": "HappyFace.jpg",
+ *         "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
+ *       },
+ *       {
+ *         "Key": "HappyFace.jpg",
+ *         "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
+ *       }
+ *     ],
+ *     "Quiet": false
+ *   }
+ * };
+ * const command = new DeleteObjectsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Deleted": [
+ *     {
+ *       "Key": "HappyFace.jpg",
+ *       "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
+ *     },
+ *     {
+ *       "Key": "HappyFace.jpg",
+ *       "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737
+ * ```
+ *
  */
 export declare class DeleteObjectsCommand extends $Command<DeleteObjectsCommandInput, DeleteObjectsCommandOutput, S3ClientResolvedConfig> {
     readonly input: DeleteObjectsCommandInput;

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

@@ -48,6 +48,35 @@ export interface GetBucketCorsCommandOutput extends GetBucketCorsOutput, __Metad
  * @see {@link GetBucketCorsCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To get cors configuration set on a bucket
+ * ```javascript
+ * // The following example returns cross-origin resource sharing (CORS) configuration set on a bucket.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new GetBucketCorsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CORSRules": [
+ *     {
+ *       "AllowedHeaders": [
+ *         "Authorization"
+ *       ],
+ *       "AllowedMethods": [
+ *         "GET"
+ *       ],
+ *       "AllowedOrigins": [
+ *         "*"
+ *       ],
+ *       "MaxAgeSeconds": 3000
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-cors-configuration-set-on-a-bucket-1481596855475
+ * ```
+ *
  */
 export declare class GetBucketCorsCommand extends $Command<GetBucketCorsCommandInput, GetBucketCorsCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketCorsCommandInput;

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

@@ -82,6 +82,34 @@ export interface GetBucketLifecycleConfigurationCommandOutput extends GetBucketL
  * @see {@link GetBucketLifecycleConfigurationCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To get lifecycle configuration on a bucket
+ * ```javascript
+ * // The following example retrieves lifecycle configuration on set on a bucket.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new GetBucketLifecycleConfigurationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Rules": [
+ *     {
+ *       "ID": "Rule for TaxDocs/",
+ *       "Prefix": "TaxDocs",
+ *       "Status": "Enabled",
+ *       "Transitions": [
+ *         {
+ *           "Days": 365,
+ *           "StorageClass": "STANDARD_IA"
+ *         }
+ *       ]
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-lifecycle-configuration-on-a-bucket-1481666063200
+ * ```
+ *
  */
 export declare class GetBucketLifecycleConfigurationCommand extends $Command<GetBucketLifecycleConfigurationCommandInput, GetBucketLifecycleConfigurationCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketLifecycleConfigurationCommandInput;

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

@@ -46,6 +46,22 @@ export interface GetBucketLocationCommandOutput extends GetBucketLocationOutput,
  * @see {@link GetBucketLocationCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To get bucket location
+ * ```javascript
+ * // The following example returns bucket location.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new GetBucketLocationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "LocationConstraint": "us-west-2"
+ * }
+ * *\/
+ * // example id: to-get-bucket-location-1481594573609
+ * ```
+ *
  */
 export declare class GetBucketLocationCommand extends $Command<GetBucketLocationCommandInput, GetBucketLocationCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketLocationCommandInput;

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

@@ -51,6 +51,22 @@ export interface GetBucketPolicyCommandOutput extends GetBucketPolicyOutput, __M
  * @see {@link GetBucketPolicyCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To get bucket policy
+ * ```javascript
+ * // The following example returns bucket policy associated with a bucket.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new GetBucketPolicyCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Policy": "{\"Version\":\"2008-10-17\",\"Id\":\"LogPolicy\",\"Statement\":[{\"Sid\":\"Enables the log delivery group to publish logs to your bucket \",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"111122223333\"},\"Action\":[\"s3:GetBucketAcl\",\"s3:GetObjectAcl\",\"s3:PutObject\"],\"Resource\":[\"arn:aws:s3:::policytest1/*\",\"arn:aws:s3:::policytest1\"]}]}"
+ * }
+ * *\/
+ * // example id: to-get-bucket-policy-1481595098424
+ * ```
+ *
  */
 export declare class GetBucketPolicyCommand extends $Command<GetBucketPolicyCommandInput, GetBucketPolicyCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketPolicyCommandInput;

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

@@ -58,6 +58,34 @@ export interface GetBucketReplicationCommandOutput extends GetBucketReplicationO
  * @see {@link GetBucketReplicationCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To get replication configuration set on a bucket
+ * ```javascript
+ * // The following example returns replication configuration set on a bucket.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new GetBucketReplicationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ReplicationConfiguration": {
+ *     "Role": "arn:aws:iam::acct-id:role/example-role",
+ *     "Rules": [
+ *       {
+ *         "Destination": {
+ *           "Bucket": "arn:aws:s3:::destination-bucket"
+ *         },
+ *         "ID": "MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy",
+ *         "Prefix": "Tax",
+ *         "Status": "Enabled"
+ *       }
+ *     ]
+ *   }
+ * }
+ * *\/
+ * // example id: to-get-replication-configuration-set-on-a-bucket-1481593597175
+ * ```
+ *
  */
 export declare class GetBucketReplicationCommand extends $Command<GetBucketReplicationCommandInput, GetBucketReplicationCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketReplicationCommandInput;

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

@@ -38,6 +38,22 @@ export interface GetBucketRequestPaymentCommandOutput extends GetBucketRequestPa
  * @see {@link GetBucketRequestPaymentCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To get bucket versioning configuration
+ * ```javascript
+ * // The following example retrieves bucket versioning configuration.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new GetBucketRequestPaymentCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Payer": "BucketOwner"
+ * }
+ * *\/
+ * // example id: to-get-bucket-versioning-configuration-1483037183929
+ * ```
+ *
  */
 export declare class GetBucketRequestPaymentCommand extends $Command<GetBucketRequestPaymentCommandInput, GetBucketRequestPaymentCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketRequestPaymentCommandInput;

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

@@ -58,6 +58,31 @@ export interface GetBucketTaggingCommandOutput extends GetBucketTaggingOutput, _
  * @see {@link GetBucketTaggingCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To get tag set associated with a bucket
+ * ```javascript
+ * // The following example returns tag set associated with a bucket
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new GetBucketTaggingCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "TagSet": [
+ *     {
+ *       "Key": "key1",
+ *       "Value": "value1"
+ *     },
+ *     {
+ *       "Key": "key2",
+ *       "Value": "value2"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-tag-set-associated-with-a-bucket-1481593232107
+ * ```
+ *
  */
 export declare class GetBucketTaggingCommand extends $Command<GetBucketTaggingCommandInput, GetBucketTaggingCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketTaggingCommandInput;