@cumulus/aws-client 9.7.1 → 10.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/S3.d.ts CHANGED
@@ -193,13 +193,13 @@ export declare const s3PutObjectTagging: (Bucket: string, Key: string, Tagging:
193
193
  * @example
194
194
  * const obj = await getObject(s3(), { Bucket: 'b', Key: 'k' })
195
195
  *
196
- * @param {AWS.S3} s3 - an `AWS.S3` instance
196
+ * @param {AWS.S3} s3Client - an `AWS.S3` instance
197
197
  * @param {AWS.S3.GetObjectRequest} params - parameters object to pass through
198
198
  * to `AWS.S3.getObject()`
199
199
  * @returns {Promise<AWS.S3.GetObjectOutput>} response from `AWS.S3.getObject()`
200
200
  * as a Promise
201
201
  */
202
- export declare const getObject: (s3: {
202
+ export declare const getObject: (s3Client: {
203
203
  getObject: GetObjectPromiseMethod;
204
204
  }, params: AWS.S3.GetObjectRequest) => Promise<AWS.S3.GetObjectOutput>;
205
205
  /**
@@ -282,7 +282,9 @@ export declare const deleteS3Files: (s3Objs: AWS.S3.DeleteObjectRequest[]) => Pr
282
282
  * @param {string} bucket - name of the bucket
283
283
  * @returns {Promise} the promised result of `S3.deleteBucket`
284
284
  **/
285
- export declare const recursivelyDeleteS3Bucket: (bucket: string) => Promise<void>;
285
+ export declare const recursivelyDeleteS3Bucket: (bucket: string) => Promise<{
286
+ $response: import("aws-sdk").Response<{}, import("aws-sdk").AWSError>;
287
+ }>;
286
288
  /**
287
289
  * Delete a list of buckets and all of their objects from S3
288
290
  *
@@ -412,6 +414,7 @@ export declare const createS3Buckets: (buckets: Array<string>) => Promise<any>;
412
414
  * Output from https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#headObject-property
413
415
  * @param {string} [params.ACL] - an [S3 Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl)
414
416
  * @param {boolean} [params.copyTags=false]
417
+ * @param {number} [params.chunkSize] - chunk size of the S3 multipart uploads
415
418
  * @returns {Promise.<{ etag: string }>} object containing the ETag of the
416
419
  * destination object
417
420
  */
@@ -423,7 +426,7 @@ export declare const multipartCopyObject: (params: {
423
426
  sourceObject?: AWS.S3.HeadObjectOutput;
424
427
  ACL?: AWS.S3.ObjectCannedACL;
425
428
  copyTags?: boolean;
426
- copyMetadata?: boolean;
429
+ chunkSize?: number;
427
430
  }) => Promise<{
428
431
  etag: string;
429
432
  }>;
@@ -437,6 +440,7 @@ export declare const multipartCopyObject: (params: {
437
440
  * @param {string} params.destinationKey
438
441
  * @param {string} [params.ACL] - an [S3 Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl)
439
442
  * @param {boolean} [params.copyTags=false]
443
+ * @param {number} [params.chunkSize] - chunk size of the S3 multipart uploads
440
444
  * @returns {Promise<undefined>}
441
445
  */
442
446
  export declare const moveObject: (params: {
@@ -446,6 +450,7 @@ export declare const moveObject: (params: {
446
450
  destinationKey: string;
447
451
  ACL?: AWS.S3.ObjectCannedACL;
448
452
  copyTags?: boolean;
449
- }) => Promise<void>;
453
+ chunkSize?: number;
454
+ }) => Promise<import("aws-sdk/lib/request").PromiseResult<import("aws-sdk/clients/s3").DeleteObjectOutput, import("aws-sdk").AWSError>>;
450
455
  export {};
451
456
  //# sourceMappingURL=S3.d.ts.map