@aws-sdk/client-s3 3.287.0 → 3.289.0

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

@@ -84,6 +84,51 @@ export interface PutBucketCorsCommandOutput extends __MetadataBearer {
  * @see {@link PutBucketCorsCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To set cors configuration on a bucket.
+ * ```javascript
+ * // The following example enables PUT, POST, and DELETE requests from www.example.com, and enables GET requests from any domain.
+ * const input = {
+ *   "Bucket": "",
+ *   "CORSConfiguration": {
+ *     "CORSRules": [
+ *       {
+ *         "AllowedHeaders": [
+ *           "*"
+ *         ],
+ *         "AllowedMethods": [
+ *           "PUT",
+ *           "POST",
+ *           "DELETE"
+ *         ],
+ *         "AllowedOrigins": [
+ *           "http://www.example.com"
+ *         ],
+ *         "ExposeHeaders": [
+ *           "x-amz-server-side-encryption"
+ *         ],
+ *         "MaxAgeSeconds": 3000
+ *       },
+ *       {
+ *         "AllowedHeaders": [
+ *           "Authorization"
+ *         ],
+ *         "AllowedMethods": [
+ *           "GET"
+ *         ],
+ *         "AllowedOrigins": [
+ *           "*"
+ *         ],
+ *         "MaxAgeSeconds": 3000
+ *       }
+ *     ]
+ *   },
+ *   "ContentMD5": ""
+ * };
+ * const command = new PutBucketCorsCommand(input);
+ * await client.send(command);
+ * // example id: to-set-cors-configuration-on-a-bucket-1483037818805
+ * ```
+ *
  */
 export declare class PutBucketCorsCommand extends $Command<PutBucketCorsCommandInput, PutBucketCorsCommandOutput, S3ClientResolvedConfig> {
     readonly input: PutBucketCorsCommandInput;

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

@@ -116,6 +116,37 @@ export interface PutBucketLifecycleConfigurationCommandOutput extends __Metadata
  * @see {@link PutBucketLifecycleConfigurationCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example Put bucket lifecycle
+ * ```javascript
+ * // The following example replaces existing lifecycle configuration, if any, on the specified bucket.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "LifecycleConfiguration": {
+ *     "Rules": [
+ *       {
+ *         "Expiration": {
+ *           "Days": 3650
+ *         },
+ *         "Filter": {
+ *           "Prefix": "documents/"
+ *         },
+ *         "ID": "TestOnly",
+ *         "Status": "Enabled",
+ *         "Transitions": [
+ *           {
+ *             "Days": 365,
+ *             "StorageClass": "GLACIER"
+ *           }
+ *         ]
+ *       }
+ *     ]
+ *   }
+ * };
+ * const command = new PutBucketLifecycleConfigurationCommand(input);
+ * await client.send(command);
+ * // example id: put-bucket-lifecycle-1482264533092
+ * ```
+ *
  */
 export declare class PutBucketLifecycleConfigurationCommand extends $Command<PutBucketLifecycleConfigurationCommandInput, PutBucketLifecycleConfigurationCommandOutput, S3ClientResolvedConfig> {
     readonly input: PutBucketLifecycleConfigurationCommandInput;

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

@@ -104,6 +104,32 @@ export interface PutBucketLoggingCommandOutput extends __MetadataBearer {
  * @see {@link PutBucketLoggingCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example Set logging configuration for a bucket
+ * ```javascript
+ * // The following example sets logging policy on a bucket. For the Log Delivery group to deliver logs to the destination bucket, it needs permission for the READ_ACP action which the policy grants.
+ * const input = {
+ *   "Bucket": "sourcebucket",
+ *   "BucketLoggingStatus": {
+ *     "LoggingEnabled": {
+ *       "TargetBucket": "targetbucket",
+ *       "TargetGrants": [
+ *         {
+ *           "Grantee": {
+ *             "Type": "Group",
+ *             "URI": "http://acs.amazonaws.com/groups/global/AllUsers"
+ *           },
+ *           "Permission": "READ"
+ *         }
+ *       ],
+ *       "TargetPrefix": "MyBucketLogs/"
+ *     }
+ *   }
+ * };
+ * const command = new PutBucketLoggingCommand(input);
+ * await client.send(command);
+ * // example id: set-logging-configuration-for-a-bucket-1482269119909
+ * ```
+ *
  */
 export declare class PutBucketLoggingCommand extends $Command<PutBucketLoggingCommandInput, PutBucketLoggingCommandOutput, S3ClientResolvedConfig> {
     readonly input: PutBucketLoggingCommandInput;

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

@@ -83,6 +83,27 @@ export interface PutBucketNotificationConfigurationCommandOutput extends __Metad
  * @see {@link PutBucketNotificationConfigurationCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example Set notification configuration for a bucket
+ * ```javascript
+ * // The following example sets notification configuration on a bucket to publish the object created events to an SNS topic.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "NotificationConfiguration": {
+ *     "TopicConfigurations": [
+ *       {
+ *         "Events": [
+ *           "s3:ObjectCreated:*"
+ *         ],
+ *         "TopicArn": "arn:aws:sns:us-west-2:123456789012:s3-notification-topic"
+ *       }
+ *     ]
+ *   }
+ * };
+ * const command = new PutBucketNotificationConfigurationCommand(input);
+ * await client.send(command);
+ * // example id: set-notification-configuration-for-a-bucket-1482270296426
+ * ```
+ *
  */
 export declare class PutBucketNotificationConfigurationCommand extends $Command<PutBucketNotificationConfigurationCommandInput, PutBucketNotificationConfigurationCommandOutput, S3ClientResolvedConfig> {
     readonly input: PutBucketNotificationConfigurationCommandInput;

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

@@ -55,6 +55,18 @@ export interface PutBucketPolicyCommandOutput extends __MetadataBearer {
  * @see {@link PutBucketPolicyCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example Set bucket policy
+ * ```javascript
+ * // The following example sets a permission policy on a bucket.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "Policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{ \"Sid\": \"id-1\",\"Effect\": \"Allow\",\"Principal\": {\"AWS\": \"arn:aws:iam::123456789012:root\"}, \"Action\": [ \"s3:PutObject\",\"s3:PutObjectAcl\"], \"Resource\": [\"arn:aws:s3:::acl3/*\" ] } ]}"
+ * };
+ * const command = new PutBucketPolicyCommand(input);
+ * await client.send(command);
+ * // example id: set-bucket-policy-1482448903302
+ * ```
+ *
  */
 export declare class PutBucketPolicyCommand extends $Command<PutBucketPolicyCommandInput, PutBucketPolicyCommandOutput, S3ClientResolvedConfig> {
     readonly input: PutBucketPolicyCommandInput;

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

@@ -90,6 +90,30 @@ export interface PutBucketReplicationCommandOutput extends __MetadataBearer {
  * @see {@link PutBucketReplicationCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example Set replication configuration on a bucket
+ * ```javascript
+ * // The following example sets replication configuration on a bucket.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "ReplicationConfiguration": {
+ *     "Role": "arn:aws:iam::123456789012:role/examplerole",
+ *     "Rules": [
+ *       {
+ *         "Destination": {
+ *           "Bucket": "arn:aws:s3:::destinationbucket",
+ *           "StorageClass": "STANDARD"
+ *         },
+ *         "Prefix": "",
+ *         "Status": "Enabled"
+ *       }
+ *     ]
+ *   }
+ * };
+ * const command = new PutBucketReplicationCommand(input);
+ * await client.send(command);
+ * // example id: id-1
+ * ```
+ *
  */
 export declare class PutBucketReplicationCommand extends $Command<PutBucketReplicationCommandInput, PutBucketReplicationCommandOutput, S3ClientResolvedConfig> {
     readonly input: PutBucketReplicationCommandInput;

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

@@ -46,6 +46,20 @@ export interface PutBucketRequestPaymentCommandOutput extends __MetadataBearer {
  * @see {@link PutBucketRequestPaymentCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example Set request payment configuration on a bucket.
+ * ```javascript
+ * // The following example sets request payment configuration on a bucket so that person requesting the download is charged.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "RequestPaymentConfiguration": {
+ *     "Payer": "Requester"
+ *   }
+ * };
+ * const command = new PutBucketRequestPaymentCommand(input);
+ * await client.send(command);
+ * // example id: set-request-payment-configuration-on-a-bucket-1482343596680
+ * ```
+ *
  */
 export declare class PutBucketRequestPaymentCommand extends $Command<PutBucketRequestPaymentCommandInput, PutBucketRequestPaymentCommandOutput, S3ClientResolvedConfig> {
     readonly input: PutBucketRequestPaymentCommandInput;

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

@@ -103,6 +103,29 @@ export interface PutBucketTaggingCommandOutput extends __MetadataBearer {
  * @see {@link PutBucketTaggingCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example Set tags on a bucket
+ * ```javascript
+ * // The following example sets tags on a bucket. Any existing tags are replaced.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "Tagging": {
+ *     "TagSet": [
+ *       {
+ *         "Key": "Key1",
+ *         "Value": "Value1"
+ *       },
+ *       {
+ *         "Key": "Key2",
+ *         "Value": "Value2"
+ *       }
+ *     ]
+ *   }
+ * };
+ * const command = new PutBucketTaggingCommand(input);
+ * await client.send(command);
+ * // example id: set-tags-on-a-bucket-1482346269066
+ * ```
+ *
  */
 export declare class PutBucketTaggingCommand extends $Command<PutBucketTaggingCommandInput, PutBucketTaggingCommandOutput, S3ClientResolvedConfig> {
     readonly input: PutBucketTaggingCommandInput;

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

@@ -71,6 +71,21 @@ export interface PutBucketVersioningCommandOutput extends __MetadataBearer {
  * @see {@link PutBucketVersioningCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example Set versioning configuration on a bucket
+ * ```javascript
+ * // The following example sets versioning configuration on bucket. The configuration enables versioning on the bucket.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "VersioningConfiguration": {
+ *     "MFADelete": "Disabled",
+ *     "Status": "Enabled"
+ *   }
+ * };
+ * const command = new PutBucketVersioningCommand(input);
+ * await client.send(command);
+ * // example id: set-versioning-configuration-on-a-bucket-1482344186279
+ * ```
+ *
  */
 export declare class PutBucketVersioningCommand extends $Command<PutBucketVersioningCommandInput, PutBucketVersioningCommandOutput, S3ClientResolvedConfig> {
     readonly input: PutBucketVersioningCommandInput;

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

@@ -150,6 +150,26 @@ export interface PutBucketWebsiteCommandOutput extends __MetadataBearer {
  * @see {@link PutBucketWebsiteCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example Set website configuration on a bucket
+ * ```javascript
+ * // The following example adds website configuration to a bucket.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "ContentMD5": "",
+ *   "WebsiteConfiguration": {
+ *     "ErrorDocument": {
+ *       "Key": "error.html"
+ *     },
+ *     "IndexDocument": {
+ *       "Suffix": "index.html"
+ *     }
+ *   }
+ * };
+ * const command = new PutBucketWebsiteCommand(input);
+ * await client.send(command);
+ * // example id: set-website-configuration-on-a-bucket-1482346836261
+ * ```
+ *
  */
 export declare class PutBucketWebsiteCommand extends $Command<PutBucketWebsiteCommandInput, PutBucketWebsiteCommandOutput, S3ClientResolvedConfig> {
     readonly input: PutBucketWebsiteCommandInput;

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

@@ -207,6 +207,21 @@ export interface PutObjectAclCommandOutput extends PutObjectAclOutput, __Metadat
  * @see {@link PutObjectAclCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @example To grant permissions using object ACL
+ * ```javascript
+ * // The following example adds grants to an object ACL. The first permission grants user1 and user2 FULL_CONTROL and the AllUsers group READ permission.
+ * const input = {
+ *   "AccessControlPolicy": {},
+ *   "Bucket": "examplebucket",
+ *   "GrantFullControl": "emailaddress=user1@example.com,emailaddress=user2@example.com",
+ *   "GrantRead": "uri=http://acs.amazonaws.com/groups/global/AllUsers",
+ *   "Key": "HappyFace.jpg"
+ * };
+ * const command = new PutObjectAclCommand(input);
+ * await client.send(command);
+ * // example id: to-grant-permissions-using-object-acl-1481835549285
+ * ```
+ *
  */
 export declare class PutObjectAclCommand extends $Command<PutObjectAclCommandInput, PutObjectAclCommandOutput, S3ClientResolvedConfig> {
     readonly input: PutObjectAclCommandInput;

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

@@ -137,6 +137,151 @@ export interface PutObjectCommandOutput extends PutObjectOutput, __MetadataBeare
  * @see {@link PutObjectCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @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.
+ * const input = {
+ *   "Body": "HappyFace.jpg",
+ *   "Bucket": "examplebucket",
+ *   "Key": "HappyFace.jpg"
+ * };
+ * const command = new PutObjectCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
+ *   "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk"
+ * }
+ * *\/
+ * // example id: to-upload-an-object-1481760101010
+ * ```
+ *
+ * @example To upload object and specify user-defined metadata
+ * ```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.
+ * const input = {
+ *   "Body": "filetoupload",
+ *   "Bucket": "examplebucket",
+ *   "Key": "exampleobject",
+ *   "Metadata": {
+ *     "metadata1": "value1",
+ *     "metadata2": "value2"
+ *   }
+ * };
+ * const command = new PutObjectCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
+ *   "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0"
+ * }
+ * *\/
+ * // example id: to-upload-object-and-specify-user-defined-metadata-1483396974757
+ * ```
+ *
+ * @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"
+ * };
+ * const command = new PutObjectCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
+ *   "ServerSideEncryption": "AES256",
+ *   "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp"
+ * }
+ * *\/
+ * // example id: to-upload-an-object-(specify-optional-headers)
+ * ```
+ *
+ * @example To create an object.
+ * ```javascript
+ * // The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
+ * const input = {
+ *   "Body": "filetoupload",
+ *   "Bucket": "examplebucket",
+ *   "Key": "objectkey"
+ * };
+ * const command = new PutObjectCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
+ *   "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ"
+ * }
+ * *\/
+ * // example id: to-create-an-object-1483147613675
+ * ```
+ *
+ * @example To upload an object and specify server-side encryption and object tags
+ * ```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.
+ * 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
+ * ```
+ *
+ * @example To upload an object and specify optional tags
+ * ```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.
+ * const input = {
+ *   "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 ==
+ * {
+ *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
+ *   "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a"
+ * }
+ * *\/
+ * // example id: to-upload-an-object-and-specify-optional-tags-1481762310955
+ * ```
+ *
+ * @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
+ * ```
+ *
  */
 export declare class PutObjectCommand extends $Command<PutObjectCommandInput, PutObjectCommandOutput, S3ClientResolvedConfig> {
     readonly input: PutObjectCommandInput;

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

@@ -120,6 +120,35 @@ export interface PutObjectTaggingCommandOutput extends PutObjectTaggingOutput, _
  * @see {@link PutObjectTaggingCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @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": [
+ *       {
+ *         "Key": "Key3",
+ *         "Value": "Value3"
+ *       },
+ *       {
+ *         "Key": "Key4",
+ *         "Value": "Value4"
+ *       }
+ *     ]
+ *   }
+ * };
+ * const command = new PutObjectTaggingCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "VersionId": "null"
+ * }
+ * *\/
+ * // example id: to-add-tags-to-an-existing-object-1481764668793
+ * ```
+ *
  */
 export declare class PutObjectTaggingCommand extends $Command<PutObjectTaggingCommandInput, PutObjectTaggingCommandOutput, S3ClientResolvedConfig> {
     readonly input: PutObjectTaggingCommandInput;

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

@@ -312,6 +312,24 @@ export interface RestoreObjectCommandOutput extends RestoreObjectOutput, __Metad
  * @see {@link RestoreObjectCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @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"
+ *     }
+ *   }
+ * };
+ * const command = new RestoreObjectCommand(input);
+ * await client.send(command);
+ * // example id: to-restore-an-archived-object-1483049329953
+ * ```
+ *
  */
 export declare class RestoreObjectCommand extends $Command<RestoreObjectCommandInput, RestoreObjectCommandOutput, S3ClientResolvedConfig> {
     readonly input: RestoreObjectCommandInput;

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

@@ -158,6 +158,26 @@ export interface UploadPartCommandOutput extends UploadPartOutput, __MetadataBea
  * @see {@link UploadPartCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @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--"
+ * };
+ * const command = new UploadPartCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\""
+ * }
+ * *\/
+ * // example id: to-upload-a-part-1481847914943
+ * ```
+ *
  */
 export declare class UploadPartCommand extends $Command<UploadPartCommandInput, UploadPartCommandOutput, S3ClientResolvedConfig> {
     readonly input: UploadPartCommandInput;

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

@@ -195,6 +195,53 @@ export interface UploadPartCopyCommandOutput extends UploadPartCopyOutput, __Met
  * @see {@link UploadPartCopyCommandOutput} for command's `response` shape.
  * @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
+ * ```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--"
+ * };
+ * const command = new UploadPartCopyCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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--"
+ * };
+ * const command = new UploadPartCopyCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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
+ * ```
+ *
  */
 export declare class UploadPartCopyCommand extends $Command<UploadPartCopyCommandInput, UploadPartCopyCommandOutput, S3ClientResolvedConfig> {
     readonly input: UploadPartCopyCommandInput;