UNPKG

1.38 kBTypeScriptView Raw
1import { GetPropertiesInput, GetPropertiesOutput, GetPropertiesWithPathInput, GetPropertiesWithPathOutput } from '../types';
2/**
3 * Gets the properties of a file. The properties include S3 system metadata and
4 * the user metadata that was provided when uploading the file.
5 *
6 * @param input - The `GetPropertiesWithPathInput` object.
7 * @returns Requested object properties.
8 * @throws An `S3Exception` when the underlying S3 service returned error.
9 * @throws A `StorageValidationErrorCode` when API call parameters are invalid.
10 */
11export declare function getProperties(input: GetPropertiesWithPathInput): Promise<GetPropertiesWithPathOutput>;
12/**
13 * @deprecated The `key` and `accessLevel` parameters are deprecated and may be removed in the next major version.
14 * Please use {@link https://docs.amplify.aws/javascript/build-a-backend/storage/get-properties/ | path} instead.
15 *
16 * Gets the properties of a file. The properties include S3 system metadata and
17 * the user metadata that was provided when uploading the file.
18 *
19 * @param input - The `GetPropertiesInput` object.
20 * @returns Requested object properties.
21 * @throws An `S3Exception` when the underlying S3 service returned error.
22 * @throws A `StorageValidationErrorCode` when API call parameters are invalid.
23 */
24export declare function getProperties(input: GetPropertiesInput): Promise<GetPropertiesOutput>;