UNPKG

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