@cumulus/aws-client 21.2.0 → 21.3.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.
Files changed (2) hide show
  1. package/README.md +117 -117
  2. package/package.json +8 -8
package/README.md CHANGED
@@ -105,8 +105,8 @@ Describes a given CloudFormation stack
105
105
 
106
106
  See [CloudFormation.Stack](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CloudFormation.html#describeStacks-property)
107
107
 
108
- **Kind**: inner method of [<code>CloudFormation</code>](#module_CloudFormation)
109
- **Returns**: <code>Promise.&lt;CloudFormation.Stack&gt;</code> - The resources belonging to the stack
108
+ **Kind**: inner method of [<code>CloudFormation</code>](#module_CloudFormation)
109
+ **Returns**: <code>Promise.&lt;CloudFormation.Stack&gt;</code> - The resources belonging to the stack
110
110
 
111
111
  | Param | Type | Description |
112
112
  | --- | --- | --- |
@@ -119,8 +119,8 @@ Describes the resources belonging to a given CloudFormation stack
119
119
 
120
120
  See [CloudFormation.StackResources](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CloudFormation.html#describeStackResources-property)
121
121
 
122
- **Kind**: inner method of [<code>CloudFormation</code>](#module_CloudFormation)
123
- **Returns**: <code>Promise.&lt;CloudFormation.StackResources&gt;</code> - The resources belonging to the stack
122
+ **Kind**: inner method of [<code>CloudFormation</code>](#module_CloudFormation)
123
+ **Returns**: <code>Promise.&lt;CloudFormation.StackResources&gt;</code> - The resources belonging to the stack
124
124
 
125
125
  | Param | Type | Description |
126
126
  | --- | --- | --- |
@@ -131,8 +131,8 @@ See [CloudFormation.StackResources](https://docs.aws.amazon.com/AWSJavaScriptSDK
131
131
  ### CloudFormation~getCfStackParameterValues(stackName, parameterKeys) ⇒ <code>Promise.&lt;Object&gt;</code>
132
132
  Get parameter values for the given CloudFormation stack
133
133
 
134
- **Kind**: inner method of [<code>CloudFormation</code>](#module_CloudFormation)
135
- **Returns**: <code>Promise.&lt;Object&gt;</code> - Object keyed by parameter names
134
+ **Kind**: inner method of [<code>CloudFormation</code>](#module_CloudFormation)
135
+ **Returns**: <code>Promise.&lt;Object&gt;</code> - Object keyed by parameter names
136
136
 
137
137
  | Param | Type | Description |
138
138
  | --- | --- | --- |
@@ -147,7 +147,7 @@ Get parameter values for the given CloudFormation stack
147
147
  ### CloudwatchEvents~putEvent(name, schedule, state, [description], [role]) ⇒ <code>Promise.&lt;CloudWatchEvents.PutRuleResponse&gt;</code>
148
148
  Create a CloudWatch Events rule
149
149
 
150
- **Kind**: inner method of [<code>CloudwatchEvents</code>](#module_CloudwatchEvents)
150
+ **Kind**: inner method of [<code>CloudwatchEvents</code>](#module_CloudwatchEvents)
151
151
 
152
152
  | Param | Type | Description |
153
153
  | --- | --- | --- |
@@ -178,19 +178,19 @@ Call DynamoDb client scan
178
178
  See [DocumentClient.scan()](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_lib_dynamodb.html)
179
179
  for descriptions of `params` and the return data.
180
180
 
181
- **Kind**: static property of [<code>DynamoDb</code>](#module_DynamoDb)
181
+ **Kind**: static property of [<code>DynamoDb</code>](#module_DynamoDb)
182
182
 
183
183
  | Param | Type |
184
184
  | --- | --- |
185
- | params | <code>Object</code> |
185
+ | params | <code>Object</code> |
186
186
 
187
187
  <a name="module_DynamoDb.createAndWaitForDynamoDbTable"></a>
188
188
 
189
189
  ### DynamoDb.createAndWaitForDynamoDbTable(params) ⇒ <code>Promise.&lt;Object&gt;</code>
190
190
  Create a DynamoDB table and then wait for the table to exist
191
191
 
192
- **Kind**: static method of [<code>DynamoDb</code>](#module_DynamoDb)
193
- **Returns**: <code>Promise.&lt;Object&gt;</code> - the output of the createTable call
192
+ **Kind**: static method of [<code>DynamoDb</code>](#module_DynamoDb)
193
+ **Returns**: <code>Promise.&lt;Object&gt;</code> - the output of the createTable call
194
194
 
195
195
  | Param | Type | Description |
196
196
  | --- | --- | --- |
@@ -201,7 +201,7 @@ Create a DynamoDB table and then wait for the table to exist
201
201
  ### DynamoDb.deleteAndWaitForDynamoDbTableNotExists(params) ⇒ <code>Promise</code>
202
202
  Delete a DynamoDB table and then wait for the table to not exist
203
203
 
204
- **Kind**: static method of [<code>DynamoDb</code>](#module_DynamoDb)
204
+ **Kind**: static method of [<code>DynamoDb</code>](#module_DynamoDb)
205
205
 
206
206
  | Param | Type | Description |
207
207
  | --- | --- | --- |
@@ -215,7 +215,7 @@ Call DynamoDb client get
215
215
  See [DocumentClient.get()](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_lib_dynamodb.html)
216
216
  for descriptions of `params` and the return data.
217
217
 
218
- **Kind**: inner method of [<code>DynamoDb</code>](#module_DynamoDb)
218
+ **Kind**: inner method of [<code>DynamoDb</code>](#module_DynamoDb)
219
219
  **Throws**:
220
220
 
221
221
  - <code>RecordDoesNotExist</code> if a record cannot be found
@@ -237,7 +237,7 @@ Do a parallel scan of DynamoDB table using a document client.
237
237
  See https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan.
238
238
  See [DocumentClient.scan()](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_lib_dynamodb.html).
239
239
 
240
- **Kind**: inner method of [<code>DynamoDb</code>](#module_DynamoDb)
240
+ **Kind**: inner method of [<code>DynamoDb</code>](#module_DynamoDb)
241
241
 
242
242
  | Param | Type | Description |
243
243
  | --- | --- | --- |
@@ -256,8 +256,8 @@ See [DocumentClient.scan()](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/late
256
256
  ### Kinesis~describeStream(params, retryOptions) ⇒ <code>Promise.&lt;Object&gt;</code>
257
257
  Describe a Kinesis stream.
258
258
 
259
- **Kind**: inner method of [<code>Kinesis</code>](#module_Kinesis)
260
- **Returns**: <code>Promise.&lt;Object&gt;</code> - The stream description response
259
+ **Kind**: inner method of [<code>Kinesis</code>](#module_Kinesis)
260
+ **Returns**: <code>Promise.&lt;Object&gt;</code> - The stream description response
261
261
 
262
262
  | Param | Type | Description |
263
263
  | --- | --- | --- |
@@ -278,13 +278,13 @@ Describe a Kinesis stream.
278
278
  ### Lambda~isEventBridgeEvent()
279
279
  Bare check for EventBridge shape
280
280
 
281
- **Kind**: inner method of [<code>Lambda</code>](#module_Lambda)
281
+ **Kind**: inner method of [<code>Lambda</code>](#module_Lambda)
282
282
  <a name="module_Lambda..invoke"></a>
283
283
 
284
284
  ### Lambda~invoke()
285
285
  Invoke a Lambda function
286
286
 
287
- **Kind**: inner method of [<code>Lambda</code>](#module_Lambda)
287
+ **Kind**: inner method of [<code>Lambda</code>](#module_Lambda)
288
288
  <a name="module_S3"></a>
289
289
 
290
290
  ## S3
@@ -340,14 +340,14 @@ Invoke a Lambda function
340
340
 
341
341
  Gets an object from S3.
342
342
 
343
- **Kind**: static property of [<code>S3</code>](#module_S3)
343
+ **Kind**: static property of [<code>S3</code>](#module_S3)
344
344
  <a name="module_S3.recursivelyDeleteS3Bucket"></a>
345
345
 
346
346
  ### S3.recursivelyDeleteS3Bucket ⇒
347
347
  Delete a bucket and all of its objects from S3
348
348
 
349
- **Kind**: static property of [<code>S3</code>](#module_S3)
350
- **Returns**: the promised result of `S3.deleteBucket`
349
+ **Kind**: static property of [<code>S3</code>](#module_S3)
350
+ **Returns**: the promised result of `S3.deleteBucket`
351
351
 
352
352
  | Param | Description |
353
353
  | --- | --- |
@@ -365,9 +365,9 @@ The passed params must be compatible with the listObjectsV2 call.
365
365
 
366
366
  https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#listObjectsV2-property
367
367
 
368
- **Kind**: static method of [<code>S3</code>](#module_S3)
368
+ **Kind**: static method of [<code>S3</code>](#module_S3)
369
369
  **Returns**: <code>Promise.&lt;Array&gt;</code> - resolves to an array of objects corresponding to
370
- the Contents property of the listObjectsV2 response
370
+ the Contents property of the listObjectsV2 response
371
371
 
372
372
  | Param | Type | Description |
373
373
  | --- | --- | --- |
@@ -385,7 +385,7 @@ The passed params must be compatible with the listObjectsV2 call.
385
385
 
386
386
  https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#listObjectsV2-property
387
387
 
388
- **Kind**: static method of [<code>S3</code>](#module_S3)
388
+ **Kind**: static method of [<code>S3</code>](#module_S3)
389
389
 
390
390
  | Param | Description |
391
391
  | --- | --- |
@@ -396,8 +396,8 @@ https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#listObjectsV2-pr
396
396
  ### S3~s3Join(...args) ⇒ <code>string</code>
397
397
  Join strings into an S3 key without a leading slash
398
398
 
399
- **Kind**: inner method of [<code>S3</code>](#module_S3)
400
- **Returns**: <code>string</code> - the full S3 key
399
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
400
+ **Returns**: <code>string</code> - the full S3 key
401
401
 
402
402
  | Param | Type | Description |
403
403
  | --- | --- | --- |
@@ -408,8 +408,8 @@ Join strings into an S3 key without a leading slash
408
408
  ### S3~parseS3Uri(uri) ⇒ <code>Object</code>
409
409
  parse an s3 uri to get the bucket and key
410
410
 
411
- **Kind**: inner method of [<code>S3</code>](#module_S3)
412
- **Returns**: <code>Object</code> - Returns an object with `Bucket` and `Key` properties
411
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
412
+ **Returns**: <code>Object</code> - Returns an object with `Bucket` and `Key` properties
413
413
 
414
414
  | Param | Type | Description |
415
415
  | --- | --- | --- |
@@ -420,8 +420,8 @@ parse an s3 uri to get the bucket and key
420
420
  ### S3~buildS3Uri(bucket, key) ⇒ <code>string</code>
421
421
  Given a bucket and key, return an S3 URI
422
422
 
423
- **Kind**: inner method of [<code>S3</code>](#module_S3)
424
- **Returns**: <code>string</code> - an S3 URI
423
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
424
+ **Returns**: <code>string</code> - an S3 URI
425
425
 
426
426
  | Param | Type | Description |
427
427
  | --- | --- | --- |
@@ -434,8 +434,8 @@ Given a bucket and key, return an S3 URI
434
434
  Convert S3 TagSet Object to query string
435
435
  e.g. [{ Key: 'tag', Value: 'value }] to 'tag=value'
436
436
 
437
- **Kind**: inner method of [<code>S3</code>](#module_S3)
438
- **Returns**: <code>string</code> - tags query string
437
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
438
+ **Returns**: <code>string</code> - tags query string
439
439
 
440
440
  | Param | Type | Description |
441
441
  | --- | --- | --- |
@@ -446,8 +446,8 @@ e.g. [{ Key: 'tag', Value: 'value }] to 'tag=value'
446
446
  ### S3~deleteS3Object(bucket, key) ⇒ <code>Promise</code>
447
447
  Delete an object from S3
448
448
 
449
- **Kind**: inner method of [<code>S3</code>](#module_S3)
450
- **Returns**: <code>Promise</code> - promise of the object being deleted
449
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
450
+ **Returns**: <code>Promise</code> - promise of the object being deleted
451
451
 
452
452
  | Param | Type | Description |
453
453
  | --- | --- | --- |
@@ -459,8 +459,8 @@ Delete an object from S3
459
459
  ### S3~headObject(Bucket, Key, retryOptions) ⇒
460
460
  Get an object header from S3
461
461
 
462
- **Kind**: inner method of [<code>S3</code>](#module_S3)
463
- **Returns**: returns response from `S3.headObject` as a promise
462
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
463
+ **Returns**: returns response from `S3.headObject` as a promise
464
464
 
465
465
  | Param | Description |
466
466
  | --- | --- |
@@ -473,9 +473,9 @@ Get an object header from S3
473
473
  ### S3~s3ObjectExists(params) ⇒ <code>Promise.&lt;boolean&gt;</code>
474
474
  Test if an object exists in S3
475
475
 
476
- **Kind**: inner method of [<code>S3</code>](#module_S3)
476
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
477
477
  **Returns**: <code>Promise.&lt;boolean&gt;</code> - a Promise that will resolve to a boolean indicating
478
- if the object exists
478
+ if the object exists
479
479
 
480
480
  | Param | Description |
481
481
  | --- | --- |
@@ -490,8 +490,8 @@ This function uses `p-wait-for` to repeatedly check for the object's existence
490
490
  until it's found or a timeout is reached. It provides configurable `interval`
491
491
  between checks and a total `timeout` duration.
492
492
 
493
- **Kind**: inner method of [<code>S3</code>](#module_S3)
494
- **Returns**: A Promise that resolves when the S3 object is found.
493
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
494
+ **Returns**: A Promise that resolves when the S3 object is found.
495
495
  **Throws**:
496
496
 
497
497
  - <code>TimeoutError</code> If the object does not exist within the specified `timeout` period.
@@ -511,7 +511,7 @@ between checks and a total `timeout` duration.
511
511
  ### S3~s3PutObject(params)
512
512
  Put an object on S3
513
513
 
514
- **Kind**: inner method of [<code>S3</code>](#module_S3)
514
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
515
515
 
516
516
  | Param | Description |
517
517
  | --- | --- |
@@ -522,13 +522,13 @@ Put an object on S3
522
522
  ### S3~putFile()
523
523
  Upload a file to S3
524
524
 
525
- **Kind**: inner method of [<code>S3</code>](#module_S3)
525
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
526
526
  <a name="module_S3..s3CopyObject"></a>
527
527
 
528
528
  ### S3~s3CopyObject()
529
529
  Copy an object from one location on S3 to another
530
530
 
531
- **Kind**: inner method of [<code>S3</code>](#module_S3)
531
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
532
532
  <a name="module_S3..promiseS3Upload"></a>
533
533
 
534
534
  ### S3~promiseS3Upload()
@@ -536,87 +536,87 @@ Upload data to S3
536
536
 
537
537
  see https://github.com/aws/aws-sdk-js-v3/tree/main/lib/lib-storage
538
538
 
539
- **Kind**: inner method of [<code>S3</code>](#module_S3)
539
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
540
540
  <a name="module_S3..streamS3Upload"></a>
541
541
 
542
542
  ### S3~streamS3Upload()
543
543
  Upload data to S3 using a stream
544
544
 
545
- **Kind**: inner method of [<code>S3</code>](#module_S3)
545
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
546
546
  <a name="module_S3..getObjectReadStream"></a>
547
547
 
548
548
  ### S3~getObjectReadStream()
549
549
  Get a readable stream for an S3 object
550
550
 
551
- **Kind**: inner method of [<code>S3</code>](#module_S3)
551
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
552
552
  <a name="module_S3..downloadS3File"></a>
553
553
 
554
554
  ### S3~downloadS3File()
555
555
  Downloads the given s3Obj to the given filename in a streaming manner
556
556
 
557
- **Kind**: inner method of [<code>S3</code>](#module_S3)
557
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
558
558
  <a name="module_S3..getObjectSize"></a>
559
559
 
560
560
  ### S3~getObjectSize()
561
561
  Get the size of an S3 object
562
562
 
563
- **Kind**: inner method of [<code>S3</code>](#module_S3)
563
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
564
564
  <a name="module_S3..s3GetObjectTagging"></a>
565
565
 
566
566
  ### S3~s3GetObjectTagging()
567
567
  Get object Tagging from S3
568
568
 
569
- **Kind**: inner method of [<code>S3</code>](#module_S3)
569
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
570
570
  <a name="module_S3..s3PutObjectTagging"></a>
571
571
 
572
572
  ### S3~s3PutObjectTagging()
573
573
  Puts object Tagging in S3
574
574
  https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#putObjectTagging-property
575
575
 
576
- **Kind**: inner method of [<code>S3</code>](#module_S3)
576
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
577
577
  <a name="module_S3..getObject"></a>
578
578
 
579
579
  ### S3~getObject()
580
580
  Gets an object from S3.
581
581
 
582
- **Kind**: inner method of [<code>S3</code>](#module_S3)
582
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
583
583
  <a name="module_S3..waitForObject"></a>
584
584
 
585
585
  ### S3~waitForObject()
586
586
  Get an object from S3, waiting for it to exist and, if specified, have the
587
587
  correct ETag.
588
588
 
589
- **Kind**: inner method of [<code>S3</code>](#module_S3)
589
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
590
590
  <a name="module_S3..getObjectStreamContents"></a>
591
591
 
592
592
  ### S3~getObjectStreamContents()
593
593
  Transform streaming response from S3 object to text content
594
594
 
595
- **Kind**: inner method of [<code>S3</code>](#module_S3)
595
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
596
596
  <a name="module_S3..getTextObject"></a>
597
597
 
598
598
  ### S3~getTextObject()
599
599
  Fetch the contents of an S3 object
600
600
 
601
- **Kind**: inner method of [<code>S3</code>](#module_S3)
601
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
602
602
  <a name="module_S3..getJsonS3Object"></a>
603
603
 
604
604
  ### S3~getJsonS3Object()
605
605
  Fetch JSON stored in an S3 object
606
606
 
607
- **Kind**: inner method of [<code>S3</code>](#module_S3)
607
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
608
608
  <a name="module_S3..fileExists"></a>
609
609
 
610
610
  ### S3~fileExists()
611
611
  Check if a file exists in an S3 object
612
612
 
613
- **Kind**: inner method of [<code>S3</code>](#module_S3)
613
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
614
614
  <a name="module_S3..deleteS3Files"></a>
615
615
 
616
616
  ### S3~deleteS3Files(s3Objs)
617
617
  Delete files from S3
618
618
 
619
- **Kind**: inner method of [<code>S3</code>](#module_S3)
619
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
620
620
 
621
621
  | Param | Description |
622
622
  | --- | --- |
@@ -627,8 +627,8 @@ Delete files from S3
627
627
  ### S3~uploadS3FileStream(fileStream, bucket, key, s3opts) ⇒ <code>Promise</code>
628
628
  Upload the file associated with the given stream to an S3 bucket
629
629
 
630
- **Kind**: inner method of [<code>S3</code>](#module_S3)
631
- **Returns**: <code>Promise</code> - A promise
630
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
631
+ **Returns**: <code>Promise</code> - A promise
632
632
 
633
633
  | Param | Type | Description |
634
634
  | --- | --- | --- |
@@ -642,14 +642,14 @@ Upload the file associated with the given stream to an S3 bucket
642
642
  ### S3~listS3Objects()
643
643
  List the objects in an S3 bucket
644
644
 
645
- **Kind**: inner method of [<code>S3</code>](#module_S3)
645
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
646
646
  <a name="module_S3..deleteS3Buckets"></a>
647
647
 
648
648
  ### S3~deleteS3Buckets(buckets) ⇒ <code>Promise</code>
649
649
  Delete a list of buckets and all of their objects from S3
650
650
 
651
- **Kind**: inner method of [<code>S3</code>](#module_S3)
652
- **Returns**: <code>Promise</code> - the promised result of `S3.deleteBucket`
651
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
652
+ **Returns**: <code>Promise</code> - the promised result of `S3.deleteBucket`
653
653
 
654
654
  | Param | Type | Description |
655
655
  | --- | --- | --- |
@@ -660,7 +660,7 @@ Delete a list of buckets and all of their objects from S3
660
660
  ### S3~calculateObjectHash(params)
661
661
  Calculate the cryptographic hash of an S3 object
662
662
 
663
- **Kind**: inner method of [<code>S3</code>](#module_S3)
663
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
664
664
 
665
665
  | Param | Type | Description |
666
666
  | --- | --- | --- |
@@ -675,8 +675,8 @@ Calculate the cryptographic hash of an S3 object
675
675
  ### S3~validateS3ObjectChecksum(params) ⇒ <code>Promise.&lt;boolean&gt;</code>
676
676
  Validate S3 object checksum against expected sum
677
677
 
678
- **Kind**: inner method of [<code>S3</code>](#module_S3)
679
- **Returns**: <code>Promise.&lt;boolean&gt;</code> - returns true for success
678
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
679
+ **Returns**: <code>Promise.&lt;boolean&gt;</code> - returns true for success
680
680
  **Throws**:
681
681
 
682
682
  - <code>InvalidChecksum</code> - Throws error if validation fails
@@ -696,8 +696,8 @@ Validate S3 object checksum against expected sum
696
696
  ### S3~getFileBucketAndKey(pathParams) ⇒ <code>Array.&lt;string&gt;</code>
697
697
  Extract the S3 bucket and key from the URL path parameters
698
698
 
699
- **Kind**: inner method of [<code>S3</code>](#module_S3)
700
- **Returns**: <code>Array.&lt;string&gt;</code> - `[Bucket, Key]`
699
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
700
+ **Returns**: <code>Array.&lt;string&gt;</code> - `[Bucket, Key]`
701
701
 
702
702
  | Param | Type | Description |
703
703
  | --- | --- | --- |
@@ -708,7 +708,7 @@ Extract the S3 bucket and key from the URL path parameters
708
708
  ### S3~createBucket(Bucket) ⇒ <code>Promise</code>
709
709
  Create an S3 bucket
710
710
 
711
- **Kind**: inner method of [<code>S3</code>](#module_S3)
711
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
712
712
 
713
713
  | Param | Type | Description |
714
714
  | --- | --- | --- |
@@ -719,7 +719,7 @@ Create an S3 bucket
719
719
  ### S3~createS3Buckets(buckets) ⇒ <code>Promise</code>
720
720
  Create multiple S3 buckets
721
721
 
722
- **Kind**: inner method of [<code>S3</code>](#module_S3)
722
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
723
723
 
724
724
  | Param | Type | Description |
725
725
  | --- | --- | --- |
@@ -730,11 +730,11 @@ Create multiple S3 buckets
730
730
  ### S3~multipartCopyObject(params) ⇒ <code>Promise.&lt;{etag: string}&gt;</code>
731
731
  Copy an S3 object to another location in S3 using a multipart copy
732
732
 
733
- **Kind**: inner method of [<code>S3</code>](#module_S3)
733
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
734
734
  **Returns**: <code>Promise.&lt;{etag: string}&gt;</code> - object containing the ETag of the
735
735
  destination object
736
736
 
737
- note: this method may error if used with zero byte files. see CUMULUS-2557 and https://github.com/nasa/cumulus/pull/2117.
737
+ note: this method may error if used with zero byte files. see CUMULUS-2557 and https://github.com/nasa/cumulus/pull/2117.
738
738
 
739
739
  | Param | Type | Default | Description |
740
740
  | --- | --- | --- | --- |
@@ -753,7 +753,7 @@ note: this method may error if used with zero byte files. see CUMULUS-2557 and h
753
753
  ### S3~copyObject()
754
754
  Copy an S3 object to another location in S3
755
755
 
756
- **Kind**: inner method of [<code>S3</code>](#module_S3)
756
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
757
757
 
758
758
  | Param | Default | Description |
759
759
  | --- | --- | --- |
@@ -766,7 +766,7 @@ Copy an S3 object to another location in S3
766
766
  ### S3~moveObject() ⇒ <code>Promise.&lt;undefined&gt;</code>
767
767
  Move an S3 object to another location in S3
768
768
 
769
- **Kind**: inner method of [<code>S3</code>](#module_S3)
769
+ **Kind**: inner method of [<code>S3</code>](#module_S3)
770
770
 
771
771
  | Param | Type | Default | Description |
772
772
  | --- | --- | --- | --- |
@@ -791,7 +791,7 @@ Move an S3 object to another location in S3
791
791
  Publish a message to an SNS topic. Does not catch
792
792
  errors, to allow more specific handling by the caller.
793
793
 
794
- **Kind**: inner method of [<code>SNS</code>](#module_SNS)
794
+ **Kind**: inner method of [<code>SNS</code>](#module_SNS)
795
795
 
796
796
  | Param | Description |
797
797
  | --- | --- |
@@ -804,8 +804,8 @@ errors, to allow more specific handling by the caller.
804
804
  ### SNS~createSnsTopic(snsTopicName) ⇒
805
805
  Create an SNS topic with a given name.
806
806
 
807
- **Kind**: inner method of [<code>SNS</code>](#module_SNS)
808
- **Returns**: - ARN of the created SNS topic
807
+ **Kind**: inner method of [<code>SNS</code>](#module_SNS)
808
+ **Returns**: - ARN of the created SNS topic
809
809
 
810
810
  | Param | Description |
811
811
  | --- | --- |
@@ -829,44 +829,44 @@ Create an SNS topic with a given name.
829
829
  ### SQS~createQueue()
830
830
  Create an SQS Queue. Properly handles localstack queue URLs
831
831
 
832
- **Kind**: inner method of [<code>SQS</code>](#module_SQS)
832
+ **Kind**: inner method of [<code>SQS</code>](#module_SQS)
833
833
  <a name="module_SQS..sendSQSMessage"></a>
834
834
 
835
835
  ### SQS~sendSQSMessage()
836
836
  Send a message to AWS SQS
837
837
 
838
- **Kind**: inner method of [<code>SQS</code>](#module_SQS)
838
+ **Kind**: inner method of [<code>SQS</code>](#module_SQS)
839
839
  <a name="module_SQS..receiveSQSMessages"></a>
840
840
 
841
841
  ### SQS~receiveSQSMessages()
842
842
  Receives SQS messages from a given queue. The number of messages received
843
843
  can be set and the timeout is also adjustable.
844
844
 
845
- **Kind**: inner method of [<code>SQS</code>](#module_SQS)
845
+ **Kind**: inner method of [<code>SQS</code>](#module_SQS)
846
846
  <a name="module_SQS..isSQSRecordLike"></a>
847
847
 
848
848
  ### SQS~isSQSRecordLike()
849
849
  Bare check for SQS message Shape
850
850
 
851
- **Kind**: inner method of [<code>SQS</code>](#module_SQS)
851
+ **Kind**: inner method of [<code>SQS</code>](#module_SQS)
852
852
  <a name="module_SQS..parseSQSMessageBody"></a>
853
853
 
854
854
  ### SQS~parseSQSMessageBody()
855
855
  Extract SQS message body
856
856
 
857
- **Kind**: inner method of [<code>SQS</code>](#module_SQS)
857
+ **Kind**: inner method of [<code>SQS</code>](#module_SQS)
858
858
  <a name="module_SQS..deleteSQSMessage"></a>
859
859
 
860
860
  ### SQS~deleteSQSMessage()
861
861
  Delete a given SQS message from a given queue.
862
862
 
863
- **Kind**: inner method of [<code>SQS</code>](#module_SQS)
863
+ **Kind**: inner method of [<code>SQS</code>](#module_SQS)
864
864
  <a name="module_SQS..sqsQueueExists"></a>
865
865
 
866
866
  ### SQS~sqsQueueExists()
867
867
  Test if an SQS queue exists
868
868
 
869
- **Kind**: inner method of [<code>SQS</code>](#module_SQS)
869
+ **Kind**: inner method of [<code>SQS</code>](#module_SQS)
870
870
  <a name="module_StepFunctions"></a>
871
871
 
872
872
  ## StepFunctions
@@ -891,11 +891,11 @@ for descriptions of `params` and the return data.
891
891
  If a ThrottlingException is received, this function will retry using an
892
892
  exponential backoff.
893
893
 
894
- **Kind**: static method of [<code>StepFunctions</code>](#module_StepFunctions)
894
+ **Kind**: static method of [<code>StepFunctions</code>](#module_StepFunctions)
895
895
 
896
896
  | Param | Type |
897
897
  | --- | --- |
898
- | params | <code>DescribeExecutionInput</code> |
898
+ | params | <code>DescribeExecutionInput</code> |
899
899
 
900
900
  <a name="module_StepFunctions.describeStateMachine"></a>
901
901
 
@@ -908,11 +908,11 @@ for descriptions of `params` and the return data.
908
908
  If a ThrottlingException is received, this function will retry using an
909
909
  exponential backoff.
910
910
 
911
- **Kind**: static method of [<code>StepFunctions</code>](#module_StepFunctions)
911
+ **Kind**: static method of [<code>StepFunctions</code>](#module_StepFunctions)
912
912
 
913
913
  | Param | Type |
914
914
  | --- | --- |
915
- | params | <code>DescribeStateMachineInput</code> |
915
+ | params | <code>DescribeStateMachineInput</code> |
916
916
 
917
917
  <a name="module_StepFunctions.getExecutionHistory"></a>
918
918
 
@@ -925,11 +925,11 @@ for descriptions of `params` and the return data.
925
925
  If a ThrottlingException is received, this function will retry using an
926
926
  exponential backoff.
927
927
 
928
- **Kind**: static method of [<code>StepFunctions</code>](#module_StepFunctions)
928
+ **Kind**: static method of [<code>StepFunctions</code>](#module_StepFunctions)
929
929
 
930
930
  | Param | Type |
931
931
  | --- | --- |
932
- | params | <code>GetExecutionHistoryInput</code> |
932
+ | params | <code>GetExecutionHistoryInput</code> |
933
933
 
934
934
  <a name="module_StepFunctions.listExecutions"></a>
935
935
 
@@ -942,11 +942,11 @@ for descriptions of `params` and the return data.
942
942
  If a ThrottlingException is received, this function will retry using an
943
943
  exponential backoff.
944
944
 
945
- **Kind**: static method of [<code>StepFunctions</code>](#module_StepFunctions)
945
+ **Kind**: static method of [<code>StepFunctions</code>](#module_StepFunctions)
946
946
 
947
947
  | Param | Type |
948
948
  | --- | --- |
949
- | params | <code>Object</code> |
949
+ | params | <code>Object</code> |
950
950
 
951
951
  <a name="module_StepFunctions..executionExists"></a>
952
952
 
@@ -956,7 +956,7 @@ Check if a Step Function Execution exists
956
956
  If a ThrottlingException is received, this function will retry using an
957
957
  exponential backoff.
958
958
 
959
- **Kind**: inner method of [<code>StepFunctions</code>](#module_StepFunctions)
959
+ **Kind**: inner method of [<code>StepFunctions</code>](#module_StepFunctions)
960
960
 
961
961
  | Param | Type | Description |
962
962
  | --- | --- | --- |
@@ -971,7 +971,7 @@ exponential backoff.
971
971
  Class to efficiently search all of the items in a DynamoDB table, without loading them all into
972
972
  memory at once. Handles paging.
973
973
 
974
- **Kind**: global class
974
+ **Kind**: global class
975
975
 
976
976
  * [DynamoDbSearchQueue](#DynamoDbSearchQueue)
977
977
  * [.empty()](#DynamoDbSearchQueue+empty) ⇒ <code>Promise.&lt;Array&gt;</code>
@@ -984,8 +984,8 @@ memory at once. Handles paging.
984
984
  Drain all values from the searchQueue, and return to the user.
985
985
  Warning: This can be very memory intensive.
986
986
 
987
- **Kind**: instance method of [<code>DynamoDbSearchQueue</code>](#DynamoDbSearchQueue)
988
- **Returns**: <code>Promise.&lt;Array&gt;</code> - array of search results.
987
+ **Kind**: instance method of [<code>DynamoDbSearchQueue</code>](#DynamoDbSearchQueue)
988
+ **Returns**: <code>Promise.&lt;Array&gt;</code> - array of search results.
989
989
  <a name="DynamoDbSearchQueue+peek"></a>
990
990
 
991
991
  ### dynamoDbSearchQueue.peek() ⇒ <code>Promise.&lt;Object&gt;</code>
@@ -994,8 +994,8 @@ View the next item in the queue
994
994
  This does not remove the object from the queue. When there are no more
995
995
  items in the queue, returns 'null'.
996
996
 
997
- **Kind**: instance method of [<code>DynamoDbSearchQueue</code>](#DynamoDbSearchQueue)
998
- **Returns**: <code>Promise.&lt;Object&gt;</code> - an item from the DynamoDB table
997
+ **Kind**: instance method of [<code>DynamoDbSearchQueue</code>](#DynamoDbSearchQueue)
998
+ **Returns**: <code>Promise.&lt;Object&gt;</code> - an item from the DynamoDB table
999
999
  <a name="DynamoDbSearchQueue+shift"></a>
1000
1000
 
1001
1001
  ### dynamoDbSearchQueue.shift() ⇒ <code>Promise.&lt;Object&gt;</code>
@@ -1003,15 +1003,15 @@ Remove the next item from the queue
1003
1003
 
1004
1004
  When there are no more items in the queue, returns 'null'.
1005
1005
 
1006
- **Kind**: instance method of [<code>DynamoDbSearchQueue</code>](#DynamoDbSearchQueue)
1007
- **Returns**: <code>Promise.&lt;Object&gt;</code> - an item from the DynamoDB table
1006
+ **Kind**: instance method of [<code>DynamoDbSearchQueue</code>](#DynamoDbSearchQueue)
1007
+ **Returns**: <code>Promise.&lt;Object&gt;</code> - an item from the DynamoDB table
1008
1008
  <a name="S3ListObjectsV2Queue"></a>
1009
1009
 
1010
1010
  ## S3ListObjectsV2Queue
1011
1011
  Class to efficiently list all of the objects in an S3 bucket, without loading
1012
1012
  them all into memory at once. Handles paging of listS3ObjectsV2 requests.
1013
1013
 
1014
- **Kind**: global class
1014
+ **Kind**: global class
1015
1015
 
1016
1016
  * [S3ListObjectsV2Queue](#S3ListObjectsV2Queue)
1017
1017
  * [.peek()](#S3ListObjectsV2Queue+peek) ⇒ <code>Promise.&lt;Object&gt;</code>
@@ -1025,8 +1025,8 @@ View the next item in the queue
1025
1025
  This does not remove the object from the queue. When there are no more
1026
1026
  items in the queue, returns 'null'.
1027
1027
 
1028
- **Kind**: instance method of [<code>S3ListObjectsV2Queue</code>](#S3ListObjectsV2Queue)
1029
- **Returns**: <code>Promise.&lt;Object&gt;</code> - an S3 object description
1028
+ **Kind**: instance method of [<code>S3ListObjectsV2Queue</code>](#S3ListObjectsV2Queue)
1029
+ **Returns**: <code>Promise.&lt;Object&gt;</code> - an S3 object description
1030
1030
  <a name="S3ListObjectsV2Queue+shift"></a>
1031
1031
 
1032
1032
  ### s3ListObjectsV2Queue.shift() ⇒ <code>Promise.&lt;Object&gt;</code>
@@ -1034,14 +1034,14 @@ Remove the next item from the queue
1034
1034
 
1035
1035
  When there are no more items in the queue, returns 'null'.
1036
1036
 
1037
- **Kind**: instance method of [<code>S3ListObjectsV2Queue</code>](#S3ListObjectsV2Queue)
1038
- **Returns**: <code>Promise.&lt;Object&gt;</code> - an S3 object description
1037
+ **Kind**: instance method of [<code>S3ListObjectsV2Queue</code>](#S3ListObjectsV2Queue)
1038
+ **Returns**: <code>Promise.&lt;Object&gt;</code> - an S3 object description
1039
1039
  <a name="S3ObjectStore"></a>
1040
1040
 
1041
1041
  ## S3ObjectStore
1042
1042
  Class to use when interacting with S3
1043
1043
 
1044
- **Kind**: global class
1044
+ **Kind**: global class
1045
1045
 
1046
1046
  * [S3ObjectStore](#S3ObjectStore)
1047
1047
  * [.signGetObject(objectUrl, [options], [queryParams], presignOptions)](#S3ObjectStore+signGetObject) ⇒ <code>Promise.&lt;string&gt;</code>
@@ -1053,8 +1053,8 @@ Class to use when interacting with S3
1053
1053
  Returns an HTTPS URL that can be used to perform a GET on the given object
1054
1054
  store URL
1055
1055
 
1056
- **Kind**: instance method of [<code>S3ObjectStore</code>](#S3ObjectStore)
1057
- **Returns**: <code>Promise.&lt;string&gt;</code> - a signed URL
1056
+ **Kind**: instance method of [<code>S3ObjectStore</code>](#S3ObjectStore)
1057
+ **Returns**: <code>Promise.&lt;string&gt;</code> - a signed URL
1058
1058
  **Throws**:
1059
1059
 
1060
1060
  - TypeError - if the URL is not a recognized protocol or cannot be parsed
@@ -1073,8 +1073,8 @@ store URL
1073
1073
  Returns an HTTPS URL that can be used to perform a HEAD on the given object
1074
1074
  store URL
1075
1075
 
1076
- **Kind**: instance method of [<code>S3ObjectStore</code>](#S3ObjectStore)
1077
- **Returns**: <code>Promise.&lt;string&gt;</code> - a signed URL
1076
+ **Kind**: instance method of [<code>S3ObjectStore</code>](#S3ObjectStore)
1077
+ **Returns**: <code>Promise.&lt;string&gt;</code> - a signed URL
1078
1078
  **Throws**:
1079
1079
 
1080
1080
  - TypeError - if the URL is not a recognized protocol or cannot be parsed
@@ -1095,19 +1095,19 @@ Create a KMS key
1095
1095
  See https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/KMS.html#createKey-property
1096
1096
  for allowed params and return value.
1097
1097
 
1098
- **Kind**: global function
1098
+ **Kind**: global function
1099
1099
 
1100
1100
  | Param | Type |
1101
1101
  | --- | --- |
1102
- | params | <code>Object</code> |
1102
+ | params | <code>Object</code> |
1103
1103
 
1104
1104
  <a name="encrypt"></a>
1105
1105
 
1106
1106
  ## encrypt(KeyId, Plaintext) ⇒ <code>Promise.&lt;string&gt;</code>
1107
1107
  Encrypt a string using KMS
1108
1108
 
1109
- **Kind**: global function
1110
- **Returns**: <code>Promise.&lt;string&gt;</code> - the Base 64 encoding of the encrypted value
1109
+ **Kind**: global function
1110
+ **Returns**: <code>Promise.&lt;string&gt;</code> - the Base 64 encoding of the encrypted value
1111
1111
 
1112
1112
  | Param | Type | Description |
1113
1113
  | --- | --- | --- |
@@ -1119,8 +1119,8 @@ Encrypt a string using KMS
1119
1119
  ## decryptBase64String(ciphertext) ⇒ <code>string</code>
1120
1120
  Decrypt a KMS-encrypted string, Base 64 encoded
1121
1121
 
1122
- **Kind**: global function
1123
- **Returns**: <code>string</code> - the plaintext
1122
+ **Kind**: global function
1123
+ **Returns**: <code>string</code> - the plaintext
1124
1124
 
1125
1125
  | Param | Type | Description |
1126
1126
  | --- | --- | --- |
@@ -1132,8 +1132,8 @@ Decrypt a KMS-encrypted string, Base 64 encoded
1132
1132
  Introduces random jitter delay to stagger concurrent S3 operations.
1133
1133
  This helps prevent AWS S3 SlowDown errors when many operations occur simultaneously.
1134
1134
 
1135
- **Kind**: global function
1136
- **Returns**: A Promise that resolves after the random delay
1135
+ **Kind**: global function
1136
+ **Returns**: A Promise that resolves after the random delay
1137
1137
 
1138
1138
  | Param | Description |
1139
1139
  | --- | --- |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cumulus/aws-client",
3
- "version": "21.2.0",
3
+ "version": "21.3.0",
4
4
  "description": "Utilities for working with AWS",
5
5
  "keywords": [
6
6
  "GIBS",
@@ -8,7 +8,7 @@
8
8
  "NASA"
9
9
  ],
10
10
  "engines": {
11
- "node": ">=20.12.2"
11
+ "node": ">=22.21.1"
12
12
  },
13
13
  "files": [
14
14
  "*.js",
@@ -69,10 +69,10 @@
69
69
  "@aws-sdk/s3-request-presigner": "^3.621.0",
70
70
  "@aws-sdk/signature-v4-crt": "^3.621.0",
71
71
  "@aws-sdk/types": "^3.609.0",
72
- "@cumulus/checksum": "21.2.0",
73
- "@cumulus/errors": "21.2.0",
74
- "@cumulus/logger": "21.2.0",
75
- "@cumulus/types": "21.2.0",
72
+ "@cumulus/checksum": "21.3.0",
73
+ "@cumulus/errors": "21.3.0",
74
+ "@cumulus/logger": "21.3.0",
75
+ "@cumulus/types": "21.3.0",
76
76
  "lodash": "~4.17.21",
77
77
  "mem": "^8.0.2",
78
78
  "p-map": "^1.2.0",
@@ -83,8 +83,8 @@
83
83
  "uuid": "^8.2.0"
84
84
  },
85
85
  "devDependencies": {
86
- "@cumulus/test-data": "21.2.0",
86
+ "@cumulus/test-data": "21.3.0",
87
87
  "@types/uuid": "^8.0.0"
88
88
  },
89
- "gitHead": "696befd260527f74a8a5bfb92f9511b455a23388"
89
+ "gitHead": "9dd4a7d4b888ea713efa87d6086a762262d46dd2"
90
90
  }