API Reference
copy
Parameters
Option | Required | Type | Description |
---|---|---|---|
input | true | The CopyWithPathInput object. |
Throws
service:
S3Exception
- Thrown when checking for existence of the objectvalidation:
StorageValidationErrorCode
- Thrown when source or destination path is not defined.
copy
Parameters
Option | Required | Type | Description |
---|---|---|---|
input | true | The CopyInput object. |
Throws
service:
S3Exception
- Thrown when checking for existence of the objectvalidation:
StorageValidationErrorCode
- Thrown when source or destination key is not defined.
downloadData
Parameters
Option | Required | Type | Description |
---|---|---|---|
input | true | The DownloadDataWithPathInput object. |
Throws
service:
S3Exception
- thrown when checking for existence of the objectvalidation:
StorageValidationErrorCode
- Validation errors
downloadData
Parameters
Option | Required | Type | Description |
---|---|---|---|
input | true | The DownloadDataInput object. |
Throws
service:
S3Exception
- thrown when checking for existence of the objectvalidation:
StorageValidationErrorCode
- Validation errors
getProperties
Parameters
Option | Required | Type | Description |
---|---|---|---|
input | true | The GetPropertiesWithPathInput object. |
Throws
An
S3Exception
when the underlying S3 service returned error.A
StorageValidationErrorCode
when API call parameters are invalid.
getProperties
Parameters
Option | Required | Type | Description |
---|---|---|---|
input | true | The GetPropertiesInput object. |
Throws
An
S3Exception
when the underlying S3 service returned error.A
StorageValidationErrorCode
when API call parameters are invalid.
getUrl
expiresIn
is reached. The expiresAt
options.validateObjectExistence
to true, this method will verify the given object already exists in S3 before returning a presigned
URL, and will throw StorageError
if the object does not exist.Parameters
Option | Required | Type | Description |
---|---|---|---|
input | true | The GetUrlWithPathInput object. |
Throws
service:
S3Exception
- thrown when checking for existence of the objectvalidation:
StorageValidationErrorCode
- Validation errors thrown either username or key are not defined.
getUrl
Parameters
Option | Required | Type | Description |
---|---|---|---|
input | true | The GetUrlInput object. |
Throws
service:
S3Exception
- thrown when checking for existence of the objectvalidation:
StorageValidationErrorCode
- Validation errors thrown either username or key are not defined.
isCancelError
cancel()
on a upload/download task. If an overwriting error is
supplied to task.cancel(errorOverwrite)
, this function will return false
.Parameters
Option | Required | Type | Description |
---|---|---|---|
error | true | unknown | The unknown exception to be checked. |
Returns
CanceledError
list
path
.
pageSize
is defaulted to 1000. Additionally, the result will include a nextToken
if there are more items to retrieve.Parameters
Option | Required | Type | Description |
---|---|---|---|
input | true | The ListPaginateWithPathInput object. |
Throws
service:
S3Exception
- S3 service errors thrown when checking for existence of bucketvalidation:
StorageValidationErrorCode
- thrown when there are issues with credentials
list
path
. You can set listAll
to true in options
to get all the files from S3.Parameters
Option | Required | Type | Description |
---|---|---|---|
input | true | The ListAllWithPathInput object. |
Throws
service:
S3Exception
- S3 service errors thrown when checking for existence of bucketvalidation:
StorageValidationErrorCode
- thrown when there are issues with credentials
list
Parameters
Option | Required | Type | Description |
---|---|---|---|
input | false | The ListPaginateInput object. |
Throws
service:
S3Exception
- S3 service errors thrown when checking for existence of bucketvalidation:
StorageValidationErrorCode
- thrown when there are issues with credentials
Returns
Promise<>
list
Parameters
Option | Required | Type | Description |
---|---|---|---|
input | false | The ListAllInput object. |
Throws
service:
S3Exception
- S3 service errors thrown when checking for existence of bucketvalidation:
StorageValidationErrorCode
- thrown when there are issues with credentials
Returns
Promise<>
remove
Parameters
Option | Required | Type | Description |
---|---|---|---|
input | true | The RemoveWithPathInput object. |
Throws
service:
S3Exception
- S3 service errors thrown while while removing the object.validation:
StorageValidationErrorCode
- Validation errors thrown when there is no path or path is empty or path has a leading slash.
remove
Parameters
Option | Required | Type | Description |
---|---|---|---|
input | true | The RemoveInput object. |
Throws
service:
S3Exception
- S3 service errors thrown while while removing the objectvalidation:
StorageValidationErrorCode
- Validation errors thrown when there is no key or its empty.
Returns
Promise<>
uploadData
Parameters
Option | Required | Type | Description |
---|---|---|---|
input | true | A UploadDataWithPathInput object. |
Throws
Service:
S3Exception
thrown when checking for existence of the object.Validation:
StorageValidationErrorCode
thrown when a validation error occurs.
uploadData
Parameters
Option | Required | Type | Description |
---|---|---|---|
input | true | A UploadDataInput object. |
Throws
Service:
S3Exception
thrown when checking for existence of the object.Validation:
StorageValidationErrorCode
thrown when a validation error occurs.