@aws-amplify/storage
Version:
Storage category of aws-amplify
39 lines (38 loc) • 2.32 kB
TypeScript
import { GetUrlInput, GetUrlOutput, GetUrlWithPathInput, GetUrlWithPathOutput } from '../types';
/**
* Get a temporary presigned URL to download the specified S3 object.
* The presigned URL expires when the associated role used to sign the request expires or
* the option `expiresIn` is reached. The `expiresAt` property in the output object indicates when the URL MAY expire.
*
* By default, it will not validate the object that exists in S3. If you set the `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.
*
* @param input - The `GetUrlWithPathInput` object.
* @returns Presigned URL and timestamp when the URL may expire.
* @throws service: `S3Exception` - thrown when checking for existence of the object
* @throws validation: `StorageValidationErrorCode` - Validation errors
* thrown either username or key are not defined.
*
*/
export declare function getUrl(input: GetUrlWithPathInput): Promise<GetUrlWithPathOutput>;
/**
* @deprecated The `key` and `accessLevel` parameters are deprecated and may be removed in the next major version.
* Please use {@link https://docs.amplify.aws/javascript/build-a-backend/storage/download/#generate-a-download-url | path} instead.
*
* Get a temporary presigned URL to download the specified S3 object.
* The presigned URL expires when the associated role used to sign the request expires or
* the option `expiresIn` is reached. The `expiresAt` property in the output object indicates when the URL MAY expire.
*
* By default, it will not validate the object that exists in S3. If you set the `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.
*
* @param input - The `GetUrlInput` object.
* @returns Presigned URL and timestamp when the URL may expire.
* @throws service: `S3Exception` - thrown when checking for existence of the object
* @throws validation: `StorageValidationErrorCode` - Validation errors
* thrown either username or key are not defined.
*
*/
export declare function getUrl(input: GetUrlInput): Promise<GetUrlOutput>;