@terascope/file-asset-apis / s3/s3-helpers
s3/s3-helpers
Functions
abortS3Multipart()
abortS3Multipart(
client,params):Promise<void>
Defined in: s3/s3-helpers.ts:270
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | AbortMultipartUploadRequest |
Returns
Promise<void>
createS3Bucket()
createS3Bucket(
client,params):Promise<CreateBucketCommandOutput>
Defined in: s3/s3-helpers.ts:230
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | CreateBucketRequest |
Returns
Promise<CreateBucketCommandOutput>
createS3MultipartUpload()
createS3MultipartUpload(
client,Bucket,Key):Promise<string>
Defined in: s3/s3-helpers.ts:238
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
Bucket | string |
Key | string |
Returns
Promise<string>
deleteAllS3Objects()
deleteAllS3Objects(
client,params):Promise<void>
Defined in: s3/s3-helpers.ts:159
Lists objects and continues deleting until empty
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | ListObjectsV2Request |
Returns
Promise<void>
deleteS3Bucket()
deleteS3Bucket(
client,params):Promise<void>
Defined in: s3/s3-helpers.ts:184
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | DeleteBucketRequest |
Returns
Promise<void>
deleteS3Object()
deleteS3Object(
client,params):Promise<DeleteObjectCommandOutput>
Defined in: s3/s3-helpers.ts:98
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | DeleteObjectRequest |
Returns
Promise<DeleteObjectCommandOutput>
deleteS3Objects()
deleteS3Objects(
client,params):Promise<DeleteObjectsCommandOutput>
Defined in: s3/s3-helpers.ts:107
Deletes up to 10000 or MaxKeys, if you want to delete more use deleteAllS3Objects
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | DeleteObjectsRequest |
Returns
Promise<DeleteObjectsCommandOutput>
doesBucketExist()
doesBucketExist(
client,params):Promise<boolean>
Defined in: s3/s3-helpers.ts:200
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | HeadBucketRequest |
Returns
Promise<boolean>
finalizeS3Multipart()
finalizeS3Multipart(
client,params):Promise<void>
Defined in: s3/s3-helpers.ts:262
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | CompleteMultipartUploadRequest |
Returns
Promise<void>
getS3Object()
getS3Object(
client,params):Promise<GetObjectCommandOutput>
Defined in: s3/s3-helpers.ts:66
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | GetObjectRequest |
Returns
Promise<GetObjectCommandOutput>
headS3Bucket()
headS3Bucket(
client,params):Promise<void>
Defined in: s3/s3-helpers.ts:192
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | HeadBucketRequest |
Returns
Promise<void>
listS3Buckets()
listS3Buckets(
client):Promise<ListBucketsCommandOutput>
Defined in: s3/s3-helpers.ts:223
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
Returns
Promise<ListBucketsCommandOutput>
listS3Objects()
listS3Objects(
client,params):Promise<ListObjectsV2CommandOutput>
Defined in: s3/s3-helpers.ts:74
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | ListObjectsV2Request |
Returns
Promise<ListObjectsV2CommandOutput>
putS3Object()
putS3Object(
client,params):Promise<PutObjectCommandOutput>
Defined in: s3/s3-helpers.ts:82
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | PutObjectRequest |
Returns
Promise<PutObjectCommandOutput>
s3RequestWithRetry()
Call Signature
s3RequestWithRetry(
retryArgs,attempts?):Promise<GetObjectCommandOutput>
Defined in: s3/s3-helpers.ts:16
Parameters
| Parameter | Type |
|---|---|
retryArgs | GetObjectWithRetry |
attempts? | number |
Returns
Promise<GetObjectCommandOutput>
Call Signature
s3RequestWithRetry(
retryArgs,attempts?):Promise<PutObjectCommandOutput>
Defined in: s3/s3-helpers.ts:20
Parameters
| Parameter | Type |
|---|---|
retryArgs | PutObjectWithRetry |
attempts? | number |
Returns
Promise<PutObjectCommandOutput>
Call Signature
s3RequestWithRetry(
retryArgs,attempts?):Promise<DeleteObjectCommandOutput>
Defined in: s3/s3-helpers.ts:24
Parameters
| Parameter | Type |
|---|---|
retryArgs | DeleteObjectWithRetry |
attempts? | number |
Returns
Promise<DeleteObjectCommandOutput>
Call Signature
s3RequestWithRetry(
retryArgs,attempts?):Promise<ListObjectsV2CommandOutput>
Defined in: s3/s3-helpers.ts:28
Parameters
| Parameter | Type |
|---|---|
retryArgs | ListObjectsWithRetry |
attempts? | number |
Returns
Promise<ListObjectsV2CommandOutput>
tagS3Object()
tagS3Object(
client,params):Promise<PutObjectTaggingCommandOutput>
Defined in: s3/s3-helpers.ts:90
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | PutObjectTaggingRequest |
Returns
Promise<PutObjectTaggingCommandOutput>
uploadS3ObjectPart()
uploadS3ObjectPart(
client,params):Promise<CompletedPart>
Defined in: s3/s3-helpers.ts:254
Parameters
| Parameter | Type |
|---|---|
client | S3Client |
params | UploadPartRequest |
Returns
Promise<CompletedPart>
validateBucketName()
validateBucketName(
bucketName):boolean
Defined in: s3/s3-helpers.ts:283
Parameters
| Parameter | Type | Description |
|---|---|---|
bucketName | string | A bucket name to test validation against |
Returns
boolean
A bolean on whether or not a bucket name is valid