UNPKG

576 BTypeScriptView Raw
1import { GetPropertiesOutput, GetPropertiesInput } 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 GetPropertiesInput object.
7 * @returns Requested object properties.
8 * @throws A {@link S3Exception} when the underlying S3 service returned error.
9 * @throws A {@link StorageValidationErrorCode} when API call parameters are invalid.
10 */
11export declare const getProperties: (input: GetPropertiesInput) => Promise<GetPropertiesOutput>;