@aws-amplify/storage
Version:
Storage category of aws-amplify
28 lines (25 loc) • 1.25 kB
JavaScript
import { Amplify } from '@aws-amplify/core';
import { getUrl as getUrl$1 } from './internal/getUrl.mjs';
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
/**
* 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 {@link StorageError} if the object does not exist.
*
* @param input - The GetUrlInput object.
* @returns Presigned URL and timestamp when the URL MAY expire.
* @throws service: {@link S3Exception} - thrown when checking for existence of the object
* @throws validation: {@link StorageValidationErrorCode } - Validation errors
* thrown either username or key are not defined.
*
*/
const getUrl = (input) => {
return getUrl$1(Amplify, input);
};
export { getUrl };
//# sourceMappingURL=getUrl.mjs.map