Skip to content

Commit

Permalink
chore(clients): generate clients with [email protected]
Browse files Browse the repository at this point in the history
  • Loading branch information
trivikr committed Oct 18, 2024
1 parent 4fe19d5 commit 3821156
Show file tree
Hide file tree
Showing 8 changed files with 208 additions and 85 deletions.
20 changes: 10 additions & 10 deletions clients/client-s3/src/commands/DeleteObjectCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -154,28 +154,28 @@ export interface DeleteObjectCommandOutput extends DeleteObjectOutput, __Metadat
* <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
* // example id: to-delete-an-object-from-a-non-versioned-bucket-1481588533089
* ```
*
* @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
* // example id: to-delete-an-object-1472850136595
* ```
*
*/
Expand Down
38 changes: 19 additions & 19 deletions clients/client-s3/src/commands/GetObjectTaggingCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -98,55 +98,55 @@ export interface GetObjectTaggingCommandOutput extends GetObjectTaggingOutput, _
* <p>Base exception class for all service exceptions from S3 service.</p>
*
* @public
* @example To retrieve tag set of an object
* @example To retrieve tag set of a specific object version
* ```javascript
* // The following example retrieves tag set of an object.
* // The following example retrieves tag set of an object. The request specifies object version.
* const input = {
* "Bucket": "examplebucket",
* "Key": "HappyFace.jpg"
* "Key": "exampleobject",
* "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
* };
* const command = new GetObjectTaggingCommand(input);
* const response = await client.send(command);
* /* response ==
* {
* "TagSet": [
* {
* "Key": "Key4",
* "Value": "Value4"
* },
* {
* "Key": "Key3",
* "Value": "Value3"
* "Key": "Key1",
* "Value": "Value1"
* }
* ],
* "VersionId": "null"
* "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
* }
* *\/
* // example id: to-retrieve-tag-set-of-an-object-1481833847896
* // example id: to-retrieve-tag-set-of-a-specific-object-version-1483400283663
* ```
*
* @example To retrieve tag set of a specific object version
* @example To retrieve tag set of an object
* ```javascript
* // The following example retrieves tag set of an object. The request specifies object version.
* // The following example retrieves tag set of an object.
* const input = {
* "Bucket": "examplebucket",
* "Key": "exampleobject",
* "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
* "Key": "HappyFace.jpg"
* };
* const command = new GetObjectTaggingCommand(input);
* const response = await client.send(command);
* /* response ==
* {
* "TagSet": [
* {
* "Key": "Key1",
* "Value": "Value1"
* "Key": "Key4",
* "Value": "Value4"
* },
* {
* "Key": "Key3",
* "Value": "Value3"
* }
* ],
* "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
* "VersionId": "null"
* }
* *\/
* // example id: to-retrieve-tag-set-of-a-specific-object-version-1483400283663
* // example id: to-retrieve-tag-set-of-an-object-1481833847896
* ```
*
*/
Expand Down
82 changes: 41 additions & 41 deletions clients/client-s3/src/commands/PutObjectCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -249,43 +249,46 @@ export interface PutObjectCommandOutput extends PutObjectOutput, __MetadataBeare
* <p>Base exception class for all service exceptions from S3 service.</p>
*
* @public
* @example To upload an object and specify canned ACL.
* @example To create an object.
* ```javascript
* // The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
* // The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
* const input = {
* "ACL": "authenticated-read",
* "Body": "filetoupload",
* "Bucket": "examplebucket",
* "Key": "exampleobject"
* "Key": "objectkey"
* };
* const command = new PutObjectCommand(input);
* const response = await client.send(command);
* /* response ==
* {
* "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
* "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr"
* "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ"
* }
* *\/
* // example id: to-upload-an-object-and-specify-canned-acl-1483397779571
* // example id: to-create-an-object-1483147613675
* ```
*
* @example To create an object.
* @example To upload object and specify user-defined metadata
* ```javascript
* // The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
* // 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": "objectkey"
* "Key": "exampleobject",
* "Metadata": {
* "metadata1": "value1",
* "metadata2": "value2"
* }
* };
* const command = new PutObjectCommand(input);
* const response = await client.send(command);
* /* response ==
* {
* "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
* "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ"
* "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0"
* }
* *\/
* // example id: to-create-an-object-1483147613675
* // example id: to-upload-object-and-specify-user-defined-metadata-1483396974757
* ```
*
* @example To upload an object
Expand All @@ -307,91 +310,88 @@ export interface PutObjectCommandOutput extends PutObjectOutput, __MetadataBeare
* // example id: to-upload-an-object-1481760101010
* ```
*
* @example To upload an object and specify optional tags
* @example To upload an object and specify canned ACL.
* ```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 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": "c:\\HappyFace.jpg",
* "ACL": "authenticated-read",
* "Body": "filetoupload",
* "Bucket": "examplebucket",
* "Key": "HappyFace.jpg",
* "Tagging": "key1=value1&key2=value2"
* "Key": "exampleobject"
* };
* const command = new PutObjectCommand(input);
* const response = await client.send(command);
* /* response ==
* {
* "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
* "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a"
* "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr"
* }
* *\/
* // example id: to-upload-an-object-and-specify-optional-tags-1481762310955
* // example id: to-upload-an-object-and-specify-canned-acl-1483397779571
* ```
*
* @example To upload an object and specify server-side encryption and object tags
* @example To upload an object (specify optional headers)
* ```javascript
* // The following example uploads an object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
* // 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": "filetoupload",
* "Body": "HappyFace.jpg",
* "Bucket": "examplebucket",
* "Key": "exampleobject",
* "Key": "HappyFace.jpg",
* "ServerSideEncryption": "AES256",
* "Tagging": "key1=value1&key2=value2"
* "StorageClass": "STANDARD_IA"
* };
* const command = new PutObjectCommand(input);
* const response = await client.send(command);
* /* response ==
* {
* "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
* "ServerSideEncryption": "AES256",
* "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt"
* "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp"
* }
* *\/
* // example id: to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831
* // example id: to-upload-an-object-(specify-optional-headers)
* ```
*
* @example To upload an object (specify optional headers)
* @example To upload an object and specify optional tags
* ```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 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": "HappyFace.jpg",
* "Body": "c:\\HappyFace.jpg",
* "Bucket": "examplebucket",
* "Key": "HappyFace.jpg",
* "ServerSideEncryption": "AES256",
* "StorageClass": "STANDARD_IA"
* "Tagging": "key1=value1&key2=value2"
* };
* const command = new PutObjectCommand(input);
* const response = await client.send(command);
* /* response ==
* {
* "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
* "ServerSideEncryption": "AES256",
* "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp"
* "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a"
* }
* *\/
* // example id: to-upload-an-object-(specify-optional-headers)
* // example id: to-upload-an-object-and-specify-optional-tags-1481762310955
* ```
*
* @example To upload object and specify user-defined metadata
* @example To upload an object and specify server-side encryption and object 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 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",
* "Metadata": {
* "metadata1": "value1",
* "metadata2": "value2"
* }
* "ServerSideEncryption": "AES256",
* "Tagging": "key1=value1&key2=value2"
* };
* const command = new PutObjectCommand(input);
* const response = await client.send(command);
* /* response ==
* {
* "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
* "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0"
* "ServerSideEncryption": "AES256",
* "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt"
* }
* *\/
* // example id: to-upload-object-and-specify-user-defined-metadata-1483396974757
* // example id: to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831
* ```
*
*/
Expand Down
26 changes: 13 additions & 13 deletions clients/client-s3/src/commands/UploadPartCopyCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -305,51 +305,51 @@ export interface UploadPartCopyCommandOutput extends UploadPartCopyOutput, __Met
* <p>Base exception class for all service exceptions from S3 service.</p>
*
* @public
* @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);
* const response = await client.send(command);
* /* 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
* ```
*
* @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);
* const response = await client.send(command);
* /* 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
* ```
*
*/
Expand Down
Loading

0 comments on commit 3821156

Please sign in to comment.