Class S3

constructor

• new S3(): S3

• Returns S3

client

copyObject

• copyObject(options): Promise<void>

• Make a copy of an object of the bucket.

  Parameters

  • options: CopyObjectOptions

  Returns Promise<void>

createDownloadURLFromData

• createDownloadURLFromData(data, options?): Promise<SignedURL>

• Create a download link of a piece of data (through S3). Practically, it uploads the file on an S3 bucket, generating and returning a url to it.

  Parameters

  • data: StreamingBlobPayloadInputTypes
  • options: CreateDownloadURLFromDataOptions = {}

  Returns Promise<SignedURL>

deleteObject

• deleteObject(options): Promise<PutObjectOutput>

• Delete an object from an S3 bucket.

  Parameters

  • options: DeleteObjectOptions

  Returns Promise<PutObjectOutput>

doesObjectExist

• doesObjectExist(options): Promise<boolean>

• Check whether an object exists in an S3 bucket.

  Parameters

  • options: HeadObjectOptions

  Returns Promise<boolean>

getObject

• getObject(options): Promise<GetObjectCommandOutput>

• Get an object from a S3 bucket.

  Parameters

  • options: GetObjectOptions

  Returns Promise<GetObjectCommandOutput>

getObjectAsJSON

• getObjectAsJSON(options): Promise<any>

• Get an object from a S3 bucket and parse the content as a JSON object.

  Parameters

  • options: GetObjectOptions

  Returns Promise<any>

getObjectAsText

• getObjectAsText(options): Promise<string>

• Get an object from a S3 bucket and convert the content to string.

  Parameters

  • options: GetObjectOptions

  Returns Promise<string>

listObjects

• listObjects(options): Promise<ListObjectsOutput>

• List the objects of an S3 bucket.

  Parameters

  • options: ListObjectsOptions

  Returns Promise<ListObjectsOutput>

listObjectsKeys

• listObjectsKeys(options): Promise<string[]>

• List the objects keys of an S3 bucket.

  Parameters

  • options: ListObjectsOptions

  Returns Promise<string[]>

putObject

• putObject(options): Promise<PutObjectOutput>

• Put an object in a S3 bucket.

  Parameters

  • options: PutObjectOptions

  Returns Promise<PutObjectOutput>

signedURLGet

• signedURLGet(bucket, key, options?): Promise<SignedURL>

• Get a signed URL to get a file on a S3 bucket.

  Parameters

  • bucket: string
  • key: string
  • options: SignedURLOptions = {}

  Returns Promise<SignedURL>

signedURLPut

• signedURLPut(bucket, key, options?): Promise<SignedURL>

• Get a signed URL to put a file on a S3 bucket.

  Parameters

  • bucket: string
  • key: string
  • options: SignedURLOptions = {}

  Returns Promise<SignedURL>