@cumulus/aws-client 11.1.0-alpha1 → 12.0.0

package/LICENSE

@@ -0,0 +1,60 @@
+Copyright © 2020 United States Government as represented by the Administrator of the National Aeronautics and Space Administration. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICE NSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+---
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+    You must give any other recipients of the Work or Derivative Works a copy of this License; and
+    You must cause any modified files to carry prominent notices stating that You changed the files; and
+    You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+    If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -143,41 +143,19 @@ Create a CloudWatch Events rule
 
 * [DynamoDb](#module_DynamoDb)
     * _static_
-        * [.get](#module_DynamoDb.get) ⇒ <code>Promise.&lt;Object&gt;</code>
         * [.scan](#module_DynamoDb.scan) ⇒ <code>Promise.&lt;Object&gt;</code>
         * [.createAndWaitForDynamoDbTable(params)](#module_DynamoDb.createAndWaitForDynamoDbTable) ⇒ <code>Promise.&lt;Object&gt;</code>
         * [.deleteAndWaitForDynamoDbTableNotExists(params)](#module_DynamoDb.deleteAndWaitForDynamoDbTableNotExists) ⇒ <code>Promise</code>
     * _inner_
+        * [~get(params)](#module_DynamoDb..get) ⇒ <code>Promise.&lt;Object&gt;</code>
         * [~parallelScan(params)](#module_DynamoDb..parallelScan) ⇒ <code>Promise</code>
 
-<a name="module_DynamoDb.get"></a>
-
-### DynamoDb.get ⇒ <code>Promise.&lt;Object&gt;</code>
-Call DynamoDb client get
-
-See [DocumentClient.get()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#get-property)
-for descriptions of `params` and the return data.
-
-**Kind**: static property of [<code>DynamoDb</code>](#module_DynamoDb)  
-**Throws**:
-
-- <code>RecordDoesNotExist</code> if a record cannot be found
-
-
-| Param | Type | Description |
-| --- | --- | --- |
-| params | <code>Object</code> |  |
-| params.tableName | <code>string</code> | Table name to read |
-| params.item | <code>AWS.DynamoDB.DocumentClient.Key</code> | Key identifying object to get |
-| params.client | <code>AWS.DynamoDB.DocumentClient</code> | Instance of a DynamoDb DocumentClient |
-| params.getParams | <code>Object</code> | Additional parameters for DocumentClient.get() |
-
 <a name="module_DynamoDb.scan"></a>
 
 ### DynamoDb.scan ⇒ <code>Promise.&lt;Object&gt;</code>
 Call DynamoDb client scan
 
-See [DocumentClient.scan()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#scan-property)
+See [DocumentClient.scan()](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_lib_dynamodb.html)
 for descriptions of `params` and the return data.
 
 **Kind**: static property of [<code>DynamoDb</code>](#module_DynamoDb)  
@@ -196,7 +174,7 @@ Create a DynamoDB table and then wait for the table to exist
 
 | Param | Type | Description |
 | --- | --- | --- |
-| params | <code>Object</code> | the same params that you would pass to AWS.createTable   See https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#createTable-property |
+| params | <code>Object</code> | the same params that you would pass to AWS.createTable   See https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-dynamodb/classes/dynamodb.html#createtable |
 
 <a name="module_DynamoDb.deleteAndWaitForDynamoDbTableNotExists"></a>
 
@@ -207,7 +185,29 @@ Delete a DynamoDB table and then wait for the table to not exist
 
 | Param | Type | Description |
 | --- | --- | --- |
-| params | <code>Object</code> | the same params that you would pass to AWS.deleteTable   See https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#deleteTable-property |
+| params | <code>Object</code> | the same params that you would pass to AWS.deleteTable   See https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-dynamodb/classes/dynamodb.html#deletetable |
+
+<a name="module_DynamoDb..get"></a>
+
+### DynamoDb~get(params) ⇒ <code>Promise.&lt;Object&gt;</code>
+Call DynamoDb client get
+
+See [DocumentClient.get()](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_lib_dynamodb.html)
+for descriptions of `params` and the return data.
+
+**Kind**: inner method of [<code>DynamoDb</code>](#module_DynamoDb)  
+**Throws**:
+
+- <code>RecordDoesNotExist</code> if a record cannot be found
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>Object</code> |  |
+| params.tableName | <code>string</code> | Table name to read |
+| params.item | <code>GetCommandInput.Key</code> | Key identifying object to get |
+| params.client | <code>DynamoDBDocument</code> | Instance of a DynamoDb DocumentClient |
+| params.getParams | <code>Object</code> | Additional parameters for DocumentClient.get() |
 
 <a name="module_DynamoDb..parallelScan"></a>
 
@@ -215,7 +215,7 @@ Delete a DynamoDB table and then wait for the table to not exist
 Do a parallel scan of DynamoDB table using a document client.
 
 See https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan.
-See [DocumentClient.scan()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#scan-property).
+See [DocumentClient.scan()](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_lib_dynamodb.html).
 
 **Kind**: inner method of [<code>DynamoDb</code>](#module_DynamoDb)  
 
@@ -223,9 +223,9 @@ See [DocumentClient.scan()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/
 | --- | --- | --- |
 | params | <code>Object</code> |  |
 | params.totalSegments | <code>number</code> | Total number of segments to divide table into for parallel scanning |
-| params.scanParams | <code>DocumentClient.ScanInput</code> | Params for the DynamoDB client scan operation   See https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Scan.html |
+| params.scanParams | <code>ScanInput</code> | Params for the DynamoDB client scan operation   See https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Scan.html |
 | params.processItemsFunc | <code>function</code> | Function used to process returned items by scan |
-| [params.dynamoDbClient] | <code>DocumentClient</code> | Instance of Dynamo DB document client |
+| [params.dynamoDbClient] | <code>DynamoDBDocument</code> | Instance of Dynamo DB document client |
 | [params.retryOptions] | <code>pRetry.Options</code> | Retry options for scan operations |
 
 <a name="module_KMS"></a>
@@ -315,13 +315,6 @@ Invoke a Lambda function
 
 * [S3](#module_S3)
     * _static_
-        * [.deleteS3Object](#module_S3.deleteS3Object)
-        * [.headObject](#module_S3.headObject) ⇒ <code>Promise</code>
-        * [.s3PutObject](#module_S3.s3PutObject)
-        * [.s3CopyObject](#module_S3.s3CopyObject) ⇒ <code>Promise</code>
-        * [.promiseS3Upload](#module_S3.promiseS3Upload) ⇒ <code>Promise</code>
-        * [.s3GetObjectTagging](#module_S3.s3GetObjectTagging) ⇒ <code>Promise.&lt;AWS.S3.GetObjectTaggingOutput&gt;</code>
-        * [.s3PutObjectTagging](#module_S3.s3PutObjectTagging) ⇒ <code>Promise</code>
         * ~~[.getS3Object](#module_S3.getS3Object) ⇒ <code>Promise</code>~~
         * [.recursivelyDeleteS3Bucket](#module_S3.recursivelyDeleteS3Bucket) ⇒ <code>Promise</code>
         * [.listS3ObjectsV2(params)](#module_S3.listS3ObjectsV2) ⇒ <code>Promise.&lt;Array&gt;</code>
@@ -330,17 +323,25 @@ Invoke a Lambda function
         * [~parseS3Uri(uri)](#module_S3..parseS3Uri) ⇒ <code>Object</code>
         * [~buildS3Uri(bucket, key)](#module_S3..buildS3Uri) ⇒ <code>string</code>
         * [~s3TagSetToQueryString(tagset)](#module_S3..s3TagSetToQueryString) ⇒ <code>string</code>
+        * [~deleteS3Object(bucket, key)](#module_S3..deleteS3Object) ⇒ <code>Promise</code>
+        * [~headObject(Bucket, Key, retryOptions)](#module_S3..headObject) ⇒ <code>Promise</code>
         * [~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>
-        * [~getObject(s3Client, params)](#module_S3..getObject) ⇒ <code>Promise.&lt;AWS.S3.GetObjectOutput&gt;</code>
-        * [~waitForObject(s3Client, params, [retryOptions])](#module_S3..waitForObject) ⇒ <code>Promise.&lt;AWS.S3.GetObjectOutput&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>
-        * [~getObjectReadStream(params)](#module_S3..getObjectReadStream) ⇒ <code>Readable</code>
         * [~fileExists(bucket, key)](#module_S3..fileExists) ⇒ <code>Promise</code>
         * [~deleteS3Files(s3Objs)](#module_S3..deleteS3Files) ⇒ <code>Promise</code>
         * [~deleteS3Buckets(buckets)](#module_S3..deleteS3Buckets) ⇒ <code>Promise</code>
@@ -354,97 +355,6 @@ Invoke a Lambda function
         * [~multipartCopyObject(params)](#module_S3..multipartCopyObject) ⇒ <code>Promise.&lt;{etag: string}&gt;</code>
         * [~moveObject(params)](#module_S3..moveObject) ⇒ <code>Promise.&lt;undefined&gt;</code>
 
-<a name="module_S3.deleteS3Object"></a>
-
-### S3.deleteS3Object
-Delete an object from S3
-
-**Kind**: static property of [<code>S3</code>](#module_S3)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| bucket | <code>string</code> | bucket where the object exists |
-| key | <code>string</code> | key of the object to be deleted promise of the object being deleted |
-
-<a name="module_S3.headObject"></a>
-
-### S3.headObject ⇒ <code>Promise</code>
-Get an object header from S3
-
-**Kind**: static property of [<code>S3</code>](#module_S3)  
-**Returns**: <code>Promise</code> - returns response from `S3.headObject` 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.s3PutObject"></a>
-
-### S3.s3PutObject
-Put an object on S3
-
-**Kind**: static property 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 |
-
-<a name="module_S3.s3CopyObject"></a>
-
-### S3.s3CopyObject ⇒ <code>Promise</code>
-Copy an object from one location on S3 to another
-
-**Kind**: static property 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 ⇒ <code>Promise</code>
-Upload data to S3
-
-Note: This is equivalent to calling `aws.s3().upload(params).promise()`
-
-**Kind**: static property of [<code>S3</code>](#module_S3)  
-**Returns**: <code>Promise</code> - see [S3.upload()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#upload-property)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| params | <code>Object</code> | see [S3.upload()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#upload-property) |
-
-<a name="module_S3.s3GetObjectTagging"></a>
-
-### S3.s3GetObjectTagging ⇒ <code>Promise.&lt;AWS.S3.GetObjectTaggingOutput&gt;</code>
-Get object Tagging from S3
-
-**Kind**: static property of [<code>S3</code>](#module_S3)  
-**Returns**: <code>Promise.&lt;AWS.S3.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 ⇒ <code>Promise</code>
-Puts object Tagging in S3
-https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#putObjectTagging-property
-
-**Kind**: static property 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) |
-| Tagging | <code>Object</code> | tagging object |
-
 <a name="module_S3.getS3Object"></a>
 
 ### ~~S3.getS3Object ⇒ <code>Promise</code>~~
@@ -543,6 +453,33 @@ e.g. [{ Key: 'tag', Value: 'value }] to 'tag=value'
 | --- | --- | --- |
 | tagset | <code>Array.&lt;Object&gt;</code> | S3 TagSet array |
 
+<a name="module_S3..deleteS3Object"></a>
+
+### S3~deleteS3Object(bucket, key) ⇒ <code>Promise</code>
+Delete an object from S3
+
+**Kind**: inner method of [<code>S3</code>](#module_S3)  
+**Returns**: <code>Promise</code> - promise of the object being deleted  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| bucket | <code>string</code> | bucket where the object exists |
+| key | <code>string</code> | key of the object to be deleted |
+
+<a name="module_S3..headObject"></a>
+
+### S3~headObject(Bucket, Key, retryOptions) ⇒ <code>Promise</code>
+Get an object header from S3
+
+**Kind**: inner method of [<code>S3</code>](#module_S3)  
+**Returns**: <code>Promise</code> - returns response from `S3.headObject` 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..s3ObjectExists"></a>
 
 ### S3~s3ObjectExists(params) ⇒ <code>Promise.&lt;boolean&gt;</code>
@@ -571,6 +508,17 @@ Wait for an object to exist in S3
 | [params.interval] | <code>number</code> | <code>1000</code> | interval before retries, in ms |
 | [params.timeout] | <code>number</code> | <code>30000</code> | timeout, in ms |
 
+<a name="module_S3..s3PutObject"></a>
+
+### S3~s3PutObject(params) ⇒ <code>Promise</code>
+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 |
+
 <a name="module_S3..putFile"></a>
 
 ### S3~putFile(bucket, key, filename) ⇒ <code>Promise</code>
@@ -584,21 +532,56 @@ Upload a file to S3
 | 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>
+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>
+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>
 Upload data to S3 using a stream
 
-We are not using `s3.upload().promise()` due to errors observed in testing
-with uncaught exceptions. By creating our own promise, we can ensure any
-errors from the streams or upload cause this promise to reject.
-
 **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> | see [S3.upload()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#upload-property) |
+| uploadParams | <code>Object</code> |  |
+
+<a name="module_S3..getObjectReadStream"></a>
+
+### S3~getObjectReadStream(params) ⇒ <code>Promise.&lt;Readable&gt;</code>
+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>
 
@@ -626,21 +609,49 @@ Get the size of an S3 object
 | params | <code>Object</code> |  |
 | params.bucket | <code>string</code> |  |
 | params.key | <code>string</code> |  |
-| params.s3 | <code>AWS.S3</code> | an S3 client instance |
+| 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>
+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>
+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;AWS.S3.GetObjectOutput&gt;</code>
+### S3~getObject(s3Client, params) ⇒ <code>Promise.&lt;GetObjectOutput&gt;</code>
 Gets an object from S3.
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
-**Returns**: <code>Promise.&lt;AWS.S3.GetObjectOutput&gt;</code> - response from `AWS.S3.getObject()`
+**Returns**: <code>Promise.&lt;GetObjectOutput&gt;</code> - response from `S3.getObject()`
   as a Promise  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| s3Client | <code>AWS.S3</code> | an `AWS.S3` instance |
-| params | <code>AWS.S3.GetObjectRequest</code> | parameters object to pass through   to `AWS.S3.getObject()` |
+| s3Client | <code>S3</code> | an `S3` instance |
+| params | <code>GetObjectCommandInput</code> | parameters object to pass through   to `S3.getObject()` |
 
 **Example**  
 ```js
@@ -648,7 +659,7 @@ const obj = await getObject(s3(), { Bucket: 'b', Key: 'k' })
 ```
 <a name="module_S3..waitForObject"></a>
 
-### S3~waitForObject(s3Client, params, [retryOptions]) ⇒ <code>Promise.&lt;AWS.S3.GetObjectOutput&gt;</code>
+### S3~waitForObject(s3Client, params, [retryOptions]) ⇒ <code>Promise.&lt;GetObjectOutput&gt;</code>
 Get an object from S3, waiting for it to exist and, if specified, have the
 correct ETag.
 
@@ -656,10 +667,22 @@ correct ETag.
 
 | Param | Type | Default |
 | --- | --- | --- |
-| s3Client | <code>AWS.S3</code> |  | 
-| params | <code>AWS.S3.GetObjectRequest</code> |  | 
+| 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>
+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>
@@ -686,20 +709,6 @@ Fetch JSON stored in an S3 object
 | bucket | <code>string</code> | the S3 object's bucket |
 | key | <code>string</code> | the S3 object's key |
 
-<a name="module_S3..getObjectReadStream"></a>
-
-### S3~getObjectReadStream(params) ⇒ <code>Readable</code>
-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>AWS.S3</code> | an AWS.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..fileExists"></a>
 
 ### S3~fileExists(bucket, key) ⇒ <code>Promise</code>
@@ -779,7 +788,7 @@ Calculate the cryptographic hash of an S3 object
 | Param | Type | Description |
 | --- | --- | --- |
 | params | <code>Object</code> |  |
-| params.s3 | <code>AWS.S3</code> | an AWS.S3 instance |
+| params.s3 | <code>S3</code> | an S3 instance |
 | params.algorithm | <code>string</code> | `cksum`, or an algorithm listed in   `openssl list -digest-algorithms` |
 | params.bucket | <code>string</code> |  |
 | params.key | <code>string</code> |  |
@@ -855,7 +864,7 @@ Copy an S3 object to another location in S3 using a multipart copy
 | params.sourceKey | <code>string</code> |  |  |
 | params.destinationBucket | <code>string</code> |  |  |
 | params.destinationKey | <code>string</code> |  |  |
-| [params.sourceObject] | <code>AWS.S3.HeadObjectOutput</code> |  | Output from https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#headObject-property |
+| [params.sourceObject] | <code>S3.HeadObjectOutput</code> |  | Output from https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#headObject-property |
 | [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 |