@cumulus/aws-client 11.0.0 → 11.1.1

package/S3.d.ts

@@ -4,17 +4,10 @@
 /// <reference types="node" />
 import pRetry from 'p-retry';
 import { Readable, TransformOptions } from 'stream';
+import { CopyObjectCommandInput, DeleteObjectRequest, GetObjectCommandInput, GetObjectOutput, HeadObjectOutput, ListObjectsV2Output, ListObjectsV2Request, ObjectCannedACL, PutObjectCommandInput, PutObjectRequest, S3, Tagging } from '@aws-sdk/client-s3';
+import { Options as UploadOptions } from '@aws-sdk/lib-storage';
 import { s3 } from './services';
-export declare type GetObjectCreateReadStreamMethod = (params: AWS.S3.GetObjectRequest) => {
-    createReadStream: () => Readable;
-};
-export declare type GetObjectPromiseMethod = (params: AWS.S3.GetObjectRequest) => {
-    promise: () => Promise<AWS.S3.GetObjectOutput>;
-};
-export declare type Object = Required<AWS.S3.Object>;
-export interface ListObjectsV2Output extends AWS.S3.ListObjectsV2Output {
-    Contents: Object[];
-}
+export declare type GetObjectMethod = (params: GetObjectCommandInput) => Promise<GetObjectOutput>;
 /**
  * Join strings into an S3 key without a leading slash
  *
@@ -47,15 +40,20 @@ export declare const buildS3Uri: (bucket: string, key: string) => string;
 * @param {Array<Object>} tagset - S3 TagSet array
 * @returns {string} tags query string
 */
-export declare const s3TagSetToQueryString: (tagset: import("aws-sdk/clients/s3").TagSet) => string;
+export declare const s3TagSetToQueryString: (tagset: Tagging['TagSet']) => string | undefined;
 /**
  * Delete an object from S3
  *
  * @param {string} bucket - bucket where the object exists
  * @param {string} key - key of the object to be deleted
- * promise of the object being deleted
+ * @returns {Promise} promise of the object being deleted
  */
-export declare const deleteS3Object: (bucket: string, key: string) => Promise<import("aws-sdk/lib/request").PromiseResult<import("aws-sdk/clients/s3").DeleteObjectOutput, import("aws-sdk").AWSError>>;
+export declare const deleteS3Object: (bucket: string, key: string) => Promise<import("@aws-sdk/client-s3").DeleteObjectCommandOutput>;
+export declare const deleteS3Objects: (params: {
+    client: S3;
+    bucket: string;
+    keys: string[];
+}) => Promise<import("@aws-sdk/client-s3").DeleteObjectsCommandOutput>;
 /**
 * Get an object header from S3
 *
@@ -66,7 +64,7 @@ export declare const deleteS3Object: (bucket: string, key: string) => Promise<im
 *   By default, retries will not be performed
 * @returns {Promise} returns response from `S3.headObject` as a promise
 **/
-export declare const headObject: (Bucket: string, Key: string, retryOptions?: pRetry.Options | undefined) => Promise<import("aws-sdk/lib/request").PromiseResult<import("aws-sdk/clients/s3").HeadObjectOutput, import("aws-sdk").AWSError>>;
+export declare const headObject: (Bucket: string, Key: string, retryOptions?: pRetry.Options) => Promise<import("@aws-sdk/client-s3").HeadObjectCommandOutput>;
 /**
  * Test if an object exists in S3
  *
@@ -99,8 +97,9 @@ export declare const waitForObjectToExist: (params: {
 *
 * @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}
 **/
-export declare const s3PutObject: (params: import("aws-sdk/clients/s3").PutObjectRequest) => Promise<import("aws-sdk/lib/request").PromiseResult<import("aws-sdk/clients/s3").PutObjectOutput, import("aws-sdk").AWSError>>;
+export declare const s3PutObject: (params: PutObjectCommandInput) => Promise<import("@aws-sdk/client-s3").PutObjectCommandOutput>;
 /**
  * Upload a file to S3
  *
@@ -109,35 +108,50 @@ export declare const s3PutObject: (params: import("aws-sdk/clients/s3").PutObjec
  * @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/lib/request").PromiseResult<import("aws-sdk/clients/s3").PutObjectOutput, import("aws-sdk").AWSError>>;
+export declare const putFile: (bucket: string, key: string, filename: string) => Promise<import("@aws-sdk/client-s3").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: import("aws-sdk/clients/s3").CopyObjectRequest) => Promise<import("aws-sdk/lib/request").PromiseResult<import("aws-sdk/clients/s3").CopyObjectOutput, import("aws-sdk").AWSError>>;
+export declare const s3CopyObject: (params: CopyObjectCommandInput) => Promise<import("@aws-sdk/client-s3").CopyObjectCommandOutput>;
 /**
  * Upload data to S3
  *
- * Note: This is equivalent to calling `aws.s3().upload(params).promise()`
+ * see https://github.com/aws/aws-sdk-js-v3/tree/main/lib/lib-storage
  *
- * @param {Object} params - see [S3.upload()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#upload-property)
- * @returns {Promise} see [S3.upload()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#upload-property)
+ * @param {UploadOptions} params
+ * @returns {Promise}
  */
-export declare const promiseS3Upload: (params: import("aws-sdk/clients/s3").PutObjectRequest) => Promise<import("aws-sdk/clients/s3").ManagedUpload.SendData>;
+export declare const promiseS3Upload: (params: Omit<UploadOptions, 'client'>) => Promise<{
+    [key: string]: any;
+    ETag?: string | undefined;
+}>;
 /**
  * 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.
- *
  * @param {Readable} uploadStream - Stream of data to upload
- * @param {Object} uploadParams - see [S3.upload()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#upload-property)
+ * @param {Object} uploadParams
  * @returns {Promise}
  */
-export declare const streamS3Upload: (uploadStream: Readable, uploadParams: AWS.S3.PutObjectRequest) => Promise<unknown>;
+export declare const streamS3Upload: (uploadStream: Readable, uploadParams: UploadOptions) => Promise<import("@aws-sdk/client-s3").ServiceOutputTypes>;
+/**
+ * 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: {
+        getObject: GetObjectMethod;
+    };
+    bucket: string;
+    key: string;
+}) => Promise<Readable>;
 /**
  * Downloads the given s3Obj to the given filename in a streaming manner
  *
@@ -145,27 +159,18 @@ export declare const streamS3Upload: (uploadStream: Readable, uploadParams: AWS.
  * @param {string} filepath - The filepath of the file that is downloaded
  * @returns {Promise<string>} returns filename if successful
  */
-export declare const downloadS3File: (s3Obj: AWS.S3.GetObjectRequest, filepath: string) => Promise<string>;
+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 {AWS.S3} params.s3 - an S3 client instance
+ * @param {S3} params.s3 - an S3 client instance
  * @returns {Promise<number|undefined>} object size, in bytes
  */
 export declare const getObjectSize: (params: {
-    s3: {
-        headObject: (params: {
-            Bucket: string;
-            Key: string;
-        }) => {
-            promise: () => Promise<{
-                ContentLength?: number;
-            }>;
-        };
-    };
+    s3: S3;
     bucket: string;
     key: string;
 }) => Promise<number | undefined>;
@@ -174,46 +179,42 @@ export declare const getObjectSize: (params: {
 *
 * @param {string} bucket - name of bucket
 * @param {string} key - key for object (filepath + filename)
-* @returns {Promise<AWS.S3.GetObjectTaggingOutput>} the promised response from `S3.getObjectTagging`
+* @returns {Promise<GetObjectTaggingOutput>} the promised response from `S3.getObjectTagging`
 **/
-export declare const s3GetObjectTagging: (bucket: string, key: string) => Promise<import("aws-sdk/lib/request").PromiseResult<import("aws-sdk/clients/s3").GetObjectTaggingOutput, import("aws-sdk").AWSError>>;
+export declare const s3GetObjectTagging: (bucket: string, key: string) => Promise<import("@aws-sdk/client-s3").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} Tagging - tagging object
+* @param {Object} ObjectTagging - tagging object
 * @returns {Promise} returns response from `S3.getObjectTagging` as a promise
 **/
-export declare const s3PutObjectTagging: (Bucket: string, Key: string, Tagging: import("aws-sdk/clients/s3").Tagging) => Promise<import("aws-sdk/lib/request").PromiseResult<import("aws-sdk/clients/s3").PutObjectTaggingOutput, import("aws-sdk").AWSError>>;
+export declare const s3PutObjectTagging: (Bucket: string, Key: string, ObjectTagging: Tagging) => Promise<import("@aws-sdk/client-s3").PutObjectTaggingCommandOutput>;
 /**
  * Gets an object from S3.
  *
  * @example
  * const obj = await getObject(s3(), { Bucket: 'b', Key: 'k' })
  *
- * @param {AWS.S3} s3Client - an `AWS.S3` instance
- * @param {AWS.S3.GetObjectRequest} params - parameters object to pass through
- *   to `AWS.S3.getObject()`
- * @returns {Promise<AWS.S3.GetObjectOutput>} response from `AWS.S3.getObject()`
+ * @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: {
-    getObject: GetObjectPromiseMethod;
-}, params: AWS.S3.GetObjectRequest) => Promise<AWS.S3.GetObjectOutput>;
+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 {AWS.S3} s3Client
- * @param {AWS.S3.GetObjectRequest} params
+ * @param {S3} s3Client
+ * @param {GetObjectCommandInput} params
  * @param {pRetry.Options} [retryOptions={}]
- * @returns {Promise<AWS.S3.GetObjectOutput>}
+ * @returns {Promise<GetObjectOutput>}
  */
-export declare const waitForObject: (s3Client: {
-    getObject: GetObjectPromiseMethod;
-}, params: AWS.S3.GetObjectRequest, retryOptions?: pRetry.Options) => Promise<AWS.S3.GetObjectOutput>;
+export declare const waitForObject: (s3Client: S3, params: GetObjectCommandInput, retryOptions?: pRetry.Options) => Promise<GetObjectOutput>;
 /**
  * Gets an object from S3.
  *
@@ -226,7 +227,15 @@ export declare const waitForObject: (s3Client: {
  *
  * @deprecated
  */
-export declare const getS3Object: (Bucket: string, Key: string, retryOptions?: pRetry.Options | undefined) => Promise<import("aws-sdk/clients/s3").GetObjectOutput>;
+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
  *
@@ -234,7 +243,7 @@ export declare const getS3Object: (Bucket: string, Key: string, retryOptions?: p
  * @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 | undefined>;
+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
@@ -242,23 +251,7 @@ export declare const getTextObject: (bucket: string, key: string) => Promise<str
  * @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/lib/request").PromiseResult<import("aws-sdk/clients/s3").PutObjectOutput, import("aws-sdk").AWSError>>;
-/**
- * Get a readable stream for an S3 object
- *
- * @param {Object} params
- * @param {AWS.S3} params.s3 - an AWS.S3 instance
- * @param {string} params.bucket - the bucket of the requested object
- * @param {string} params.key - the key of the requested object
- * @returns {Readable}
- */
-export declare const getObjectReadStream: (params: {
-    s3: {
-        getObject: GetObjectCreateReadStreamMethod;
-    };
-    bucket: string;
-    key: string;
-}) => Readable;
+export declare const putJsonS3Object: (bucket: string, key: string, data: any) => Promise<import("@aws-sdk/client-s3").PutObjectCommandOutput>;
 /**
 * Check if a file exists in an S3 object
 *
@@ -266,8 +259,7 @@ export declare const getObjectReadStream: (params: {
 * @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/lib/request").PromiseResult<import("aws-sdk/clients/s3").HeadObjectOutput, import("aws-sdk").AWSError>>;
-export declare const downloadS3Files: (s3Objs: AWS.S3.GetObjectRequest[], dir: string, s3opts?: Partial<AWS.S3.GetObjectRequest>) => Promise<unknown[]>;
+export declare const fileExists: (bucket: string, key: string) => Promise<false | import("@aws-sdk/client-s3").HeadObjectCommandOutput>;
 /**
  * Delete files from S3
  *
@@ -275,16 +267,14 @@ export declare const downloadS3Files: (s3Objs: AWS.S3.GetObjectRequest[], dir: s
  * @returns {Promise} A promise that resolves to an Array of the data returned
  *   from the deletion operations
  */
-export declare const deleteS3Files: (s3Objs: AWS.S3.DeleteObjectRequest[]) => Promise<import("aws-sdk/lib/request").PromiseResult<import("aws-sdk/clients/s3").DeleteObjectOutput, import("aws-sdk").AWSError>[]>;
+export declare const deleteS3Files: (s3Objs: DeleteObjectRequest[]) => Promise<import("@aws-sdk/client-s3").DeleteObjectCommandOutput[]>;
 /**
 * Delete a bucket and all of its objects from S3
 *
 * @param {string} bucket - name of the bucket
 * @returns {Promise} the promised result of `S3.deleteBucket`
 **/
-export declare const recursivelyDeleteS3Bucket: (bucket: string) => Promise<{
-    $response: import("aws-sdk").Response<{}, import("aws-sdk").AWSError>;
-}>;
+export declare const recursivelyDeleteS3Bucket: (bucket: string) => Promise<import("@aws-sdk/client-s3").DeleteBucketCommandOutput>;
 /**
 * Delete a list of buckets and all of their objects from S3
 *
@@ -297,7 +287,7 @@ declare type FileInfo = {
     key: string;
     bucket: string;
 };
-export declare const uploadS3Files: (files: Array<string | FileInfo>, defaultBucket: string, keyPath: string | ((x: string) => string), s3opts?: Partial<AWS.S3.PutObjectRequest>) => Promise<{
+export declare const uploadS3Files: (files: Array<string | FileInfo>, defaultBucket: string, keyPath: string | ((x: string) => string), s3opts?: Partial<PutObjectRequest>) => Promise<{
     key: string;
     bucket: string;
 }[]>;
@@ -310,7 +300,10 @@ export declare const uploadS3Files: (files: Array<string | FileInfo>, defaultBuc
  * @param {Object} s3opts - Options to pass to the AWS sdk call (defaults to `{}`)
  * @returns {Promise} A promise
  */
-export declare const uploadS3FileStream: (fileStream: Readable, bucket: string, key: string, s3opts?: Partial<AWS.S3.PutObjectRequest>) => Promise<import("aws-sdk/clients/s3").ManagedUpload.SendData>;
+export declare const uploadS3FileStream: (fileStream: Readable, bucket: string, key: string, s3opts?: Partial<PutObjectRequest>) => Promise<{
+    [key: string]: any;
+    ETag?: string | undefined;
+}>;
 /**
  * List the objects in an S3 bucket
  *
@@ -323,8 +316,7 @@ export declare const uploadS3FileStream: (fileStream: Readable, bucket: string,
  *   object is represented as a JS object with the following attributes: `Key`,
  * `ETag`, `LastModified`, `Owner`, `Size`, `StorageClass`.
  */
-export declare const listS3Objects: (bucket: string, prefix?: string | undefined, skipFolders?: boolean) => Promise<import("aws-sdk/clients/s3").ObjectList>;
-export declare type ListS3ObjectsV2Result = Promise<Object[]>;
+export declare const listS3Objects: (bucket: string, prefix?: string | undefined, skipFolders?: boolean) => Promise<import("@aws-sdk/client-s3")._Object[]>;
 /**
  * Fetch complete list of S3 objects
  *
@@ -341,12 +333,12 @@ export declare type ListS3ObjectsV2Result = Promise<Object[]>;
  *
  * @static
  */
-export declare const listS3ObjectsV2: (params: AWS.S3.ListObjectsV2Request) => ListS3ObjectsV2Result;
+export declare const listS3ObjectsV2: (params: ListObjectsV2Request) => Promise<ListObjectsV2Output['Contents']>;
 /**
  * Calculate the cryptographic hash of an S3 object
  *
  * @param {Object} params
- * @param {AWS.S3} params.s3 - an AWS.S3 instance
+ * @param {S3} params.s3 - an S3 instance
  * @param {string} params.algorithm - `cksum`, or an algorithm listed in
  *   `openssl list -digest-algorithms`
  * @param {string} params.bucket
@@ -354,7 +346,7 @@ export declare const listS3ObjectsV2: (params: AWS.S3.ListObjectsV2Request) => L
  */
 export declare const calculateObjectHash: (params: {
     s3: {
-        getObject: GetObjectCreateReadStreamMethod;
+        getObject: GetObjectMethod;
     };
     algorithm: string;
     bucket: string;
@@ -394,7 +386,7 @@ export declare const getFileBucketAndKey: (pathParams: string) => [string, strin
  * @param {string} Bucket - the name of the S3 bucket to create
  * @returns {Promise}
  */
-export declare const createBucket: (Bucket: string) => Promise<import("aws-sdk/lib/request").PromiseResult<import("aws-sdk/clients/s3").CreateBucketOutput, import("aws-sdk").AWSError>>;
+export declare const createBucket: (Bucket: string) => Promise<import("@aws-sdk/client-s3").CreateBucketCommandOutput>;
 /**
  * Create multiple S3 buckets
  *
@@ -410,7 +402,7 @@ export declare const createS3Buckets: (buckets: Array<string>) => Promise<any>;
  * @param {string} params.sourceKey
  * @param {string} params.destinationBucket
  * @param {string} params.destinationKey
- * @param {AWS.S3.HeadObjectOutput} [params.sourceObject]
+ * @param {S3.HeadObjectOutput} [params.sourceObject]
  *   Output from https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#headObject-property
  * @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]
@@ -423,8 +415,8 @@ export declare const multipartCopyObject: (params: {
     sourceKey: string;
     destinationBucket: string;
     destinationKey: string;
-    sourceObject?: AWS.S3.HeadObjectOutput;
-    ACL?: AWS.S3.ObjectCannedACL;
+    sourceObject?: HeadObjectOutput;
+    ACL?: ObjectCannedACL;
     copyTags?: boolean;
     chunkSize?: number;
 }) => Promise<{
@@ -448,9 +440,9 @@ export declare const moveObject: (params: {
     sourceKey: string;
     destinationBucket: string;
     destinationKey: string;
-    ACL?: AWS.S3.ObjectCannedACL;
+    ACL?: string;
     copyTags?: boolean;
     chunkSize?: number;
-}) => Promise<import("aws-sdk/lib/request").PromiseResult<import("aws-sdk/clients/s3").DeleteObjectOutput, import("aws-sdk").AWSError>>;
+}) => Promise<import("@aws-sdk/client-s3").DeleteObjectCommandOutput>;
 export {};
 //# sourceMappingURL=S3.d.ts.map