UNPKG

@aws-amplify/storage

Version:

Storage category of aws-amplify

docs.amplify.aws

aws-amplify/amplify-js

37 lines (36 loc) • 1.82 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
import { AmplifyContext } from '@aws-amplify/core'; import { CopyInput, CopyOutput, CopyWithPathInput, CopyWithPathOutput } from '../types'; /** * @param ctx - The AmplifyContext to operate on. * @param input - The `CopyWithPathInput` object. */ export declare function copy(ctx: AmplifyContext, input: CopyWithPathInput): Promise<CopyWithPathOutput>; /** * @param ctx - The AmplifyContext to operate on. * @param input - The `CopyInput` object. */ export declare function copy(ctx: AmplifyContext, input: CopyInput): Promise<CopyOutput>; /** * Copy an object from a source to a destination object within the same bucket. * * @param input - The `CopyWithPathInput` object. * @returns Output containing the destination object path. * @throws service: `S3Exception` - Thrown when checking for existence of the object * @throws validation: `StorageValidationErrorCode` - Thrown when * source or destination path is not defined. */ export declare function copy(input: CopyWithPathInput): Promise<CopyWithPathOutput>; /** * @deprecated The `key` and `accessLevel` parameters are deprecated and may be removed in the next major version. * Please use {@link https://docs.amplify.aws/react/build-a-backend/storage/copy | path} instead. * * Copy an object from a source to a destination object within the same bucket. Can optionally copy files across * different accessLevel or identityId (if source object's accessLevel is 'protected'). * * @param input - The `CopyInput` object. * @returns Output containing the destination object key. * @throws service: `S3Exception` - Thrown when checking for existence of the object * @throws validation: `StorageValidationErrorCode` - Thrown when * source or destination key is not defined. */ export declare function copy(input: CopyInput): Promise<CopyOutput>;