@aws-amplify/storage/src/providers/s3/apis/copy.ts

Storage category of aws-amplify

// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

import { AmplifyContext } from '@aws-amplify/core';
import { resolveCtxArgs } from '@aws-amplify/core/internals/utils';

import {
	CopyInput,
	CopyOutput,
	CopyWithPathInput,
	CopyWithPathOutput,
} from '../types';

import { copy as copyInternal } from './internal/copy';
/**
 * @param ctx - The AmplifyContext to operate on.
 * @param input - The `CopyWithPathInput` object.
 */
export function copy(
	ctx: AmplifyContext,
	input: CopyWithPathInput,
): Promise<CopyWithPathOutput>;
/**
 * @param ctx - The AmplifyContext to operate on.
 * @param input - The `CopyInput` object.
 */
export 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 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 function copy(input: CopyInput): Promise<CopyOutput>;

// Overload signatures above are the public contract; the impl is intentionally untyped and shape is enforced by resolveCtxArgs.
export function copy(...args: any[]) {
	const [ctx, input] = resolveCtxArgs<[CopyInput | CopyWithPathInput]>(args);

	return copyInternal(ctx, input);
}