@cumulus/aws-client 20.1.0 → 20.1.2

package/README.md

@@ -287,7 +287,7 @@ Invoke a Lambda function
 
 * [S3](#module_S3)
     * _static_
-        * ~~[.getS3Object](#module_S3.getS3Object) ⇒ <code>Promise</code>~~
+        * ~~[.getS3Object](#module_S3.getS3Object)~~
         * [.recursivelyDeleteS3Bucket](#module_S3.recursivelyDeleteS3Bucket) ⇒
         * [.listS3ObjectsV2(params)](#module_S3.listS3ObjectsV2) ⇒ <code>Promise.&lt;Array&gt;</code>
         * [.listS3ObjectsV2Batch(params)](#module_S3.listS3ObjectsV2Batch)
@@ -299,24 +299,24 @@ Invoke a Lambda function
         * [~deleteS3Object(bucket, key)](#module_S3..deleteS3Object) ⇒ <code>Promise</code>
         * [~headObject(Bucket, Key, retryOptions)](#module_S3..headObject) ⇒
         * [~s3ObjectExists(params)](#module_S3..s3ObjectExists) ⇒ <code>Promise.&lt;boolean&gt;</code>
-        * [~waitForObjectToExist(params)](#module_S3..waitForObjectToExist) ⇒ <code>Promise.&lt;undefined&gt;</code>
-        * [~s3PutObject(params)](#module_S3..s3PutObject) ⇒ <code>Promise</code>
-        * [~putFile(bucket, key, filename)](#module_S3..putFile) ⇒ <code>Promise</code>
-        * [~s3CopyObject(params)](#module_S3..s3CopyObject) ⇒ <code>Promise</code>
-        * [~promiseS3Upload(params)](#module_S3..promiseS3Upload) ⇒ <code>Promise</code>
-        * [~streamS3Upload(uploadStream, uploadParams)](#module_S3..streamS3Upload) ⇒ <code>Promise</code>
-        * [~getObjectReadStream(params)](#module_S3..getObjectReadStream) ⇒ <code>Promise.&lt;Readable&gt;</code>
-        * [~downloadS3File(s3Obj, filepath)](#module_S3..downloadS3File) ⇒ <code>Promise.&lt;string&gt;</code>
-        * [~getObjectSize(params)](#module_S3..getObjectSize) ⇒ <code>Promise.&lt;(number\|undefined)&gt;</code>
-        * [~s3GetObjectTagging(bucket, key)](#module_S3..s3GetObjectTagging) ⇒ <code>Promise.&lt;GetObjectTaggingOutput&gt;</code>
-        * [~s3PutObjectTagging(Bucket, Key, ObjectTagging)](#module_S3..s3PutObjectTagging) ⇒ <code>Promise</code>
-        * [~getObject(s3Client, params)](#module_S3..getObject) ⇒ <code>Promise.&lt;GetObjectOutput&gt;</code>
-        * [~waitForObject(s3Client, params, [retryOptions])](#module_S3..waitForObject) ⇒ <code>Promise.&lt;GetObjectOutput&gt;</code>
-        * [~getObjectStreamContents(objectReadStream)](#module_S3..getObjectStreamContents) ⇒ <code>Promise.&lt;string&gt;</code>
-        * [~getTextObject(bucket, key)](#module_S3..getTextObject) ⇒ <code>Promise.&lt;string&gt;</code>
-        * [~getJsonS3Object(bucket, key)](#module_S3..getJsonS3Object) ⇒ <code>Promise.&lt;\*&gt;</code>
-        * [~fileExists(bucket, key)](#module_S3..fileExists) ⇒ <code>Promise</code>
-        * [~deleteS3Files(s3Objs)](#module_S3..deleteS3Files) ⇒ <code>Promise</code>
+        * [~waitForObjectToExist()](#module_S3..waitForObjectToExist)
+        * [~s3PutObject(params)](#module_S3..s3PutObject)
+        * [~putFile()](#module_S3..putFile)
+        * [~s3CopyObject()](#module_S3..s3CopyObject)
+        * [~promiseS3Upload()](#module_S3..promiseS3Upload)
+        * [~streamS3Upload()](#module_S3..streamS3Upload)
+        * [~getObjectReadStream()](#module_S3..getObjectReadStream)
+        * [~downloadS3File()](#module_S3..downloadS3File)
+        * [~getObjectSize()](#module_S3..getObjectSize)
+        * [~s3GetObjectTagging()](#module_S3..s3GetObjectTagging)
+        * [~s3PutObjectTagging()](#module_S3..s3PutObjectTagging)
+        * [~getObject()](#module_S3..getObject)
+        * [~waitForObject()](#module_S3..waitForObject)
+        * [~getObjectStreamContents()](#module_S3..getObjectStreamContents)
+        * [~getTextObject()](#module_S3..getTextObject)
+        * [~getJsonS3Object()](#module_S3..getJsonS3Object)
+        * [~fileExists()](#module_S3..fileExists)
+        * [~deleteS3Files(s3Objs)](#module_S3..deleteS3Files)
         * [~uploadS3FileStream(fileStream, bucket, key, s3opts)](#module_S3..uploadS3FileStream) ⇒ <code>Promise</code>
         * [~listS3Objects()](#module_S3..listS3Objects)
         * [~deleteS3Buckets(buckets)](#module_S3..deleteS3Buckets) ⇒ <code>Promise</code>
@@ -326,24 +326,17 @@ Invoke a Lambda function
         * [~createBucket(Bucket)](#module_S3..createBucket) ⇒ <code>Promise</code>
         * [~createS3Buckets(buckets)](#module_S3..createS3Buckets) ⇒ <code>Promise</code>
         * [~multipartCopyObject(params)](#module_S3..multipartCopyObject) ⇒ <code>Promise.&lt;{etag: string}&gt;</code>
-        * [~moveObject(params)](#module_S3..moveObject) ⇒ <code>Promise.&lt;undefined&gt;</code>
+        * [~copyObject()](#module_S3..copyObject)
+        * [~moveObject()](#module_S3..moveObject) ⇒ <code>Promise.&lt;undefined&gt;</code>
 
 <a name="module_S3.getS3Object"></a>
 
-### ~~S3.getS3Object ⇒ <code>Promise</code>~~
+### ~~S3.getS3Object~~
 ***Deprecated***
 
 Gets an object from S3.
 
 **Kind**: static property of [<code>S3</code>](#module_S3)  
-**Returns**: <code>Promise</code> - returns response from `S3.getObject` as a promise  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| Bucket | <code>string</code> | name of bucket |
-| Key | <code>string</code> | key for object (filepath + filename) |
-| retryOptions | <code>Object</code> | options to control retry behavior when an   object does not exist. See https://github.com/tim-kos/node-retry#retryoperationoptions   By default, retries will not be performed |
-
 <a name="module_S3.recursivelyDeleteS3Bucket"></a>
 
 ### S3.recursivelyDeleteS3Bucket ⇒
@@ -478,253 +471,139 @@ Test if an object exists in S3
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
 **Returns**: <code>Promise.&lt;boolean&gt;</code> - a Promise that will resolve to a boolean indicating
-                              if the object exists  
+                            if the object exists  
 
-| Param | Type | Description |
-| --- | --- | --- |
-| params | <code>Object</code> | same params as https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#headObject-property |
+| Param | Description |
+| --- | --- |
+| params | same params as https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#headObject-property |
 
 <a name="module_S3..waitForObjectToExist"></a>
 
-### S3~waitForObjectToExist(params) ⇒ <code>Promise.&lt;undefined&gt;</code>
+### S3~waitForObjectToExist()
 Wait for an object to exist in S3
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
 
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| params | <code>Object</code> |  |  |
-| params.bucket | <code>string</code> |  |  |
-| params.key | <code>string</code> |  |  |
-| [params.interval] | <code>number</code> | <code>1000</code> | interval before retries, in ms |
-| [params.timeout] | <code>number</code> | <code>30000</code> | timeout, in ms |
+| Param | Default | Description |
+| --- | --- | --- |
+| params.interval | <code>1000</code> | interval before retries, in ms |
+| params.timeout | <code>30000</code> | timeout, in ms |
 
 <a name="module_S3..s3PutObject"></a>
 
-### S3~s3PutObject(params) ⇒ <code>Promise</code>
+### S3~s3PutObject(params)
 Put an object on S3
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
 
-| Param | Type | Description |
-| --- | --- | --- |
-| params | <code>Object</code> | same params as https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#putObject-property promise of the object being put |
+| Param | Description |
+| --- | --- |
+| params | same params as https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#putObject-property |
 
 <a name="module_S3..putFile"></a>
 
-### S3~putFile(bucket, key, filename) ⇒ <code>Promise</code>
+### S3~putFile()
 Upload a file to S3
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| bucket | <code>string</code> | the destination S3 bucket |
-| key | <code>string</code> | the destination S3 key |
-| filename | <code>filename</code> | the local file to be uploaded |
-
 <a name="module_S3..s3CopyObject"></a>
 
-### S3~s3CopyObject(params) ⇒ <code>Promise</code>
+### S3~s3CopyObject()
 Copy an object from one location on S3 to another
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
-**Returns**: <code>Promise</code> - promise of the object being copied  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| params | <code>Object</code> | same params as https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#putObject-property |
-
 <a name="module_S3..promiseS3Upload"></a>
 
-### S3~promiseS3Upload(params) ⇒ <code>Promise</code>
+### S3~promiseS3Upload()
 Upload data to S3
 
 see https://github.com/aws/aws-sdk-js-v3/tree/main/lib/lib-storage
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
-
-| Param | Type |
-| --- | --- |
-| params | <code>UploadOptions</code> | 
-
 <a name="module_S3..streamS3Upload"></a>
 
-### S3~streamS3Upload(uploadStream, uploadParams) ⇒ <code>Promise</code>
+### S3~streamS3Upload()
 Upload data to S3 using a stream
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| uploadStream | <code>Readable</code> | Stream of data to upload |
-| uploadParams | <code>Object</code> |  |
-
 <a name="module_S3..getObjectReadStream"></a>
 
-### S3~getObjectReadStream(params) ⇒ <code>Promise.&lt;Readable&gt;</code>
+### S3~getObjectReadStream()
 Get a readable stream for an S3 object
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| params | <code>Object</code> |  |
-| params.s3 | <code>S3</code> | an S3 instance |
-| params.bucket | <code>string</code> | the bucket of the requested object |
-| params.key | <code>string</code> | the key of the requested object |
-
 <a name="module_S3..downloadS3File"></a>
 
-### S3~downloadS3File(s3Obj, filepath) ⇒ <code>Promise.&lt;string&gt;</code>
+### S3~downloadS3File()
 Downloads the given s3Obj to the given filename in a streaming manner
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
-**Returns**: <code>Promise.&lt;string&gt;</code> - returns filename if successful  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| s3Obj | <code>Object</code> | The parameters to send to S3 getObject call |
-| filepath | <code>string</code> | The filepath of the file that is downloaded |
-
 <a name="module_S3..getObjectSize"></a>
 
-### S3~getObjectSize(params) ⇒ <code>Promise.&lt;(number\|undefined)&gt;</code>
+### S3~getObjectSize()
 Get the size of an S3 object
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
-**Returns**: <code>Promise.&lt;(number\|undefined)&gt;</code> - object size, in bytes  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| params | <code>Object</code> |  |
-| params.bucket | <code>string</code> |  |
-| params.key | <code>string</code> |  |
-| params.s3 | <code>S3</code> | an S3 client instance |
-
 <a name="module_S3..s3GetObjectTagging"></a>
 
-### S3~s3GetObjectTagging(bucket, key) ⇒ <code>Promise.&lt;GetObjectTaggingOutput&gt;</code>
+### S3~s3GetObjectTagging()
 Get object Tagging from S3
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
-**Returns**: <code>Promise.&lt;GetObjectTaggingOutput&gt;</code> - the promised response from `S3.getObjectTagging`  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| bucket | <code>string</code> | name of bucket |
-| key | <code>string</code> | key for object (filepath + filename) |
-
 <a name="module_S3..s3PutObjectTagging"></a>
 
-### S3~s3PutObjectTagging(Bucket, Key, ObjectTagging) ⇒ <code>Promise</code>
+### S3~s3PutObjectTagging()
 Puts object Tagging in S3
 https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#putObjectTagging-property
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
-**Returns**: <code>Promise</code> - returns response from `S3.getObjectTagging` as a promise  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| Bucket | <code>string</code> | name of bucket |
-| Key | <code>string</code> | key for object (filepath + filename) |
-| ObjectTagging | <code>Object</code> | tagging object |
-
 <a name="module_S3..getObject"></a>
 
-### S3~getObject(s3Client, params) ⇒ <code>Promise.&lt;GetObjectOutput&gt;</code>
+### S3~getObject()
 Gets an object from S3.
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
-**Returns**: <code>Promise.&lt;GetObjectOutput&gt;</code> - response from `S3.getObject()`
-  as a Promise  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| s3Client | <code>S3</code> | an `S3` instance |
-| params | <code>GetObjectCommandInput</code> | parameters object to pass through   to `S3.getObject()` |
-
-**Example**  
-```js
-const obj = await getObject(s3(), { Bucket: 'b', Key: 'k' })
-```
 <a name="module_S3..waitForObject"></a>
 
-### S3~waitForObject(s3Client, params, [retryOptions]) ⇒ <code>Promise.&lt;GetObjectOutput&gt;</code>
+### S3~waitForObject()
 Get an object from S3, waiting for it to exist and, if specified, have the
 correct ETag.
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
-
-| Param | Type | Default |
-| --- | --- | --- |
-| s3Client | <code>S3</code> |  | 
-| params | <code>GetObjectCommandInput</code> |  | 
-| [retryOptions] | <code>pRetry.Options</code> | <code>{}</code> | 
-
 <a name="module_S3..getObjectStreamContents"></a>
 
-### S3~getObjectStreamContents(objectReadStream) ⇒ <code>Promise.&lt;string&gt;</code>
+### S3~getObjectStreamContents()
 Transform streaming response from S3 object to text content
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
-**Returns**: <code>Promise.&lt;string&gt;</code> - the contents of the S3 object  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| objectReadStream | <code>Readable</code> | Readable stream of S3 object |
-
 <a name="module_S3..getTextObject"></a>
 
-### S3~getTextObject(bucket, key) ⇒ <code>Promise.&lt;string&gt;</code>
+### S3~getTextObject()
 Fetch the contents of an S3 object
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
-**Returns**: <code>Promise.&lt;string&gt;</code> - the contents of the S3 object  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| bucket | <code>string</code> | the S3 object's bucket |
-| key | <code>string</code> | the S3 object's key |
-
 <a name="module_S3..getJsonS3Object"></a>
 
-### S3~getJsonS3Object(bucket, key) ⇒ <code>Promise.&lt;\*&gt;</code>
+### S3~getJsonS3Object()
 Fetch JSON stored in an S3 object
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
-**Returns**: <code>Promise.&lt;\*&gt;</code> - the contents of the S3 object, parsed as JSON  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| bucket | <code>string</code> | the S3 object's bucket |
-| key | <code>string</code> | the S3 object's key |
-
 <a name="module_S3..fileExists"></a>
 
-### S3~fileExists(bucket, key) ⇒ <code>Promise</code>
+### S3~fileExists()
 Check if a file exists in an S3 object
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
-**Returns**: <code>Promise</code> - returns the response from `S3.headObject` as a promise  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| bucket | <code>string</code> | name of the S3 bucket |
-| key | <code>string</code> | key of the file in the S3 bucket |
-
 <a name="module_S3..deleteS3Files"></a>
 
-### S3~deleteS3Files(s3Objs) ⇒ <code>Promise</code>
+### S3~deleteS3Files(s3Objs)
 Delete files from S3
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
-**Returns**: <code>Promise</code> - A promise that resolves to an Array of the data returned
-  from the deletion operations  
 
-| Param | Type | Description |
-| --- | --- | --- |
-| s3Objs | <code>Array</code> | An array of objects containing keys 'Bucket' and 'Key' |
+| Param | Description |
+| --- | --- |
+| s3Objs | An array of objects containing keys 'Bucket' and 'Key' |
 
 <a name="module_S3..uploadS3FileStream"></a>
 
@@ -852,20 +731,28 @@ note: this method may error if used with zero byte files. see CUMULUS-2557 and h
 | [params.copyTags] | <code>boolean</code> | <code>false</code> |  |
 | [params.chunkSize] | <code>number</code> |  | chunk size of the S3 multipart uploads |
 
+<a name="module_S3..copyObject"></a>
+
+### S3~copyObject()
+Copy an S3 object to another location in S3
+
+**Kind**: inner method of [<code>S3</code>](#module_S3)  
+
+| Param | Default | Description |
+| --- | --- | --- |
+| params.ACL |  | an [S3 Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) |
+| params.copyTags | <code>false</code> |  |
+| params.chunkSize |  | chunk size of the S3 multipart uploads |
+
 <a name="module_S3..moveObject"></a>
 
-### S3~moveObject(params) ⇒ <code>Promise.&lt;undefined&gt;</code>
+### S3~moveObject() ⇒ <code>Promise.&lt;undefined&gt;</code>
 Move an S3 object to another location in S3
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| params | <code>Object</code> |  |  |
-| params.sourceBucket | <code>string</code> |  |  |
-| params.sourceKey | <code>string</code> |  |  |
-| params.destinationBucket | <code>string</code> |  |  |
-| params.destinationKey | <code>string</code> |  |  |
 | [params.ACL] | <code>string</code> |  | an [S3 Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) |
 | [params.copyTags] | <code>boolean</code> | <code>false</code> |  |
 | [params.chunkSize] | <code>number</code> |  | chunk size of the S3 multipart uploads |

package/S3.d.ts

@@ -5,7 +5,7 @@
 /// <reference types="node" />
 import pRetry from 'p-retry';
 import { Readable, TransformOptions } from 'stream';
-import { CopyObjectCommandInput, DeleteObjectRequest, DeleteBucketCommandOutput, GetObjectCommandInput, GetObjectOutput, HeadObjectOutput, ListObjectsV2Request, ObjectCannedACL, PutObjectCommandInput, PutObjectRequest, S3, Tagging, ListObjectsCommandOutput } from '@aws-sdk/client-s3';
+import { CopyObjectCommandInput, DeleteObjectRequest, DeleteBucketCommandOutput, GetObjectCommandInput, GetObjectOutput, HeadObjectOutput, ListObjectsV2Request, ObjectCannedACL, PutObjectCommandInput, PutObjectRequest, S3, Tagging, ListObjectsCommandOutput, DeleteObjectCommandOutput, PutObjectCommandOutput, CopyObjectCommandOutput, CompleteMultipartUploadCommandOutput, GetObjectTaggingCommandOutput } from '@aws-sdk/client-s3';
 import { Options as UploadOptions } from '@aws-sdk/lib-storage';
 import { s3 } from './services';
 export declare type GetObjectMethod = (params: GetObjectCommandInput) => Promise<GetObjectOutput>;
@@ -49,7 +49,7 @@ export declare const s3TagSetToQueryString: (tagset: Tagging['TagSet']) => strin
  * @param {string} key - key of the object to be deleted
  * @returns {Promise} promise of the object being deleted
  */
-export declare const deleteS3Object: (bucket: string, key: string) => Promise<import("@aws-sdk/client-s3").DeleteObjectCommandOutput>;
+export declare const deleteS3Object: (bucket: string, key: string) => Promise<DeleteObjectCommandOutput>;
 export declare const deleteS3Objects: (params: {
     client: S3;
     bucket: string;
@@ -69,9 +69,9 @@ export declare const headObject: (Bucket: string, Key: string, retryOptions?: pR
 /**
  * Test if an object exists in S3
  *
- * @param {Object} params - same params as https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#headObject-property
+ * @param params - same params as https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#headObject-property
  * @returns {Promise<boolean>} a Promise that will resolve to a boolean indicating
- *                               if the object exists
+ *                             if the object exists
  */
 export declare const s3ObjectExists: (params: {
     Bucket: string;
@@ -79,13 +79,8 @@ export declare const s3ObjectExists: (params: {
 }) => Promise<boolean>;
 /**
  * Wait for an object to exist in S3
- *
- * @param {Object} params
- * @param {string} params.bucket
- * @param {string} params.key
- * @param {number} [params.interval=1000] - interval before retries, in ms
- * @param {number} [params.timeout=30000] - timeout, in ms
- * @returns {Promise<undefined>}
+ * @param params.interval=1000 - interval before retries, in ms
+ * @param params.timeout=30000 - timeout, in ms
  */
 export declare const waitForObjectToExist: (params: {
     bucket: string;
@@ -96,34 +91,22 @@ export declare const waitForObjectToExist: (params: {
 /**
 * Put an object on S3
 *
-* @param {Object} params - same params as https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#putObject-property
-* promise of the object being put
-* @returns {Promise}
+* @param params - same params as https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#putObject-property
 **/
-export declare const s3PutObject: (params: PutObjectCommandInput) => Promise<import("@aws-sdk/client-s3").PutObjectCommandOutput>;
+export declare const s3PutObject: (params: PutObjectCommandInput) => Promise<PutObjectCommandOutput>;
 /**
  * Upload a file to S3
  *
- * @param {string} bucket - the destination S3 bucket
- * @param {string} key - the destination S3 key
- * @param {filename} filename - the local file to be uploaded
- * @returns {Promise}
  */
-export declare const putFile: (bucket: string, key: string, filename: string) => Promise<import("@aws-sdk/client-s3").PutObjectCommandOutput>;
+export declare const putFile: (bucket: string, key: string, filename: string) => Promise<PutObjectCommandOutput>;
 /**
 * Copy an object from one location on S3 to another
-*
-* @param {Object} params - same params as https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#putObject-property
-* @returns {Promise} promise of the object being copied
 **/
-export declare const s3CopyObject: (params: CopyObjectCommandInput) => Promise<import("@aws-sdk/client-s3").CopyObjectCommandOutput>;
+export declare const s3CopyObject: (params: CopyObjectCommandInput) => Promise<CopyObjectCommandOutput>;
 /**
  * Upload data to S3
  *
  * see https://github.com/aws/aws-sdk-js-v3/tree/main/lib/lib-storage
- *
- * @param {UploadOptions} params
- * @returns {Promise}
  */
 export declare const promiseS3Upload: (params: Omit<UploadOptions, 'client'>) => Promise<{
     [key: string]: any;
@@ -131,20 +114,10 @@ export declare const promiseS3Upload: (params: Omit<UploadOptions, 'client'>) =>
 }>;
 /**
  * Upload data to S3 using a stream
- *
- * @param {Readable} uploadStream - Stream of data to upload
- * @param {Object} uploadParams
- * @returns {Promise}
  */
-export declare const streamS3Upload: (uploadStream: Readable, uploadParams: UploadOptions) => Promise<import("@aws-sdk/client-s3").CompleteMultipartUploadCommandOutput>;
+export declare const streamS3Upload: (uploadStream: Readable, uploadParams: UploadOptions) => Promise<CompleteMultipartUploadCommandOutput>;
 /**
  * Get a readable stream for an S3 object
- *
- * @param {Object} params
- * @param {S3} params.s3 - an S3 instance
- * @param {string} params.bucket - the bucket of the requested object
- * @param {string} params.key - the key of the requested object
- * @returns {Promise<Readable>}
  */
 export declare const getObjectReadStream: (params: {
     s3: {
@@ -155,20 +128,10 @@ export declare const getObjectReadStream: (params: {
 }) => Promise<Readable>;
 /**
  * Downloads the given s3Obj to the given filename in a streaming manner
- *
- * @param {Object} s3Obj - The parameters to send to S3 getObject call
- * @param {string} filepath - The filepath of the file that is downloaded
- * @returns {Promise<string>} returns filename if successful
  */
 export declare const downloadS3File: (s3Obj: GetObjectCommandInput, filepath: string) => Promise<string>;
 /**
  * Get the size of an S3 object
- *
- * @param {Object} params
- * @param {string} params.bucket
- * @param {string} params.key
- * @param {S3} params.s3 - an S3 client instance
- * @returns {Promise<number|undefined>} object size, in bytes
  */
 export declare const getObjectSize: (params: {
     s3: S3;
@@ -177,98 +140,51 @@ export declare const getObjectSize: (params: {
 }) => Promise<number | undefined>;
 /**
 * Get object Tagging from S3
-*
-* @param {string} bucket - name of bucket
-* @param {string} key - key for object (filepath + filename)
-* @returns {Promise<GetObjectTaggingOutput>} the promised response from `S3.getObjectTagging`
 **/
-export declare const s3GetObjectTagging: (bucket: string, key: string) => Promise<import("@aws-sdk/client-s3").GetObjectTaggingCommandOutput>;
+export declare const s3GetObjectTagging: (bucket: string, key: string) => Promise<GetObjectTaggingCommandOutput>;
 /**
 * Puts object Tagging in S3
 * https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#putObjectTagging-property
-*
-* @param {string} Bucket - name of bucket
-* @param {string} Key - key for object (filepath + filename)
-* @param {Object} ObjectTagging - tagging object
-* @returns {Promise} returns response from `S3.getObjectTagging` as a promise
 **/
-export declare const s3PutObjectTagging: (Bucket: string, Key: string, ObjectTagging: Tagging) => Promise<import("@aws-sdk/client-s3").PutObjectTaggingCommandOutput>;
+export declare const s3PutObjectTagging: (Bucket: string, Key: string, ObjectTagging: Tagging) => Promise<PutObjectCommandOutput>;
 /**
  * Gets an object from S3.
- *
- * @example
- * const obj = await getObject(s3(), { Bucket: 'b', Key: 'k' })
- *
- * @param {S3} s3Client - an `S3` instance
- * @param {GetObjectCommandInput} params - parameters object to pass through
- *   to `S3.getObject()`
- * @returns {Promise<GetObjectOutput>} response from `S3.getObject()`
- *   as a Promise
  */
 export declare const getObject: (s3Client: S3, params: GetObjectCommandInput) => Promise<GetObjectOutput>;
 /**
  * Get an object from S3, waiting for it to exist and, if specified, have the
  * correct ETag.
- *
- * @param {S3} s3Client
- * @param {GetObjectCommandInput} params
- * @param {pRetry.Options} [retryOptions={}]
- * @returns {Promise<GetObjectOutput>}
  */
 export declare const waitForObject: (s3Client: S3, params: GetObjectCommandInput, retryOptions?: pRetry.Options) => Promise<GetObjectOutput>;
 /**
  * Gets an object from S3.
- *
- * @param {string} Bucket - name of bucket
- * @param {string} Key - key for object (filepath + filename)
- * @param {Object} retryOptions - options to control retry behavior when an
- *   object does not exist. See https://github.com/tim-kos/node-retry#retryoperationoptions
- *   By default, retries will not be performed
- * @returns {Promise} returns response from `S3.getObject` as a promise
- *
  * @deprecated
  */
 export declare const getS3Object: (Bucket: string, Key: string, retryOptions?: pRetry.Options) => Promise<GetObjectOutput>;
 export declare const getObjectStreamBuffers: (objectReadStream: Readable) => Promise<Buffer[]>;
 /**
  * Transform streaming response from S3 object to text content
- *
- * @param {Readable} objectReadStream - Readable stream of S3 object
- * @returns {Promise<string>} the contents of the S3 object
  */
 export declare const getObjectStreamContents: (objectReadStream: Readable) => Promise<string>;
 /**
  * Fetch the contents of an S3 object
- *
- * @param {string} bucket - the S3 object's bucket
- * @param {string} key - the S3 object's key
- * @returns {Promise<string>} the contents of the S3 object
  */
 export declare const getTextObject: (bucket: string, key: string) => Promise<string>;
 /**
  * Fetch JSON stored in an S3 object
- * @param {string} bucket - the S3 object's bucket
- * @param {string} key - the S3 object's key
- * @returns {Promise<*>} the contents of the S3 object, parsed as JSON
  */
 export declare const getJsonS3Object: (bucket: string, key: string) => Promise<any>;
-export declare const putJsonS3Object: (bucket: string, key: string, data: any) => Promise<import("@aws-sdk/client-s3").PutObjectCommandOutput>;
+export declare const putJsonS3Object: (bucket: string, key: string, data: any) => Promise<PutObjectCommandOutput>;
 /**
 * Check if a file exists in an S3 object
-*
-* @param {string} bucket - name of the S3 bucket
-* @param {string} key - key of the file in the S3 bucket
-* @returns {Promise} returns the response from `S3.headObject` as a promise
 **/
-export declare const fileExists: (bucket: string, key: string) => Promise<false | import("@aws-sdk/client-s3").HeadObjectCommandOutput>;
+export declare const fileExists: (bucket: string, key: string) => Promise<HeadObjectOutput | false>;
 /**
  * Delete files from S3
  *
- * @param {Array} s3Objs - An array of objects containing keys 'Bucket' and 'Key'
- * @returns {Promise} A promise that resolves to an Array of the data returned
- *   from the deletion operations
+ * @param s3Objs - An array of objects containing keys 'Bucket' and 'Key'
  */
-export declare const deleteS3Files: (s3Objs: DeleteObjectRequest[]) => Promise<import("@aws-sdk/client-s3").DeleteObjectCommandOutput[]>;
+export declare const deleteS3Files: (s3Objs: DeleteObjectRequest[]) => Promise<DeleteObjectCommandOutput[]>;
 declare type FileInfo = {
     filename: string;
     key: string;
@@ -434,14 +350,25 @@ export declare const multipartCopyObject: (params: {
 }) => Promise<{
     etag: string;
 }>;
+/**
+ * Copy an S3 object to another location in S3
+ *
+ * @param params.ACL - an [S3 Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl)
+ * @param params.copyTags=false
+ * @param params.chunkSize - chunk size of the S3 multipart uploads
+ */
+export declare const copyObject: ({ sourceBucket, sourceKey, destinationBucket, destinationKey, ACL, copyTags, chunkSize, }: {
+    sourceBucket: string;
+    sourceKey: string;
+    destinationBucket: string;
+    destinationKey: string;
+    ACL?: string | undefined;
+    copyTags?: boolean | undefined;
+    chunkSize?: number | undefined;
+}) => Promise<void>;
 /**
  * Move an S3 object to another location in S3
  *
- * @param {Object} params
- * @param {string} params.sourceBucket
- * @param {string} params.sourceKey
- * @param {string} params.destinationBucket
- * @param {string} params.destinationKey
  * @param {string} [params.ACL] - an [S3 Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl)
  * @param {boolean} [params.copyTags=false]
  * @param {number} [params.chunkSize] - chunk size of the S3 multipart uploads
@@ -455,6 +382,6 @@ export declare const moveObject: (params: {
     ACL?: string;
     copyTags?: boolean;
     chunkSize?: number;
-}) => Promise<import("@aws-sdk/client-s3").DeleteObjectCommandOutput>;
+}) => Promise<DeleteObjectCommandOutput>;
 export {};
 //# sourceMappingURL=S3.d.ts.map

package/S3.js

@@ -29,7 +29,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.moveObject = exports.multipartCopyObject = exports.createS3Buckets = exports.createBucket = exports.getFileBucketAndKey = exports.validateS3ObjectChecksum = exports.calculateObjectHash = exports.deleteS3Buckets = exports.recursivelyDeleteS3Bucket = exports.listS3ObjectsV2Batch = exports.listS3ObjectsV2 = exports.listS3Objects = exports.uploadS3FileStream = exports.uploadS3Files = exports.deleteS3Files = exports.fileExists = exports.putJsonS3Object = exports.getJsonS3Object = exports.getTextObject = exports.getObjectStreamContents = exports.getObjectStreamBuffers = exports.getS3Object = exports.waitForObject = exports.getObject = exports.s3PutObjectTagging = exports.s3GetObjectTagging = exports.getObjectSize = exports.downloadS3File = exports.getObjectReadStream = exports.streamS3Upload = exports.promiseS3Upload = exports.s3CopyObject = exports.putFile = exports.s3PutObject = exports.waitForObjectToExist = exports.s3ObjectExists = exports.headObject = exports.deleteS3Objects = exports.deleteS3Object = exports.s3TagSetToQueryString = exports.buildS3Uri = exports.parseS3Uri = exports.s3Join = void 0;
+exports.moveObject = exports.copyObject = exports.multipartCopyObject = exports.createS3Buckets = exports.createBucket = exports.getFileBucketAndKey = exports.validateS3ObjectChecksum = exports.calculateObjectHash = exports.deleteS3Buckets = exports.recursivelyDeleteS3Bucket = exports.listS3ObjectsV2Batch = exports.listS3ObjectsV2 = exports.listS3Objects = exports.uploadS3FileStream = exports.uploadS3Files = exports.deleteS3Files = exports.fileExists = exports.putJsonS3Object = exports.getJsonS3Object = exports.getTextObject = exports.getObjectStreamContents = exports.getObjectStreamBuffers = exports.getS3Object = exports.waitForObject = exports.getObject = exports.s3PutObjectTagging = exports.s3GetObjectTagging = exports.getObjectSize = exports.downloadS3File = exports.getObjectReadStream = exports.streamS3Upload = exports.promiseS3Upload = exports.s3CopyObject = exports.putFile = exports.s3PutObject = exports.waitForObjectToExist = exports.s3ObjectExists = exports.headObject = exports.deleteS3Objects = exports.deleteS3Object = exports.s3TagSetToQueryString = exports.buildS3Uri = exports.parseS3Uri = exports.s3Join = void 0;
 const fs_1 = __importDefault(require("fs"));
 const isBoolean_1 = __importDefault(require("lodash/isBoolean"));
 const path_1 = __importDefault(require("path"));
@@ -161,9 +161,9 @@ exports.headObject = headObject;
 /**
  * Test if an object exists in S3
  *
- * @param {Object} params - same params as https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#headObject-property
+ * @param params - same params as https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#headObject-property
  * @returns {Promise<boolean>} a Promise that will resolve to a boolean indicating
- *                               if the object exists
+ *                             if the object exists
  */
 const s3ObjectExists = (params) => (0, exports.headObject)(params.Bucket, params.Key)
     .then(() => true)
@@ -175,13 +175,8 @@ const s3ObjectExists = (params) => (0, exports.headObject)(params.Bucket, params
 exports.s3ObjectExists = s3ObjectExists;
 /**
  * Wait for an object to exist in S3
- *
- * @param {Object} params
- * @param {string} params.bucket
- * @param {string} params.key
- * @param {number} [params.interval=1000] - interval before retries, in ms
- * @param {number} [params.timeout=30000] - timeout, in ms
- * @returns {Promise<undefined>}
+ * @param params.interval=1000 - interval before retries, in ms
+ * @param params.timeout=30000 - timeout, in ms
  */
 const waitForObjectToExist = async (params) => {
     const { bucket, key, interval = 1000, timeout = 30 * 1000, } = params;
@@ -202,19 +197,13 @@ exports.waitForObjectToExist = waitForObjectToExist;
 /**
 * Put an object on S3
 *
-* @param {Object} params - same params as https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#putObject-property
-* promise of the object being put
-* @returns {Promise}
+* @param params - same params as https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#putObject-property
 **/
 const s3PutObject = (params) => (0, services_1.s3)().putObject(params);
 exports.s3PutObject = s3PutObject;
 /**
  * Upload a file to S3
  *
- * @param {string} bucket - the destination S3 bucket
- * @param {string} key - the destination S3 key
- * @param {filename} filename - the local file to be uploaded
- * @returns {Promise}
  */
 const putFile = (bucket, key, filename) => (0, exports.s3PutObject)({
     Bucket: bucket,
@@ -224,9 +213,6 @@ const putFile = (bucket, key, filename) => (0, exports.s3PutObject)({
 exports.putFile = putFile;
 /**
 * Copy an object from one location on S3 to another
-*
-* @param {Object} params - same params as https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#putObject-property
-* @returns {Promise} promise of the object being copied
 **/
 const s3CopyObject = (params) => (0, services_1.s3)().copyObject({
     TaggingDirective: 'COPY',
@@ -237,9 +223,6 @@ exports.s3CopyObject = s3CopyObject;
  * Upload data to S3
  *
  * see https://github.com/aws/aws-sdk-js-v3/tree/main/lib/lib-storage
- *
- * @param {UploadOptions} params
- * @returns {Promise}
  */
 const promiseS3Upload = async (params) => {
     const parallelUploads = new lib_storage_1.Upload({
@@ -255,10 +238,6 @@ const promiseS3Upload = async (params) => {
 exports.promiseS3Upload = promiseS3Upload;
 /**
  * Upload data to S3 using a stream
- *
- * @param {Readable} uploadStream - Stream of data to upload
- * @param {Object} uploadParams
- * @returns {Promise}
  */
 const streamS3Upload = (uploadStream, uploadParams) => {
     const parallelUploads3 = new lib_storage_1.Upload({
@@ -277,12 +256,6 @@ const streamS3Upload = (uploadStream, uploadParams) => {
 exports.streamS3Upload = streamS3Upload;
 /**
  * Get a readable stream for an S3 object
- *
- * @param {Object} params
- * @param {S3} params.s3 - an S3 instance
- * @param {string} params.bucket - the bucket of the requested object
- * @param {string} params.key - the key of the requested object
- * @returns {Promise<Readable>}
  */
 const getObjectReadStream = async (params) => {
     // eslint-disable-next-line no-shadow
@@ -299,10 +272,6 @@ const getObjectReadStream = async (params) => {
 exports.getObjectReadStream = getObjectReadStream;
 /**
  * Downloads the given s3Obj to the given filename in a streaming manner
- *
- * @param {Object} s3Obj - The parameters to send to S3 getObject call
- * @param {string} filepath - The filepath of the file that is downloaded
- * @returns {Promise<string>} returns filename if successful
  */
 const downloadS3File = async (s3Obj, filepath) => {
     if (!s3Obj.Bucket || !s3Obj.Key) {
@@ -324,12 +293,6 @@ const downloadS3File = async (s3Obj, filepath) => {
 exports.downloadS3File = downloadS3File;
 /**
  * Get the size of an S3 object
- *
- * @param {Object} params
- * @param {string} params.bucket
- * @param {string} params.key
- * @param {S3} params.s3 - an S3 client instance
- * @returns {Promise<number|undefined>} object size, in bytes
  */
 const getObjectSize = async (params) => {
     // eslint-disable-next-line no-shadow
@@ -343,10 +306,6 @@ const getObjectSize = async (params) => {
 exports.getObjectSize = getObjectSize;
 /**
 * Get object Tagging from S3
-*
-* @param {string} bucket - name of bucket
-* @param {string} key - key for object (filepath + filename)
-* @returns {Promise<GetObjectTaggingOutput>} the promised response from `S3.getObjectTagging`
 **/
 const s3GetObjectTagging = (bucket, key) => (0, services_1.s3)().getObjectTagging({ Bucket: bucket, Key: key });
 exports.s3GetObjectTagging = s3GetObjectTagging;
@@ -366,11 +325,6 @@ const getObjectTaggingString = async (bucket, key) => {
 /**
 * Puts object Tagging in S3
 * https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#putObjectTagging-property
-*
-* @param {string} Bucket - name of bucket
-* @param {string} Key - key for object (filepath + filename)
-* @param {Object} ObjectTagging - tagging object
-* @returns {Promise} returns response from `S3.getObjectTagging` as a promise
 **/
 const s3PutObjectTagging = (Bucket, Key, ObjectTagging) => (0, services_1.s3)().putObjectTagging({
     Bucket,
@@ -380,26 +334,12 @@ const s3PutObjectTagging = (Bucket, Key, ObjectTagging) => (0, services_1.s3)().
 exports.s3PutObjectTagging = s3PutObjectTagging;
 /**
  * Gets an object from S3.
- *
- * @example
- * const obj = await getObject(s3(), { Bucket: 'b', Key: 'k' })
- *
- * @param {S3} s3Client - an `S3` instance
- * @param {GetObjectCommandInput} params - parameters object to pass through
- *   to `S3.getObject()`
- * @returns {Promise<GetObjectOutput>} response from `S3.getObject()`
- *   as a Promise
  */
 const getObject = (s3Client, params) => s3Client.getObject(params);
 exports.getObject = getObject;
 /**
  * Get an object from S3, waiting for it to exist and, if specified, have the
  * correct ETag.
- *
- * @param {S3} s3Client
- * @param {GetObjectCommandInput} params
- * @param {pRetry.Options} [retryOptions={}]
- * @returns {Promise<GetObjectOutput>}
  */
 const waitForObject = (s3Client, params, retryOptions = {}) => (0, p_retry_1.default)(async () => {
     try {
@@ -419,14 +359,6 @@ const waitForObject = (s3Client, params, retryOptions = {}) => (0, p_retry_1.def
 exports.waitForObject = waitForObject;
 /**
  * Gets an object from S3.
- *
- * @param {string} Bucket - name of bucket
- * @param {string} Key - key for object (filepath + filename)
- * @param {Object} retryOptions - options to control retry behavior when an
- *   object does not exist. See https://github.com/tim-kos/node-retry#retryoperationoptions
- *   By default, retries will not be performed
- * @returns {Promise} returns response from `S3.getObject` as a promise
- *
  * @deprecated
  */
 exports.getS3Object = (0, util_1.deprecate)((Bucket, Key, retryOptions = { retries: 0 }) => (0, exports.waitForObject)((0, services_1.s3)(), { Bucket, Key }, {
@@ -450,9 +382,6 @@ const getObjectStreamBuffers = (objectReadStream) => new Promise((resolve, rejec
 exports.getObjectStreamBuffers = getObjectStreamBuffers;
 /**
  * Transform streaming response from S3 object to text content
- *
- * @param {Readable} objectReadStream - Readable stream of S3 object
- * @returns {Promise<string>} the contents of the S3 object
  */
 const getObjectStreamContents = async (objectReadStream) => {
     const buffers = await (0, exports.getObjectStreamBuffers)(objectReadStream);
@@ -461,19 +390,12 @@ const getObjectStreamContents = async (objectReadStream) => {
 exports.getObjectStreamContents = getObjectStreamContents;
 /**
  * Fetch the contents of an S3 object
- *
- * @param {string} bucket - the S3 object's bucket
- * @param {string} key - the S3 object's key
- * @returns {Promise<string>} the contents of the S3 object
  */
 const getTextObject = (bucket, key) => (0, exports.getObjectReadStream)({ s3: (0, services_1.s3)(), bucket, key })
     .then((objectReadStream) => (0, exports.getObjectStreamContents)(objectReadStream));
 exports.getTextObject = getTextObject;
 /**
  * Fetch JSON stored in an S3 object
- * @param {string} bucket - the S3 object's bucket
- * @param {string} key - the S3 object's key
- * @returns {Promise<*>} the contents of the S3 object, parsed as JSON
  */
 const getJsonS3Object = (bucket, key) => (0, exports.getTextObject)(bucket, key)
     .then((text) => {
@@ -490,10 +412,6 @@ const putJsonS3Object = (bucket, key, data) => (0, exports.s3PutObject)({
 exports.putJsonS3Object = putJsonS3Object;
 /**
 * Check if a file exists in an S3 object
-*
-* @param {string} bucket - name of the S3 bucket
-* @param {string} key - key of the file in the S3 bucket
-* @returns {Promise} returns the response from `S3.headObject` as a promise
 **/
 const fileExists = async (bucket, key) => {
     try {
@@ -511,9 +429,7 @@ exports.fileExists = fileExists;
 /**
  * Delete files from S3
  *
- * @param {Array} s3Objs - An array of objects containing keys 'Bucket' and 'Key'
- * @returns {Promise} A promise that resolves to an Array of the data returned
- *   from the deletion operations
+ * @param s3Objs - An array of objects containing keys 'Bucket' and 'Key'
  */
 const deleteS3Files = async (s3Objs) => await (0, p_map_1.default)(s3Objs, (s3Obj) => (0, services_1.s3)().deleteObject(s3Obj), { concurrency: S3_RATE_LIMIT });
 exports.deleteS3Files = deleteS3Files;
@@ -878,20 +794,13 @@ const multipartCopyObject = async (params) => {
 };
 exports.multipartCopyObject = multipartCopyObject;
 /**
- * Move an S3 object to another location in S3
+ * Copy an S3 object to another location in S3
  *
- * @param {Object} params
- * @param {string} params.sourceBucket
- * @param {string} params.sourceKey
- * @param {string} params.destinationBucket
- * @param {string} params.destinationKey
- * @param {string} [params.ACL] - an [S3 Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl)
- * @param {boolean} [params.copyTags=false]
- * @param {number} [params.chunkSize] - chunk size of the S3 multipart uploads
- * @returns {Promise<undefined>}
+ * @param params.ACL - an [S3 Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl)
+ * @param params.copyTags=false
+ * @param params.chunkSize - chunk size of the S3 multipart uploads
  */
-const moveObject = async (params) => {
-    const { sourceBucket, sourceKey, destinationBucket, destinationKey, ACL, copyTags, chunkSize, } = params;
+const copyObject = async ({ sourceBucket, sourceKey, destinationBucket, destinationKey, ACL, copyTags, chunkSize, }) => {
     const sourceObject = await (0, exports.headObject)(sourceBucket, sourceKey);
     if (sourceObject.ContentLength === 0) {
         // 0 byte files cannot be copied with multipart upload,
@@ -905,7 +814,7 @@ const moveObject = async (params) => {
         // This error should never actually be reached in practice. It's a
         // necessary workaround for bad typings in the AWS SDK.
         // https://github.com/aws/aws-sdk-js/issues/1719
-        if (!CopyObjectResult || !CopyObjectResult.ETag) {
+        if (!CopyObjectResult?.ETag) {
             throw new Error(`ETag could not be determined for copy of ${(0, exports.buildS3Uri)(sourceBucket, sourceKey)} to ${s3uri}`);
         }
     }
@@ -921,6 +830,19 @@ const moveObject = async (params) => {
             chunkSize: chunkSize,
         });
     }
+};
+exports.copyObject = copyObject;
+/**
+ * Move an S3 object to another location in S3
+ *
+ * @param {string} [params.ACL] - an [S3 Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl)
+ * @param {boolean} [params.copyTags=false]
+ * @param {number} [params.chunkSize] - chunk size of the S3 multipart uploads
+ * @returns {Promise<undefined>}
+ */
+const moveObject = async (params) => {
+    const { sourceBucket, sourceKey, } = params;
+    await (0, exports.copyObject)(params);
     const deleteS3ObjRes = await (0, exports.deleteS3Object)(sourceBucket, sourceKey);
     return deleteS3ObjRes;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cumulus/aws-client",
-  "version": "20.1.0",
+  "version": "20.1.2",
   "description": "Utilities for working with AWS",
   "keywords": [
     "GIBS",
@@ -41,6 +41,7 @@
       "tests/**/*.js"
     ],
     "verbose": true,
+    "timeout": "80s",
     "failFast": true
   },
   "author": "Cumulus Authors",
@@ -68,10 +69,10 @@
     "@aws-sdk/s3-request-presigner": "^3.621.0",
     "@aws-sdk/signature-v4-crt": "^3.621.0",
     "@aws-sdk/types": "^3.609.0",
-    "@cumulus/checksum": "20.1.0",
-    "@cumulus/errors": "20.1.0",
-    "@cumulus/logger": "20.1.0",
-    "@cumulus/types": "20.1.0",
+    "@cumulus/checksum": "20.1.2",
+    "@cumulus/errors": "20.1.2",
+    "@cumulus/logger": "20.1.2",
+    "@cumulus/types": "20.1.2",
     "lodash": "~4.17.21",
     "mem": "^8.0.2",
     "p-map": "^1.2.0",
@@ -82,8 +83,8 @@
     "uuid": "^8.2.0"
   },
   "devDependencies": {
-    "@cumulus/test-data": "20.1.0",
+    "@cumulus/test-data": "20.1.2",
     "@types/uuid": "^8.0.0"
   },
-  "gitHead": "c2ecf1ce2ae86a16639848c7d42b579a7380c2f3"
+  "gitHead": "051ef1428ac21105fd55370d15e26009f4b49f57"
 }