@aws-amplify/storage 6.0.20 → 6.0.21-gen2-storage.7da2b89.0

package/dist/esm/providers/s3/apis/server/copy.mjs

@@ -3,9 +3,7 @@ import { copy as copy$1 } from '../internal/copy.mjs';
 
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-const copy = async (contextSpec, input) => {
-    return copy$1(getAmplifyServerContext(contextSpec).amplify, input);
-};
+const copy = (contextSpec, input) => copy$1(getAmplifyServerContext(contextSpec).amplify, input);
 
 export { copy };
 //# sourceMappingURL=copy.mjs.map

package/dist/esm/providers/s3/apis/server/copy.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"copy.mjs","sources":["../../../../../../src/providers/s3/apis/server/copy.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { getAmplifyServerContext, } from '@aws-amplify/core/internals/adapter-core';\nimport { copy as copyInternal } from '../internal/copy';\nexport const copy = async (contextSpec, input) => {\n    return copyInternal(getAmplifyServerContext(contextSpec).amplify, input);\n};\n"],"names":["copyInternal"],"mappings":";;;AAAA;AACA;AAGY,MAAC,IAAI,GAAG,OAAO,WAAW,EAAE,KAAK,KAAK;AAClD,IAAI,OAAOA,MAAY,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAC7E;;;;"}
+{"version":3,"file":"copy.mjs","sources":["../../../../../../src/providers/s3/apis/server/copy.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { getAmplifyServerContext, } from '@aws-amplify/core/internals/adapter-core';\nimport { copy as copyInternal } from '../internal/copy';\nexport const copy = (contextSpec, input) => copyInternal(getAmplifyServerContext(contextSpec).amplify, input);\n"],"names":["copyInternal"],"mappings":";;;AAAA;AACA;AAGY,MAAC,IAAI,GAAG,CAAC,WAAW,EAAE,KAAK,KAAKA,MAAY,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,KAAK;;;;"}

package/dist/esm/providers/s3/apis/server/getProperties.d.ts

@@ -1,3 +1,31 @@
 import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
-import { GetPropertiesInput, GetPropertiesOutput } from '../../types';
-export declare const getProperties: (contextSpec: AmplifyServer.ContextSpec, input: GetPropertiesInput) => Promise<GetPropertiesOutput>;
+import { GetPropertiesInputKey, GetPropertiesInputPath, GetPropertiesOutputKey, GetPropertiesOutputPath } from '../../types';
+interface GetProperties {
+    /**
+     * Gets the properties of a file. The properties include S3 system metadata and
+     * the user metadata that was provided when uploading the file.
+     *
+     * @param contextSpec - The isolated server context.
+     * @param input - The `GetPropertiesInputPath` object.
+     * @returns Requested object properties.
+     * @throws An `S3Exception` when the underlying S3 service returned error.
+     * @throws A `StorageValidationErrorCode` when API call parameters are invalid.
+     */
+    (contextSpec: AmplifyServer.ContextSpec, input: GetPropertiesInputPath): Promise<GetPropertiesOutputPath>;
+    /**
+     * @deprecated The `key` and `accessLevel` parameters are deprecated and may be removed in the next major version.
+     * Please use {@link https://docs.amplify.aws/javascript/build-a-backend/storage/get-properties/ | path} instead.
+     *
+     * Gets the properties of a file. The properties include S3 system metadata and
+     * the user metadata that was provided when uploading the file.
+     *
+     * @param contextSpec - The isolated server context.
+     * @param input - The `GetPropertiesInputKey` object.
+     * @returns Requested object properties.
+     * @throws An `S3Exception` when the underlying S3 service returned error.
+     * @throws A `StorageValidationErrorCode` when API call parameters are invalid.
+     */
+    (contextSpec: AmplifyServer.ContextSpec, input: GetPropertiesInputKey): Promise<GetPropertiesOutputKey>;
+}
+export declare const getProperties: GetProperties;
+export {};

package/dist/esm/providers/s3/apis/server/getProperties.mjs

@@ -3,9 +3,7 @@ import { getProperties as getProperties$1 } from '../internal/getProperties.mjs'
 
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-const getProperties = (contextSpec, input) => {
-    return getProperties$1(getAmplifyServerContext(contextSpec).amplify, input);
-};
+const getProperties = (contextSpec, input) => getProperties$1(getAmplifyServerContext(contextSpec).amplify, input);
 
 export { getProperties };
 //# sourceMappingURL=getProperties.mjs.map

package/dist/esm/providers/s3/apis/server/getProperties.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"getProperties.mjs","sources":["../../../../../../src/providers/s3/apis/server/getProperties.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { getAmplifyServerContext, } from '@aws-amplify/core/internals/adapter-core';\nimport { getProperties as getPropertiesInternal } from '../internal/getProperties';\nexport const getProperties = (contextSpec, input) => {\n    return getPropertiesInternal(getAmplifyServerContext(contextSpec).amplify, input);\n};\n"],"names":["getPropertiesInternal"],"mappings":";;;AAAA;AACA;AAGY,MAAC,aAAa,GAAG,CAAC,WAAW,EAAE,KAAK,KAAK;AACrD,IAAI,OAAOA,eAAqB,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AACtF;;;;"}
+{"version":3,"file":"getProperties.mjs","sources":["../../../../../../src/providers/s3/apis/server/getProperties.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { getAmplifyServerContext, } from '@aws-amplify/core/internals/adapter-core';\nimport { getProperties as getPropertiesInternal } from '../internal/getProperties';\nexport const getProperties = (contextSpec, input) => getPropertiesInternal(getAmplifyServerContext(contextSpec).amplify, input);\n"],"names":["getPropertiesInternal"],"mappings":";;;AAAA;AACA;AAGY,MAAC,aAAa,GAAG,CAAC,WAAW,EAAE,KAAK,KAAKA,eAAqB,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,KAAK;;;;"}

package/dist/esm/providers/s3/apis/server/getUrl.d.ts

@@ -1,3 +1,45 @@
 import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
-import { GetUrlInput, GetUrlOutput } from '../../types';
-export declare const getUrl: (contextSpec: AmplifyServer.ContextSpec, input: GetUrlInput) => Promise<GetUrlOutput>;
+import { GetUrlInputKey, GetUrlInputPath, GetUrlOutput } from '../../types';
+interface GetUrl {
+    /**
+     * Get a temporary presigned URL to download the specified S3 object.
+     * The presigned URL expires when the associated role used to sign the request expires or
+     * the option  `expiresIn` is reached. The `expiresAt` property in the output object indicates when the URL MAY expire.
+     *
+     * By default, it will not validate the object that exists in S3. If you set the `options.validateObjectExistence`
+     * to true, this method will verify the given object already exists in S3 before returning a presigned
+     * URL, and will throw `StorageError` if the object does not exist.
+     *
+     * @param contextSpec - The isolated server context.
+     * @param input - The `GetUrlInputPath` object.
+     * @returns Presigned URL and timestamp when the URL MAY expire.
+     * @throws service: `S3Exception` - thrown when checking for existence of the object
+     * @throws validation: `StorageValidationErrorCode` - Validation errors
+     * thrown either username or key are not defined.
+     *
+     */
+    (contextSpec: AmplifyServer.ContextSpec, input: GetUrlInputPath): Promise<GetUrlOutput>;
+    /**
+     * @deprecated The `key` and `accessLevel` parameters are deprecated and may be removed in the next major version.
+     * Please use {@link https://docs.amplify.aws/javascript/build-a-backend/storage/download/#generate-a-download-url | path} instead.
+     *
+     * Get a temporary presigned URL to download the specified S3 object.
+     * The presigned URL expires when the associated role used to sign the request expires or
+     * the option  `expiresIn` is reached. The `expiresAt` property in the output object indicates when the URL MAY expire.
+     *
+     * By default, it will not validate the object that exists in S3. If you set the `options.validateObjectExistence`
+     * to true, this method will verify the given object already exists in S3 before returning a presigned
+     * URL, and will throw `StorageError` if the object does not exist.
+     *
+     * @param contextSpec - The isolated server context.
+     * @param input - The `GetUrlInputKey` object.
+     * @returns Presigned URL and timestamp when the URL MAY expire.
+     * @throws service: `S3Exception` - thrown when checking for existence of the object
+     * @throws validation: `StorageValidationErrorCode` - Validation errors
+     * thrown either username or key are not defined.
+     *
+     */
+    (contextSpec: AmplifyServer.ContextSpec, input: GetUrlInputKey): Promise<GetUrlOutput>;
+}
+export declare const getUrl: GetUrl;
+export {};

package/dist/esm/providers/s3/apis/server/getUrl.mjs

@@ -3,9 +3,7 @@ import { getUrl as getUrl$1 } from '../internal/getUrl.mjs';
 
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-const getUrl = async (contextSpec, input) => {
-    return getUrl$1(getAmplifyServerContext(contextSpec).amplify, input);
-};
+const getUrl = async (contextSpec, input) => getUrl$1(getAmplifyServerContext(contextSpec).amplify, input);
 
 export { getUrl };
 //# sourceMappingURL=getUrl.mjs.map

package/dist/esm/providers/s3/apis/server/getUrl.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"getUrl.mjs","sources":["../../../../../../src/providers/s3/apis/server/getUrl.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { getAmplifyServerContext, } from '@aws-amplify/core/internals/adapter-core';\nimport { getUrl as getUrlInternal } from '../internal/getUrl';\nexport const getUrl = async (contextSpec, input) => {\n    return getUrlInternal(getAmplifyServerContext(contextSpec).amplify, input);\n};\n"],"names":["getUrlInternal"],"mappings":";;;AAAA;AACA;AAGY,MAAC,MAAM,GAAG,OAAO,WAAW,EAAE,KAAK,KAAK;AACpD,IAAI,OAAOA,QAAc,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAC/E;;;;"}
+{"version":3,"file":"getUrl.mjs","sources":["../../../../../../src/providers/s3/apis/server/getUrl.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { getAmplifyServerContext, } from '@aws-amplify/core/internals/adapter-core';\nimport { getUrl as getUrlInternal } from '../internal/getUrl';\nexport const getUrl = async (contextSpec, input) => getUrlInternal(getAmplifyServerContext(contextSpec).amplify, input);\n"],"names":["getUrlInternal"],"mappings":";;;AAAA;AACA;AAGY,MAAC,MAAM,GAAG,OAAO,WAAW,EAAE,KAAK,KAAKA,QAAc,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,KAAK;;;;"}

package/dist/esm/providers/s3/apis/server/remove.d.ts

@@ -1,3 +1,29 @@
 import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
-import { RemoveInput, RemoveOutput } from '../../types';
-export declare const remove: (contextSpec: AmplifyServer.ContextSpec, input: RemoveInput) => Promise<RemoveOutput>;
+import { RemoveInputKey, RemoveInputPath, RemoveOutputKey, RemoveOutputPath } from '../../types';
+interface RemoveApi {
+    /**
+     * Remove a file from your S3 bucket.
+     * @param input - The `RemoveInputPath` object.
+     * @param contextSpec - The context spec used to get the Amplify server context.
+     * @return Output containing the removed object path.
+     * @throws service: `S3Exception` - S3 service errors thrown while while removing the object.
+     * @throws validation: `StorageValidationErrorCode` - Validation errors thrown
+     * when there is no path or path is empty or path has a leading slash.
+     */
+    (contextSpec: AmplifyServer.ContextSpec, input: RemoveInputPath): Promise<RemoveOutputPath>;
+    /**
+     * @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/remove | path} instead.
+     *
+     * Remove a file from your S3 bucket.
+     * @param input - The `RemoveInputKey` object.
+     * @param contextSpec - The context spec used to get the Amplify server context.
+     * @return Output containing the removed object key
+     * @throws service: `S3Exception` - S3 service errors thrown while while removing the object
+     * @throws validation: `StorageValidationErrorCode` - Validation errors thrown
+     * when there is no key or its empty.
+     */
+    (contextSpec: AmplifyServer.ContextSpec, input: RemoveInputKey): Promise<RemoveOutputKey>;
+}
+export declare const remove: RemoveApi;
+export {};

package/dist/esm/providers/s3/apis/server/remove.mjs

@@ -3,9 +3,7 @@ import { remove as remove$1 } from '../internal/remove.mjs';
 
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-const remove = (contextSpec, input) => {
-    return remove$1(getAmplifyServerContext(contextSpec).amplify, input);
-};
+const remove = (contextSpec, input) => remove$1(getAmplifyServerContext(contextSpec).amplify, input);
 
 export { remove };
 //# sourceMappingURL=remove.mjs.map

package/dist/esm/providers/s3/apis/server/remove.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"remove.mjs","sources":["../../../../../../src/providers/s3/apis/server/remove.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { getAmplifyServerContext, } from '@aws-amplify/core/internals/adapter-core';\nimport { remove as removeInternal } from '../internal/remove';\nexport const remove = (contextSpec, input) => {\n    return removeInternal(getAmplifyServerContext(contextSpec).amplify, input);\n};\n"],"names":["removeInternal"],"mappings":";;;AAAA;AACA;AAGY,MAAC,MAAM,GAAG,CAAC,WAAW,EAAE,KAAK,KAAK;AAC9C,IAAI,OAAOA,QAAc,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAC/E;;;;"}
+{"version":3,"file":"remove.mjs","sources":["../../../../../../src/providers/s3/apis/server/remove.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { getAmplifyServerContext, } from '@aws-amplify/core/internals/adapter-core';\nimport { remove as removeInternal } from '../internal/remove';\nexport const remove = (contextSpec, input) => removeInternal(getAmplifyServerContext(contextSpec).amplify, input);\n"],"names":["removeInternal"],"mappings":";;;AAAA;AACA;AAGY,MAAC,MAAM,GAAG,CAAC,WAAW,EAAE,KAAK,KAAKA,QAAc,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,KAAK;;;;"}

package/dist/esm/providers/s3/apis/uploadData/multipart/uploadHandlers.d.ts

@@ -1,5 +1,5 @@
 import { UploadDataInput } from '../../../types';
-import { Item as S3Item } from '../../../types/outputs';
+import { ItemKey as S3Item } from '../../../types/outputs';
 /**
  * Create closure hiding the multipart upload implementation details and expose the upload job and control functions(
  * onPause, onResume, onCancel).

package/dist/esm/providers/s3/apis/uploadData/putObjectJob.d.ts

@@ -1,5 +1,5 @@
 import { UploadDataInput } from '../../types';
-import { Item as S3Item } from '../../types/outputs';
+import { ItemKey as S3Item } from '../../types/outputs';
 /**
  * Get a function the returns a promise to call putObject API to S3.
  *

package/dist/esm/providers/s3/types/index.d.ts

@@ -1,4 +1,4 @@
-export { GetUrlOptions, UploadDataOptions, GetPropertiesOptions, ListAllOptions, ListPaginateOptions, RemoveOptions, DownloadDataOptions, CopyDestinationOptions, CopySourceOptions, } from './options';
-export { DownloadDataOutput, GetUrlOutput, UploadDataOutput, ListOutputItem, ListAllOutput, ListPaginateOutput, GetPropertiesOutput, CopyOutput, RemoveOutput, } from './outputs';
-export { CopyInput, GetPropertiesInput, GetUrlInput, ListAllInput, ListPaginateInput, RemoveInput, DownloadDataInput, UploadDataInput, } from './inputs';
+export { GetUrlOptionsKey, GetUrlOptionsPath, UploadDataOptions, GetPropertiesOptionsKey, GetPropertiesOptionsPath, ListAllOptions, ListPaginateOptions, RemoveOptions, DownloadDataOptionsPath, DownloadDataOptionsKey, CopyDestinationOptionsKey, CopySourceOptionsKey, } from './options';
+export { DownloadDataOutput, DownloadDataOutputKey, DownloadDataOutputPath, GetUrlOutput, UploadDataOutput, ListOutputItem, ListAllOutput, ListPaginateOutput, GetPropertiesOutput, GetPropertiesOutputKey, GetPropertiesOutputPath, CopyOutput, CopyOutputKey, CopyOutputPath, RemoveOutput, RemoveOutputKey, RemoveOutputPath, } from './outputs';
+export { CopyInput, CopyInputKey, CopyInputPath, GetPropertiesInput, GetPropertiesInputKey, GetPropertiesInputPath, GetUrlInput, GetUrlInputKey, GetUrlInputPath, ListAllInput, ListPaginateInput, RemoveInputKey, RemoveInputPath, RemoveInput, DownloadDataInput, DownloadDataInputKey, DownloadDataInputPath, UploadDataInput, } from './inputs';
 export { S3Exception } from './errors';

package/dist/esm/providers/s3/types/inputs.d.ts

@@ -1,17 +1,27 @@
-import { StorageCopyInput, StorageDownloadDataInput, StorageGetPropertiesInput, StorageGetUrlInput, StorageListInput, StorageRemoveInput, StorageUploadDataInput } from '../../../types';
-import { CopyDestinationOptions, CopySourceOptions, DownloadDataOptions, GetPropertiesOptions, GetUrlOptions, ListAllOptions, ListPaginateOptions, RemoveOptions, UploadDataOptions } from '../types';
+import { StrictUnion } from '@aws-amplify/core/internals/utils';
+import { StorageCopyInputKey, StorageCopyInputPath, StorageDownloadDataInputKey, StorageDownloadDataInputPath, StorageGetPropertiesInputKey, StorageGetPropertiesInputPath, StorageGetUrlInputKey, StorageGetUrlInputPath, StorageListInput, StorageRemoveInputKey, StorageRemoveInputPath, StorageUploadDataInput } from '../../../types';
+import { CopyDestinationOptionsKey, CopySourceOptionsKey, DownloadDataOptionsKey, DownloadDataOptionsPath, GetPropertiesOptionsKey, GetPropertiesOptionsPath, GetUrlOptionsKey, GetUrlOptionsPath, ListAllOptions, ListPaginateOptions, RemoveOptions, UploadDataOptions } from '../types';
 /**
  * Input type for S3 copy API.
  */
-export type CopyInput = StorageCopyInput<CopySourceOptions, CopyDestinationOptions>;
+export type CopyInput = CopyInputKey | CopyInputPath;
+/** @deprecated Use {@link CopyInputPath} instead. */
+export type CopyInputKey = StorageCopyInputKey<CopySourceOptionsKey, CopyDestinationOptionsKey>;
+export type CopyInputPath = StorageCopyInputPath;
 /**
  * Input type for S3 getProperties API.
  */
-export type GetPropertiesInput = StorageGetPropertiesInput<GetPropertiesOptions>;
+export type GetPropertiesInput = StrictUnion<GetPropertiesInputKey | GetPropertiesInputPath>;
+/** @deprecated Use {@link GetPropertiesInputPath} instead. */
+export type GetPropertiesInputKey = StorageGetPropertiesInputKey<GetPropertiesOptionsKey>;
+export type GetPropertiesInputPath = StorageGetPropertiesInputPath<GetPropertiesOptionsPath>;
 /**
  * Input type for S3 getUrl API.
  */
-export type GetUrlInput = StorageGetUrlInput<GetUrlOptions>;
+export type GetUrlInput = StrictUnion<GetUrlInputKey | GetUrlInputPath>;
+/** @deprecated Use {@link GetUrlInputPath} instead. */
+export type GetUrlInputKey = StorageGetUrlInputKey<GetUrlOptionsKey>;
+export type GetUrlInputPath = StorageGetUrlInputPath<GetUrlOptionsPath>;
 /**
  * Input type for S3 list API. Lists all bucket objects.
  */
@@ -20,14 +30,26 @@ export type ListAllInput = StorageListInput<ListAllOptions>;
  * Input type for S3 list API. Lists bucket objects with pagination.
  */
 export type ListPaginateInput = StorageListInput<ListPaginateOptions>;
+/**
+ * @deprecated Use {@link RemoveInputPath} instead.
+ * Input type with key for S3 remove API.
+ */
+export type RemoveInputKey = StorageRemoveInputKey<RemoveOptions>;
+/**
+ * Input type with path for S3 remove API.
+ */
+export type RemoveInputPath = StorageRemoveInputPath<Omit<RemoveOptions, 'accessLevel'>>;
 /**
  * Input type for S3 remove API.
  */
-export type RemoveInput = StorageRemoveInput<RemoveOptions>;
+export type RemoveInput = StrictUnion<RemoveInputKey | RemoveInputPath>;
 /**
  * Input type for S3 downloadData API.
  */
-export type DownloadDataInput = StorageDownloadDataInput<DownloadDataOptions>;
+export type DownloadDataInput = StrictUnion<DownloadDataInputKey | DownloadDataInputPath>;
+/** @deprecated Use {@link DownloadDataInputPath} instead. */
+export type DownloadDataInputKey = StorageDownloadDataInputKey<DownloadDataOptionsKey>;
+export type DownloadDataInputPath = StorageDownloadDataInputPath<DownloadDataOptionsPath>;
 /**
  * Input type for S3 uploadData API.
  */

package/dist/esm/providers/s3/types/options.d.ts

@@ -9,13 +9,19 @@ interface CommonOptions {
      */
     useAccelerateEndpoint?: boolean;
 }
+/** @deprecated This may be removed in the next major version. */
 type ReadOptions = {
+    /** @deprecated This may be removed in the next major version. */
     accessLevel?: 'guest' | 'private';
 } | {
+    /** @deprecated This may be removed in the next major version. */
     accessLevel: 'protected';
+    /** @deprecated This may be removed in the next major version. */
     targetIdentityId?: string;
 };
+/** @deprecated This may be removed in the next major version. */
 interface WriteOptions {
+    /** @deprecated This may be removed in the next major version. */
     accessLevel?: StorageAccessLevel;
 }
 interface BytesRangeOptions {
@@ -36,7 +42,9 @@ interface TransferOptions {
 /**
  * Input options type for S3 getProperties API.
  */
-export type GetPropertiesOptions = ReadOptions & CommonOptions;
+/** @deprecated Use {@link GetPropertiesOptionsPath} instead. */
+export type GetPropertiesOptionsKey = ReadOptions & CommonOptions;
+export type GetPropertiesOptionsPath = CommonOptions;
 /**
  * Input options type for S3 getProperties API.
  */
@@ -52,7 +60,7 @@ export type ListPaginateOptions = StorageListPaginateOptions & ReadOptions & Com
 /**
  * Input options type for S3 getUrl API.
  */
-export type GetUrlOptions = ReadOptions & CommonOptions & {
+export type GetUrlOptions = CommonOptions & {
     /**
      * Whether to head object to make sure the object existence before downloading.
      * @default false
@@ -64,10 +72,16 @@ export type GetUrlOptions = ReadOptions & CommonOptions & {
      */
     expiresIn?: number;
 };
+/** @deprecated Use {@link GetUrlOptionsPath} instead. */
+export type GetUrlOptionsKey = ReadOptions & GetUrlOptions;
+export type GetUrlOptionsPath = GetUrlOptions;
 /**
  * Input options type for S3 downloadData API.
  */
-export type DownloadDataOptions = ReadOptions & CommonOptions & TransferOptions & BytesRangeOptions;
+export type DownloadDataOptions = CommonOptions & TransferOptions & BytesRangeOptions;
+/** @deprecated Use {@link DownloadDataOptionsPath} instead. */
+export type DownloadDataOptionsKey = ReadOptions & DownloadDataOptions;
+export type DownloadDataOptionsPath = DownloadDataOptions;
 export type UploadDataOptions = WriteOptions & CommonOptions & TransferOptions & {
     /**
      * The default content-disposition header value of the file when downloading it.
@@ -90,10 +104,14 @@ export type UploadDataOptions = WriteOptions & CommonOptions & TransferOptions &
      */
     metadata?: Record<string, string>;
 };
-export type CopySourceOptions = ReadOptions & {
+/** @deprecated This may be removed in the next major version. */
+export type CopySourceOptionsKey = ReadOptions & {
+    /** @deprecated This may be removed in the next major version. */
     key: string;
 };
-export type CopyDestinationOptions = WriteOptions & {
+/** @deprecated This may be removed in the next major version. */
+export type CopyDestinationOptionsKey = WriteOptions & {
+    /** @deprecated This may be removed in the next major version. */
     key: string;
 };
 /**

package/dist/esm/providers/s3/types/outputs.d.ts

@@ -1,8 +1,9 @@
-import { DownloadTask, StorageDownloadDataOutput, StorageGetUrlOutput, StorageItem, StorageListOutput, UploadTask } from '../../../types';
+import { StrictUnion } from '@aws-amplify/core/internals/utils';
+import { DownloadTask, StorageDownloadDataOutput, StorageGetUrlOutput, StorageItemKey, StorageItemPath, StorageListOutput, UploadTask } from '../../../types';
 /**
- * type for S3 item.
+ * Base type for an S3 item.
  */
-export interface Item extends StorageItem {
+export interface ItemBase {
     /**
      * VersionId used to reference a specific version of the object.
      */
@@ -12,14 +13,22 @@ export interface Item extends StorageItem {
      */
     contentType?: string;
 }
+/**
+ * @deprecated Use {@link ItemPath} instead.
+ */
+export type ItemKey = ItemBase & StorageItemKey;
+export type ItemPath = ItemBase & StorageItemPath;
 /**
  * type for S3 list item.
  */
-export type ListOutputItem = Omit<StorageItem, 'metadata'>;
+export type ListOutputItem = Omit<ItemKey, 'metadata'>;
+/** @deprecated Use {@link DownloadDataOutputPath} instead. */
+export type DownloadDataOutputKey = DownloadTask<StorageDownloadDataOutput<ItemKey>>;
+export type DownloadDataOutputPath = DownloadTask<StorageDownloadDataOutput<ItemPath>>;
 /**
  * Output type for S3 downloadData API.
  */
-export type DownloadDataOutput = DownloadTask<StorageDownloadDataOutput<Item>>;
+export type DownloadDataOutput = DownloadDataOutputKey | DownloadDataOutputPath;
 /**
  * Output type for S3 getUrl API.
  */
@@ -27,11 +36,14 @@ export type GetUrlOutput = StorageGetUrlOutput;
 /**
  * Output type for S3 uploadData API.
  */
-export type UploadDataOutput = UploadTask<Item>;
+export type UploadDataOutput = UploadTask<ItemKey>;
+/** @deprecated Use {@link GetPropertiesOutputPath} instead. */
+export type GetPropertiesOutputKey = ItemKey;
+export type GetPropertiesOutputPath = ItemPath;
 /**
  * Output type for S3 getProperties API.
  */
-export type GetPropertiesOutput = Item;
+export type GetPropertiesOutput = GetPropertiesOutputKey | GetPropertiesOutputPath;
 /**
  * Output type for S3 list API. Lists all bucket objects.
  */
@@ -43,10 +55,21 @@ export type ListPaginateOutput = StorageListOutput<ListOutputItem> & {
     nextToken?: string;
 };
 /**
- * Output type for S3 copy API.
+ * @deprecated Use {@link CopyOutputPath} instead.
  */
-export type CopyOutput = Pick<Item, 'key'>;
+export type CopyOutputKey = Pick<ItemKey, 'key'>;
+export type CopyOutputPath = Pick<ItemPath, 'path'>;
+export type CopyOutput = StrictUnion<CopyOutputKey | CopyOutputPath>;
 /**
  * Output type for S3 remove API.
  */
-export type RemoveOutput = Pick<Item, 'key'>;
+export type RemoveOutput = StrictUnion<RemoveOutputKey | RemoveOutputPath>;
+/**
+ * @deprecated Use {@link RemoveOutputPath} instead.
+ * Output helper type with key for S3 remove API.
+ */
+export type RemoveOutputKey = Pick<ItemKey, 'key'>;
+/**
+ * Output helper type with path for S3 remove API.
+ */
+export type RemoveOutputPath = Pick<ItemPath, 'path'>;

package/dist/esm/providers/s3/utils/constants.d.ts

@@ -7,3 +7,5 @@ export declare const MAX_OBJECT_SIZE: number;
 export declare const MAX_PARTS_COUNT = 10000;
 export declare const DEFAULT_QUEUE_SIZE = 4;
 export declare const UPLOADS_STORAGE_KEY = "__uploadInProgress";
+export declare const STORAGE_INPUT_KEY = "key";
+export declare const STORAGE_INPUT_PATH = "path";

package/dist/esm/providers/s3/utils/constants.mjs

@@ -12,6 +12,8 @@ const MAX_OBJECT_SIZE = 5 * TiB;
 const MAX_PARTS_COUNT = 10000;
 const DEFAULT_QUEUE_SIZE = 4;
 const UPLOADS_STORAGE_KEY = '__uploadInProgress';
+const STORAGE_INPUT_KEY = 'key';
+const STORAGE_INPUT_PATH = 'path';
 
-export { DEFAULT_ACCESS_LEVEL, DEFAULT_PART_SIZE, DEFAULT_PRESIGN_EXPIRATION, DEFAULT_QUEUE_SIZE, LOCAL_TESTING_S3_ENDPOINT, MAX_OBJECT_SIZE, MAX_PARTS_COUNT, MAX_URL_EXPIRATION, UPLOADS_STORAGE_KEY };
+export { DEFAULT_ACCESS_LEVEL, DEFAULT_PART_SIZE, DEFAULT_PRESIGN_EXPIRATION, DEFAULT_QUEUE_SIZE, LOCAL_TESTING_S3_ENDPOINT, MAX_OBJECT_SIZE, MAX_PARTS_COUNT, MAX_URL_EXPIRATION, STORAGE_INPUT_KEY, STORAGE_INPUT_PATH, UPLOADS_STORAGE_KEY };
 //# sourceMappingURL=constants.mjs.map

package/dist/esm/providers/s3/utils/constants.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"constants.mjs","sources":["../../../../../src/providers/s3/utils/constants.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nexport const LOCAL_TESTING_S3_ENDPOINT = 'http://localhost:20005';\nexport const DEFAULT_ACCESS_LEVEL = 'guest';\nexport const DEFAULT_PRESIGN_EXPIRATION = 900;\nexport const MAX_URL_EXPIRATION = 7 * 24 * 60 * 60 * 1000;\nconst MiB = 1024 * 1024;\nconst GiB = 1024 * MiB;\nconst TiB = 1024 * GiB;\nexport const DEFAULT_PART_SIZE = 5 * MiB;\nexport const MAX_OBJECT_SIZE = 5 * TiB;\nexport const MAX_PARTS_COUNT = 10000;\nexport const DEFAULT_QUEUE_SIZE = 4;\nexport const UPLOADS_STORAGE_KEY = '__uploadInProgress';\n"],"names":[],"mappings":"AAAA;AACA;AACY,MAAC,yBAAyB,GAAG,yBAAyB;AACtD,MAAC,oBAAoB,GAAG,QAAQ;AAChC,MAAC,0BAA0B,GAAG,IAAI;AAClC,MAAC,kBAAkB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,KAAK;AAC1D,MAAM,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC;AACxB,MAAM,GAAG,GAAG,IAAI,GAAG,GAAG,CAAC;AACvB,MAAM,GAAG,GAAG,IAAI,GAAG,GAAG,CAAC;AACX,MAAC,iBAAiB,GAAG,CAAC,GAAG,IAAI;AAC7B,MAAC,eAAe,GAAG,CAAC,GAAG,IAAI;AAC3B,MAAC,eAAe,GAAG,MAAM;AACzB,MAAC,kBAAkB,GAAG,EAAE;AACxB,MAAC,mBAAmB,GAAG;;;;"}
+{"version":3,"file":"constants.mjs","sources":["../../../../../src/providers/s3/utils/constants.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nexport const LOCAL_TESTING_S3_ENDPOINT = 'http://localhost:20005';\nexport const DEFAULT_ACCESS_LEVEL = 'guest';\nexport const DEFAULT_PRESIGN_EXPIRATION = 900;\nexport const MAX_URL_EXPIRATION = 7 * 24 * 60 * 60 * 1000;\nconst MiB = 1024 * 1024;\nconst GiB = 1024 * MiB;\nconst TiB = 1024 * GiB;\nexport const DEFAULT_PART_SIZE = 5 * MiB;\nexport const MAX_OBJECT_SIZE = 5 * TiB;\nexport const MAX_PARTS_COUNT = 10000;\nexport const DEFAULT_QUEUE_SIZE = 4;\nexport const UPLOADS_STORAGE_KEY = '__uploadInProgress';\nexport const STORAGE_INPUT_KEY = 'key';\nexport const STORAGE_INPUT_PATH = 'path';\n"],"names":[],"mappings":"AAAA;AACA;AACY,MAAC,yBAAyB,GAAG,yBAAyB;AACtD,MAAC,oBAAoB,GAAG,QAAQ;AAChC,MAAC,0BAA0B,GAAG,IAAI;AAClC,MAAC,kBAAkB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,KAAK;AAC1D,MAAM,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC;AACxB,MAAM,GAAG,GAAG,IAAI,GAAG,GAAG,CAAC;AACvB,MAAM,GAAG,GAAG,IAAI,GAAG,GAAG,CAAC;AACX,MAAC,iBAAiB,GAAG,CAAC,GAAG,IAAI;AAC7B,MAAC,eAAe,GAAG,CAAC,GAAG,IAAI;AAC3B,MAAC,eAAe,GAAG,MAAM;AACzB,MAAC,kBAAkB,GAAG,EAAE;AACxB,MAAC,mBAAmB,GAAG,qBAAqB;AAC5C,MAAC,iBAAiB,GAAG,MAAM;AAC3B,MAAC,kBAAkB,GAAG;;;;"}

package/dist/esm/providers/s3/utils/index.d.ts

@@ -1,3 +1,5 @@
 export { calculateContentMd5 } from './md5';
 export { resolveS3ConfigAndInput } from './resolveS3ConfigAndInput';
 export { createDownloadTask, createUploadTask } from './transferTask';
+export { validateStorageOperationInput } from './validateStorageOperationInput';
+export { isInputWithPath } from './isInputWithPath';

package/dist/esm/providers/s3/utils/index.mjs

@@ -1,4 +1,6 @@
 export { calculateContentMd5 } from './md5.mjs';
 export { resolveS3ConfigAndInput } from './resolveS3ConfigAndInput.mjs';
 export { createDownloadTask, createUploadTask } from './transferTask.mjs';
+export { validateStorageOperationInput } from './validateStorageOperationInput.mjs';
+export { isInputWithPath } from './isInputWithPath.mjs';
 //# sourceMappingURL=index.mjs.map

package/dist/esm/providers/s3/utils/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}

package/dist/esm/providers/s3/utils/isInputWithPath.d.ts

@@ -0,0 +1,2 @@
+import { StorageOperationInputPath, StorageOperationInputType } from '../../../types/inputs';
+export declare const isInputWithPath: (input: StorageOperationInputType) => input is StorageOperationInputPath;

package/dist/esm/providers/s3/utils/isInputWithPath.mjs

@@ -0,0 +1,8 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+const isInputWithPath = (input) => {
+    return input.path !== undefined;
+};
+
+export { isInputWithPath };
+//# sourceMappingURL=isInputWithPath.mjs.map

package/dist/esm/providers/s3/utils/isInputWithPath.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"isInputWithPath.mjs","sources":["../../../../../src/providers/s3/utils/isInputWithPath.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nexport const isInputWithPath = (input) => {\n    return input.path !== undefined;\n};\n"],"names":[],"mappings":"AAAA;AACA;AACY,MAAC,eAAe,GAAG,CAAC,KAAK,KAAK;AAC1C,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC;AACpC;;;;"}

package/dist/esm/providers/s3/utils/resolveS3ConfigAndInput.d.ts

@@ -10,6 +10,7 @@ interface ResolvedS3ConfigAndInput {
     bucket: string;
     keyPrefix: string;
     isObjectLockEnabled?: boolean;
+    identityId?: string;
 }
 /**
  * resolve the common input options for S3 API handlers from Amplify configuration and library options.
@@ -17,7 +18,7 @@ interface ResolvedS3ConfigAndInput {
  * @param {AmplifyClassV6} amplify The Amplify instance.
  * @param {S3ApiOptions} apiOptions The input options for S3 provider.
  * @returns {Promise<ResolvedS3ConfigAndInput>} The resolved common input options for S3 API handlers.
- * @throws A {@link StorageError} with `error.name` from {@link StorageValidationErrorCode} indicating invalid
+ * @throws A `StorageError` with `error.name` from `StorageValidationErrorCode` indicating invalid
  *   configurations or Amplify library options.
  *
  * @internal

package/dist/esm/providers/s3/utils/resolveS3ConfigAndInput.mjs

@@ -11,7 +11,7 @@ import { DEFAULT_ACCESS_LEVEL, LOCAL_TESTING_S3_ENDPOINT } from './constants.mjs
  * @param {AmplifyClassV6} amplify The Amplify instance.
  * @param {S3ApiOptions} apiOptions The input options for S3 provider.
  * @returns {Promise<ResolvedS3ConfigAndInput>} The resolved common input options for S3 API handlers.
- * @throws A {@link StorageError} with `error.name` from {@link StorageValidationErrorCode} indicating invalid
+ * @throws A `StorageError` with `error.name` from `StorageValidationErrorCode` indicating invalid
  *   configurations or Amplify library options.
  *
  * @internal
@@ -48,6 +48,7 @@ const resolveS3ConfigAndInput = async (amplify, apiOptions) => {
         },
         bucket,
         keyPrefix,
+        identityId,
         isObjectLockEnabled,
     };
 };

package/dist/esm/providers/s3/utils/resolveS3ConfigAndInput.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"resolveS3ConfigAndInput.mjs","sources":["../../../../../src/providers/s3/utils/resolveS3ConfigAndInput.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { assertValidationError } from '../../../errors/utils/assertValidationError';\nimport { StorageValidationErrorCode } from '../../../errors/types/validation';\nimport { resolvePrefix as defaultPrefixResolver } from '../../../utils/resolvePrefix';\nimport { DEFAULT_ACCESS_LEVEL, LOCAL_TESTING_S3_ENDPOINT } from './constants';\n/**\n * resolve the common input options for S3 API handlers from Amplify configuration and library options.\n *\n * @param {AmplifyClassV6} amplify The Amplify instance.\n * @param {S3ApiOptions} apiOptions The input options for S3 provider.\n * @returns {Promise<ResolvedS3ConfigAndInput>} The resolved common input options for S3 API handlers.\n * @throws A {@link StorageError} with `error.name` from {@link StorageValidationErrorCode} indicating invalid\n *   configurations or Amplify library options.\n *\n * @internal\n */\nexport const resolveS3ConfigAndInput = async (amplify, apiOptions) => {\n    // identityId is always cached in memory if forceRefresh is not set. So we can safely make calls here.\n    const { credentials, identityId } = await amplify.Auth.fetchAuthSession({\n        forceRefresh: false,\n    });\n    assertValidationError(!!credentials, StorageValidationErrorCode.NoCredentials);\n    assertValidationError(!!identityId, StorageValidationErrorCode.NoIdentityId);\n    const { bucket, region, dangerouslyConnectToHttpEndpointForTesting } = amplify.getConfig()?.Storage?.S3 ?? {};\n    assertValidationError(!!bucket, StorageValidationErrorCode.NoBucket);\n    assertValidationError(!!region, StorageValidationErrorCode.NoRegion);\n    const { defaultAccessLevel, prefixResolver = defaultPrefixResolver, isObjectLockEnabled, } = amplify.libraryOptions?.Storage?.S3 ?? {};\n    const keyPrefix = await prefixResolver({\n        accessLevel: apiOptions?.accessLevel ?? defaultAccessLevel ?? DEFAULT_ACCESS_LEVEL,\n        // use conditional assign to make tsc happy because StorageOptions is a union type that may not have targetIdentityId\n        targetIdentityId: apiOptions?.accessLevel === 'protected'\n            ? apiOptions?.targetIdentityId ?? identityId\n            : identityId,\n    });\n    return {\n        s3Config: {\n            credentials,\n            region,\n            useAccelerateEndpoint: apiOptions?.useAccelerateEndpoint,\n            ...(dangerouslyConnectToHttpEndpointForTesting\n                ? {\n                    customEndpoint: LOCAL_TESTING_S3_ENDPOINT,\n                    forcePathStyle: true,\n                }\n                : {}),\n        },\n        bucket,\n        keyPrefix,\n        isObjectLockEnabled,\n    };\n};\n"],"names":["defaultPrefixResolver"],"mappings":";;;;;AAAA;AACA;AAKA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,uBAAuB,GAAG,OAAO,OAAO,EAAE,UAAU,KAAK;AACtE;AACA,IAAI,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC;AAC5E,QAAQ,YAAY,EAAE,KAAK;AAC3B,KAAK,CAAC,CAAC;AACP,IAAI,qBAAqB,CAAC,CAAC,CAAC,WAAW,EAAE,0BAA0B,CAAC,aAAa,CAAC,CAAC;AACnF,IAAI,qBAAqB,CAAC,CAAC,CAAC,UAAU,EAAE,0BAA0B,CAAC,YAAY,CAAC,CAAC;AACjF,IAAI,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,0CAA0C,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC;AAClH,IAAI,qBAAqB,CAAC,CAAC,CAAC,MAAM,EAAE,0BAA0B,CAAC,QAAQ,CAAC,CAAC;AACzE,IAAI,qBAAqB,CAAC,CAAC,CAAC,MAAM,EAAE,0BAA0B,CAAC,QAAQ,CAAC,CAAC;AACzE,IAAI,MAAM,EAAE,kBAAkB,EAAE,cAAc,GAAGA,aAAqB,EAAE,mBAAmB,GAAG,GAAG,OAAO,CAAC,cAAc,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC;AAC3I,IAAI,MAAM,SAAS,GAAG,MAAM,cAAc,CAAC;AAC3C,QAAQ,WAAW,EAAE,UAAU,EAAE,WAAW,IAAI,kBAAkB,IAAI,oBAAoB;AAC1F;AACA,QAAQ,gBAAgB,EAAE,UAAU,EAAE,WAAW,KAAK,WAAW;AACjE,cAAc,UAAU,EAAE,gBAAgB,IAAI,UAAU;AACxD,cAAc,UAAU;AACxB,KAAK,CAAC,CAAC;AACP,IAAI,OAAO;AACX,QAAQ,QAAQ,EAAE;AAClB,YAAY,WAAW;AACvB,YAAY,MAAM;AAClB,YAAY,qBAAqB,EAAE,UAAU,EAAE,qBAAqB;AACpE,YAAY,IAAI,0CAA0C;AAC1D,kBAAkB;AAClB,oBAAoB,cAAc,EAAE,yBAAyB;AAC7D,oBAAoB,cAAc,EAAE,IAAI;AACxC,iBAAiB;AACjB,kBAAkB,EAAE;AACpB,SAAS;AACT,QAAQ,MAAM;AACd,QAAQ,SAAS;AACjB,QAAQ,mBAAmB;AAC3B,KAAK,CAAC;AACN;;;;"}
+{"version":3,"file":"resolveS3ConfigAndInput.mjs","sources":["../../../../../src/providers/s3/utils/resolveS3ConfigAndInput.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { assertValidationError } from '../../../errors/utils/assertValidationError';\nimport { StorageValidationErrorCode } from '../../../errors/types/validation';\nimport { resolvePrefix as defaultPrefixResolver } from '../../../utils/resolvePrefix';\nimport { DEFAULT_ACCESS_LEVEL, LOCAL_TESTING_S3_ENDPOINT } from './constants';\n/**\n * resolve the common input options for S3 API handlers from Amplify configuration and library options.\n *\n * @param {AmplifyClassV6} amplify The Amplify instance.\n * @param {S3ApiOptions} apiOptions The input options for S3 provider.\n * @returns {Promise<ResolvedS3ConfigAndInput>} The resolved common input options for S3 API handlers.\n * @throws A `StorageError` with `error.name` from `StorageValidationErrorCode` indicating invalid\n *   configurations or Amplify library options.\n *\n * @internal\n */\nexport const resolveS3ConfigAndInput = async (amplify, apiOptions) => {\n    // identityId is always cached in memory if forceRefresh is not set. So we can safely make calls here.\n    const { credentials, identityId } = await amplify.Auth.fetchAuthSession({\n        forceRefresh: false,\n    });\n    assertValidationError(!!credentials, StorageValidationErrorCode.NoCredentials);\n    assertValidationError(!!identityId, StorageValidationErrorCode.NoIdentityId);\n    const { bucket, region, dangerouslyConnectToHttpEndpointForTesting } = amplify.getConfig()?.Storage?.S3 ?? {};\n    assertValidationError(!!bucket, StorageValidationErrorCode.NoBucket);\n    assertValidationError(!!region, StorageValidationErrorCode.NoRegion);\n    const { defaultAccessLevel, prefixResolver = defaultPrefixResolver, isObjectLockEnabled, } = amplify.libraryOptions?.Storage?.S3 ?? {};\n    const keyPrefix = await prefixResolver({\n        accessLevel: apiOptions?.accessLevel ?? defaultAccessLevel ?? DEFAULT_ACCESS_LEVEL,\n        // use conditional assign to make tsc happy because StorageOptions is a union type that may not have targetIdentityId\n        targetIdentityId: apiOptions?.accessLevel === 'protected'\n            ? apiOptions?.targetIdentityId ?? identityId\n            : identityId,\n    });\n    return {\n        s3Config: {\n            credentials,\n            region,\n            useAccelerateEndpoint: apiOptions?.useAccelerateEndpoint,\n            ...(dangerouslyConnectToHttpEndpointForTesting\n                ? {\n                    customEndpoint: LOCAL_TESTING_S3_ENDPOINT,\n                    forcePathStyle: true,\n                }\n                : {}),\n        },\n        bucket,\n        keyPrefix,\n        identityId,\n        isObjectLockEnabled,\n    };\n};\n"],"names":["defaultPrefixResolver"],"mappings":";;;;;AAAA;AACA;AAKA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,uBAAuB,GAAG,OAAO,OAAO,EAAE,UAAU,KAAK;AACtE;AACA,IAAI,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC;AAC5E,QAAQ,YAAY,EAAE,KAAK;AAC3B,KAAK,CAAC,CAAC;AACP,IAAI,qBAAqB,CAAC,CAAC,CAAC,WAAW,EAAE,0BAA0B,CAAC,aAAa,CAAC,CAAC;AACnF,IAAI,qBAAqB,CAAC,CAAC,CAAC,UAAU,EAAE,0BAA0B,CAAC,YAAY,CAAC,CAAC;AACjF,IAAI,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,0CAA0C,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC;AAClH,IAAI,qBAAqB,CAAC,CAAC,CAAC,MAAM,EAAE,0BAA0B,CAAC,QAAQ,CAAC,CAAC;AACzE,IAAI,qBAAqB,CAAC,CAAC,CAAC,MAAM,EAAE,0BAA0B,CAAC,QAAQ,CAAC,CAAC;AACzE,IAAI,MAAM,EAAE,kBAAkB,EAAE,cAAc,GAAGA,aAAqB,EAAE,mBAAmB,GAAG,GAAG,OAAO,CAAC,cAAc,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC;AAC3I,IAAI,MAAM,SAAS,GAAG,MAAM,cAAc,CAAC;AAC3C,QAAQ,WAAW,EAAE,UAAU,EAAE,WAAW,IAAI,kBAAkB,IAAI,oBAAoB;AAC1F;AACA,QAAQ,gBAAgB,EAAE,UAAU,EAAE,WAAW,KAAK,WAAW;AACjE,cAAc,UAAU,EAAE,gBAAgB,IAAI,UAAU;AACxD,cAAc,UAAU;AACxB,KAAK,CAAC,CAAC;AACP,IAAI,OAAO;AACX,QAAQ,QAAQ,EAAE;AAClB,YAAY,WAAW;AACvB,YAAY,MAAM;AAClB,YAAY,qBAAqB,EAAE,UAAU,EAAE,qBAAqB;AACpE,YAAY,IAAI,0CAA0C;AAC1D,kBAAkB;AAClB,oBAAoB,cAAc,EAAE,yBAAyB;AAC7D,oBAAoB,cAAc,EAAE,IAAI;AACxC,iBAAiB;AACjB,kBAAkB,EAAE;AACpB,SAAS;AACT,QAAQ,MAAM;AACd,QAAQ,SAAS;AACjB,QAAQ,UAAU;AAClB,QAAQ,mBAAmB;AAC3B,KAAK,CAAC;AACN;;;;"}

package/dist/esm/providers/s3/utils/validateStorageOperationInput.d.ts

@@ -0,0 +1,5 @@
+import { StorageOperationInputType as Input } from '../../../types/inputs';
+export declare const validateStorageOperationInput: (input: Input, identityId?: string) => {
+    inputType: string;
+    objectKey: string;
+};

package/dist/esm/providers/s3/utils/validateStorageOperationInput.mjs

@@ -0,0 +1,29 @@
+import { assertValidationError } from '../../../errors/utils/assertValidationError.mjs';
+import { StorageValidationErrorCode } from '../../../errors/types/validation.mjs';
+import { isInputWithPath } from './isInputWithPath.mjs';
+import { STORAGE_INPUT_PATH, STORAGE_INPUT_KEY } from './constants.mjs';
+
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+const validateStorageOperationInput = (input, identityId) => {
+    assertValidationError(
+    // Key present without a path
+    (!!input.key && !input.path) ||
+        // Path present without a key
+        (!input.key && !!input.path), StorageValidationErrorCode.InvalidStorageOperationInput);
+    if (isInputWithPath(input)) {
+        const { path } = input;
+        const objectKey = typeof path === 'string' ? path : path({ identityId });
+        assertValidationError(!objectKey.startsWith('/'), StorageValidationErrorCode.InvalidStoragePathInput);
+        return {
+            inputType: STORAGE_INPUT_PATH,
+            objectKey,
+        };
+    }
+    else {
+        return { inputType: STORAGE_INPUT_KEY, objectKey: input.key };
+    }
+};
+
+export { validateStorageOperationInput };
+//# sourceMappingURL=validateStorageOperationInput.mjs.map

package/dist/esm/providers/s3/utils/validateStorageOperationInput.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateStorageOperationInput.mjs","sources":["../../../../../src/providers/s3/utils/validateStorageOperationInput.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { assertValidationError } from '../../../errors/utils/assertValidationError';\nimport { StorageValidationErrorCode } from '../../../errors/types/validation';\nimport { isInputWithPath } from './isInputWithPath';\nimport { STORAGE_INPUT_KEY, STORAGE_INPUT_PATH } from './constants';\nexport const validateStorageOperationInput = (input, identityId) => {\n    assertValidationError(\n    // Key present without a path\n    (!!input.key && !input.path) ||\n        // Path present without a key\n        (!input.key && !!input.path), StorageValidationErrorCode.InvalidStorageOperationInput);\n    if (isInputWithPath(input)) {\n        const { path } = input;\n        const objectKey = typeof path === 'string' ? path : path({ identityId });\n        assertValidationError(!objectKey.startsWith('/'), StorageValidationErrorCode.InvalidStoragePathInput);\n        return {\n            inputType: STORAGE_INPUT_PATH,\n            objectKey,\n        };\n    }\n    else {\n        return { inputType: STORAGE_INPUT_KEY, objectKey: input.key };\n    }\n};\n"],"names":[],"mappings":";;;;;AAAA;AACA;AAKY,MAAC,6BAA6B,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK;AACpE,IAAI,qBAAqB;AACzB;AACA,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI;AAC/B;AACA,SAAS,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,0BAA0B,CAAC,4BAA4B,CAAC,CAAC;AAC/F,IAAI,IAAI,eAAe,CAAC,KAAK,CAAC,EAAE;AAChC,QAAQ,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;AAC/B,QAAQ,MAAM,SAAS,GAAG,OAAO,IAAI,KAAK,QAAQ,GAAG,IAAI,GAAG,IAAI,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;AACjF,QAAQ,qBAAqB,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,0BAA0B,CAAC,uBAAuB,CAAC,CAAC;AAC9G,QAAQ,OAAO;AACf,YAAY,SAAS,EAAE,kBAAkB;AACzC,YAAY,SAAS;AACrB,SAAS,CAAC;AACV,KAAK;AACL,SAAS;AACT,QAAQ,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,SAAS,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC;AACtE,KAAK;AACL;;;;"}

package/dist/esm/types/index.d.ts

@@ -1,4 +1,4 @@
 export { DownloadTask, TransferProgressEvent, TransferTaskState, UploadTask, } from './common';
-export { StorageOperationInput, StorageListInput, StorageGetPropertiesInput, StorageRemoveInput, StorageDownloadDataInput, StorageUploadDataInput, StorageCopyInput, StorageGetUrlInput, StorageUploadDataPayload, } from './inputs';
+export { StorageOperationInput, StorageListInput, StorageGetPropertiesInputKey, StorageGetPropertiesInputPath, StorageRemoveInputPath, StorageRemoveInputKey, StorageDownloadDataInputKey, StorageDownloadDataInputPath, StorageUploadDataInput, StorageCopyInputKey, StorageCopyInputPath, StorageGetUrlInputKey, StorageGetUrlInputPath, StorageUploadDataPayload, } from './inputs';
 export { StorageOptions, StorageRemoveOptions, StorageListAllOptions, StorageListPaginateOptions, } from './options';
-export { StorageItem, StorageListOutput, StorageDownloadDataOutput, StorageGetUrlOutput, StorageUploadOutput, } from './outputs';
+export { StorageItem, StorageItemKey, StorageItemPath, StorageListOutput, StorageDownloadDataOutput, StorageGetUrlOutput, StorageUploadOutput, } from './outputs';