@terascope/file-asset-apis / s3/client-helpers/request-with-retry
s3/client-helpers/request-with-retry
Type Aliases
DeleteObjectWithRetry
DeleteObjectWithRetry =
object
Defined in: s3/client-helpers/request-with-retry.ts:46
Properties
client
client:
S3Client
Defined in: s3/client-helpers/request-with-retry.ts:47
func
func: (
client,params) =>Promise<DeleteObjectCommandOutput>
Defined in: s3/client-helpers/request-with-retry.ts:48
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | DeleteObjectRequest |
Returns
Promise<DeleteObjectCommandOutput>
params
params:
DeleteObjectRequest
Defined in: s3/client-helpers/request-with-retry.ts:49
DoesBucketExistWithRetry
DoesBucketExistWithRetry =
object
Defined in: s3/client-helpers/request-with-retry.ts:58
Properties
client
client:
S3Client
Defined in: s3/client-helpers/request-with-retry.ts:59
func
func: (
client,params) =>Promise<boolean>
Defined in: s3/client-helpers/request-with-retry.ts:60
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | HeadBucketRequest |
Returns
Promise<boolean>
params
params:
HeadBucketRequest
Defined in: s3/client-helpers/request-with-retry.ts:61
DoesObjectExistWithRetry
DoesObjectExistWithRetry =
object
Defined in: s3/client-helpers/request-with-retry.ts:52
Properties
client
client:
S3Client
Defined in: s3/client-helpers/request-with-retry.ts:53
func
func: (
client,params) =>Promise<boolean>
Defined in: s3/client-helpers/request-with-retry.ts:54
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | HeadObjectRequest |
Returns
Promise<boolean>
params
params:
HeadObjectRequest
Defined in: s3/client-helpers/request-with-retry.ts:55
GetObjectWithRetry
GetObjectWithRetry =
object
Defined in: s3/client-helpers/request-with-retry.ts:34
Properties
client
client:
S3Client
Defined in: s3/client-helpers/request-with-retry.ts:35
func
func: (
client,params) =>Promise<GetObjectCommandOutput>
Defined in: s3/client-helpers/request-with-retry.ts:36
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | GetObjectRequest |
Returns
Promise<GetObjectCommandOutput>
params
params:
GetObjectRequest
Defined in: s3/client-helpers/request-with-retry.ts:37
ListObjectsWithRetry
ListObjectsWithRetry =
object
Defined in: s3/client-helpers/request-with-retry.ts:28
Properties
client
client:
S3Client
Defined in: s3/client-helpers/request-with-retry.ts:29
func
func: (
client,params) =>Promise<ListObjectsV2CommandOutput>
Defined in: s3/client-helpers/request-with-retry.ts:30
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | ListObjectsV2Request |
Returns
Promise<ListObjectsV2CommandOutput>
params
params:
ListObjectsV2Request
Defined in: s3/client-helpers/request-with-retry.ts:31
PutObjectWithRetry
PutObjectWithRetry =
object
Defined in: s3/client-helpers/request-with-retry.ts:40
Properties
client
client:
S3Client
Defined in: s3/client-helpers/request-with-retry.ts:41
func
func: (
client,params) =>Promise<PutObjectCommandOutput>
Defined in: s3/client-helpers/request-with-retry.ts:42
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | PutObjectRequest |
Returns
Promise<PutObjectCommandOutput>
params
params:
PutObjectRequest
Defined in: s3/client-helpers/request-with-retry.ts:43
RetryArgs
RetryArgs =
object
Defined in: s3/client-helpers/request-with-retry.ts:22
Properties
client
client:
S3Client
Defined in: s3/client-helpers/request-with-retry.ts:23
func
func: (
client,params) =>Promise<S3RetryResponse>
Defined in: s3/client-helpers/request-with-retry.ts:24
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | any |
Returns
Promise<S3RetryResponse>
params
params:
S3RetryParams
Defined in: s3/client-helpers/request-with-retry.ts:25
S3RetryParams
S3RetryParams =
ListObjectsV2Request|GetObjectRequest|DeleteObjectRequest|PutObjectRequest|HeadObjectRequest|HeadBucketRequest
Defined in: s3/client-helpers/request-with-retry.ts:15
S3RetryResponse
S3RetryResponse =
ListObjectsV2CommandOutput|GetObjectCommandOutput|PutObjectCommandOutput|DeleteObjectCommandOutput|boolean
Defined in: s3/client-helpers/request-with-retry.ts:18