@aws-amplify/storage 6.0.28 → 6.0.29-gen2-storage.e54bfa9.0

package/dist/esm/errors/types/validation.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"validation.mjs","sources":["../../../../src/errors/types/validation.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nexport var StorageValidationErrorCode;\n(function (StorageValidationErrorCode) {\n    StorageValidationErrorCode[\"NoCredentials\"] = \"NoCredentials\";\n    StorageValidationErrorCode[\"NoIdentityId\"] = \"NoIdentityId\";\n    StorageValidationErrorCode[\"NoKey\"] = \"NoKey\";\n    StorageValidationErrorCode[\"NoSourceKey\"] = \"NoSourceKey\";\n    StorageValidationErrorCode[\"NoDestinationKey\"] = \"NoDestinationKey\";\n    StorageValidationErrorCode[\"NoBucket\"] = \"NoBucket\";\n    StorageValidationErrorCode[\"NoRegion\"] = \"NoRegion\";\n    StorageValidationErrorCode[\"UrlExpirationMaxLimitExceed\"] = \"UrlExpirationMaxLimitExceed\";\n    StorageValidationErrorCode[\"ObjectIsTooLarge\"] = \"ObjectIsTooLarge\";\n    StorageValidationErrorCode[\"InvalidUploadSource\"] = \"InvalidUploadSource\";\n})(StorageValidationErrorCode || (StorageValidationErrorCode = {}));\nexport const validationErrorMap = {\n    [StorageValidationErrorCode.NoCredentials]: {\n        message: 'Credentials should not be empty.',\n    },\n    [StorageValidationErrorCode.NoIdentityId]: {\n        message: 'Missing identity ID when accessing objects in protected or private access level.',\n    },\n    [StorageValidationErrorCode.NoKey]: {\n        message: 'Missing key in api call.',\n    },\n    [StorageValidationErrorCode.NoSourceKey]: {\n        message: 'Missing source key in copy api call.',\n    },\n    [StorageValidationErrorCode.NoDestinationKey]: {\n        message: 'Missing destination key in copy api call.',\n    },\n    [StorageValidationErrorCode.NoBucket]: {\n        message: 'Missing bucket name while accessing object.',\n    },\n    [StorageValidationErrorCode.NoRegion]: {\n        message: 'Missing region while accessing object.',\n    },\n    [StorageValidationErrorCode.UrlExpirationMaxLimitExceed]: {\n        message: 'Url Expiration can not be greater than 7 Days.',\n    },\n    [StorageValidationErrorCode.ObjectIsTooLarge]: {\n        message: 'Object size cannot not be greater than 5TB.',\n    },\n    [StorageValidationErrorCode.InvalidUploadSource]: {\n        message: 'Upload source type can only be a `Blob`, `File`, `ArrayBuffer`, or `string`.',\n    },\n};\n"],"names":[],"mappings":"AAAA;AACA;AACU,IAAC,2BAA2B;AACtC,CAAC,UAAU,0BAA0B,EAAE;AACvC,IAAI,0BAA0B,CAAC,eAAe,CAAC,GAAG,eAAe,CAAC;AAClE,IAAI,0BAA0B,CAAC,cAAc,CAAC,GAAG,cAAc,CAAC;AAChE,IAAI,0BAA0B,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;AAClD,IAAI,0BAA0B,CAAC,aAAa,CAAC,GAAG,aAAa,CAAC;AAC9D,IAAI,0BAA0B,CAAC,kBAAkB,CAAC,GAAG,kBAAkB,CAAC;AACxE,IAAI,0BAA0B,CAAC,UAAU,CAAC,GAAG,UAAU,CAAC;AACxD,IAAI,0BAA0B,CAAC,UAAU,CAAC,GAAG,UAAU,CAAC;AACxD,IAAI,0BAA0B,CAAC,6BAA6B,CAAC,GAAG,6BAA6B,CAAC;AAC9F,IAAI,0BAA0B,CAAC,kBAAkB,CAAC,GAAG,kBAAkB,CAAC;AACxE,IAAI,0BAA0B,CAAC,qBAAqB,CAAC,GAAG,qBAAqB,CAAC;AAC9E,CAAC,EAAE,0BAA0B,KAAK,0BAA0B,GAAG,EAAE,CAAC,CAAC,CAAC;AACxD,MAAC,kBAAkB,GAAG;AAClC,IAAI,CAAC,0BAA0B,CAAC,aAAa,GAAG;AAChD,QAAQ,OAAO,EAAE,kCAAkC;AACnD,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,YAAY,GAAG;AAC/C,QAAQ,OAAO,EAAE,kFAAkF;AACnG,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,KAAK,GAAG;AACxC,QAAQ,OAAO,EAAE,0BAA0B;AAC3C,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,WAAW,GAAG;AAC9C,QAAQ,OAAO,EAAE,sCAAsC;AACvD,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,gBAAgB,GAAG;AACnD,QAAQ,OAAO,EAAE,2CAA2C;AAC5D,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,QAAQ,GAAG;AAC3C,QAAQ,OAAO,EAAE,6CAA6C;AAC9D,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,QAAQ,GAAG;AAC3C,QAAQ,OAAO,EAAE,wCAAwC;AACzD,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,2BAA2B,GAAG;AAC9D,QAAQ,OAAO,EAAE,gDAAgD;AACjE,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,gBAAgB,GAAG;AACnD,QAAQ,OAAO,EAAE,6CAA6C;AAC9D,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,mBAAmB,GAAG;AACtD,QAAQ,OAAO,EAAE,8EAA8E;AAC/F,KAAK;AACL;;;;"}
+{"version":3,"file":"validation.mjs","sources":["../../../../src/errors/types/validation.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nexport var StorageValidationErrorCode;\n(function (StorageValidationErrorCode) {\n    StorageValidationErrorCode[\"NoCredentials\"] = \"NoCredentials\";\n    StorageValidationErrorCode[\"NoIdentityId\"] = \"NoIdentityId\";\n    StorageValidationErrorCode[\"NoKey\"] = \"NoKey\";\n    StorageValidationErrorCode[\"NoSourceKey\"] = \"NoSourceKey\";\n    StorageValidationErrorCode[\"NoDestinationKey\"] = \"NoDestinationKey\";\n    StorageValidationErrorCode[\"NoSourcePath\"] = \"NoSourcePath\";\n    StorageValidationErrorCode[\"NoDestinationPath\"] = \"NoDestinationPath\";\n    StorageValidationErrorCode[\"NoBucket\"] = \"NoBucket\";\n    StorageValidationErrorCode[\"NoRegion\"] = \"NoRegion\";\n    StorageValidationErrorCode[\"InvalidStorageOperationPrefixInput\"] = \"InvalidStorageOperationPrefixInput\";\n    StorageValidationErrorCode[\"InvalidStorageOperationInput\"] = \"InvalidStorageOperationInput\";\n    StorageValidationErrorCode[\"InvalidStoragePathInput\"] = \"InvalidStoragePathInput\";\n    StorageValidationErrorCode[\"InvalidUploadSource\"] = \"InvalidUploadSource\";\n    StorageValidationErrorCode[\"ObjectIsTooLarge\"] = \"ObjectIsTooLarge\";\n    StorageValidationErrorCode[\"UrlExpirationMaxLimitExceed\"] = \"UrlExpirationMaxLimitExceed\";\n})(StorageValidationErrorCode || (StorageValidationErrorCode = {}));\nexport const validationErrorMap = {\n    [StorageValidationErrorCode.NoCredentials]: {\n        message: 'Credentials should not be empty.',\n    },\n    [StorageValidationErrorCode.NoIdentityId]: {\n        message: 'Missing identity ID when accessing objects in protected or private access level.',\n    },\n    [StorageValidationErrorCode.NoKey]: {\n        message: 'Missing key in api call.',\n    },\n    [StorageValidationErrorCode.NoSourceKey]: {\n        message: 'Missing source key in copy api call.',\n    },\n    [StorageValidationErrorCode.NoDestinationKey]: {\n        message: 'Missing destination key in copy api call.',\n    },\n    [StorageValidationErrorCode.NoSourcePath]: {\n        message: 'Missing source path in copy api call.',\n    },\n    [StorageValidationErrorCode.NoDestinationPath]: {\n        message: 'Missing destination path in copy api call.',\n    },\n    [StorageValidationErrorCode.NoBucket]: {\n        message: 'Missing bucket name while accessing object.',\n    },\n    [StorageValidationErrorCode.NoRegion]: {\n        message: 'Missing region while accessing object.',\n    },\n    [StorageValidationErrorCode.UrlExpirationMaxLimitExceed]: {\n        message: 'Url Expiration can not be greater than 7 Days.',\n    },\n    [StorageValidationErrorCode.ObjectIsTooLarge]: {\n        message: 'Object size cannot not be greater than 5TB.',\n    },\n    [StorageValidationErrorCode.InvalidUploadSource]: {\n        message: 'Upload source type can only be a `Blob`, `File`, `ArrayBuffer`, or `string`.',\n    },\n    [StorageValidationErrorCode.InvalidStorageOperationInput]: {\n        message: 'Path or key parameter must be specified in the input. Both can not be specified at the same time.',\n    },\n    [StorageValidationErrorCode.InvalidStorageOperationPrefixInput]: {\n        message: 'Both path and prefix can not be specified at the same time.',\n    },\n    [StorageValidationErrorCode.InvalidStoragePathInput]: {\n        message: 'Input `path` does not allow a leading slash (/).',\n    },\n};\n"],"names":[],"mappings":"AAAA;AACA;AACU,IAAC,2BAA2B;AACtC,CAAC,UAAU,0BAA0B,EAAE;AACvC,IAAI,0BAA0B,CAAC,eAAe,CAAC,GAAG,eAAe,CAAC;AAClE,IAAI,0BAA0B,CAAC,cAAc,CAAC,GAAG,cAAc,CAAC;AAChE,IAAI,0BAA0B,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;AAClD,IAAI,0BAA0B,CAAC,aAAa,CAAC,GAAG,aAAa,CAAC;AAC9D,IAAI,0BAA0B,CAAC,kBAAkB,CAAC,GAAG,kBAAkB,CAAC;AACxE,IAAI,0BAA0B,CAAC,cAAc,CAAC,GAAG,cAAc,CAAC;AAChE,IAAI,0BAA0B,CAAC,mBAAmB,CAAC,GAAG,mBAAmB,CAAC;AAC1E,IAAI,0BAA0B,CAAC,UAAU,CAAC,GAAG,UAAU,CAAC;AACxD,IAAI,0BAA0B,CAAC,UAAU,CAAC,GAAG,UAAU,CAAC;AACxD,IAAI,0BAA0B,CAAC,oCAAoC,CAAC,GAAG,oCAAoC,CAAC;AAC5G,IAAI,0BAA0B,CAAC,8BAA8B,CAAC,GAAG,8BAA8B,CAAC;AAChG,IAAI,0BAA0B,CAAC,yBAAyB,CAAC,GAAG,yBAAyB,CAAC;AACtF,IAAI,0BAA0B,CAAC,qBAAqB,CAAC,GAAG,qBAAqB,CAAC;AAC9E,IAAI,0BAA0B,CAAC,kBAAkB,CAAC,GAAG,kBAAkB,CAAC;AACxE,IAAI,0BAA0B,CAAC,6BAA6B,CAAC,GAAG,6BAA6B,CAAC;AAC9F,CAAC,EAAE,0BAA0B,KAAK,0BAA0B,GAAG,EAAE,CAAC,CAAC,CAAC;AACxD,MAAC,kBAAkB,GAAG;AAClC,IAAI,CAAC,0BAA0B,CAAC,aAAa,GAAG;AAChD,QAAQ,OAAO,EAAE,kCAAkC;AACnD,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,YAAY,GAAG;AAC/C,QAAQ,OAAO,EAAE,kFAAkF;AACnG,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,KAAK,GAAG;AACxC,QAAQ,OAAO,EAAE,0BAA0B;AAC3C,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,WAAW,GAAG;AAC9C,QAAQ,OAAO,EAAE,sCAAsC;AACvD,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,gBAAgB,GAAG;AACnD,QAAQ,OAAO,EAAE,2CAA2C;AAC5D,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,YAAY,GAAG;AAC/C,QAAQ,OAAO,EAAE,uCAAuC;AACxD,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,iBAAiB,GAAG;AACpD,QAAQ,OAAO,EAAE,4CAA4C;AAC7D,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,QAAQ,GAAG;AAC3C,QAAQ,OAAO,EAAE,6CAA6C;AAC9D,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,QAAQ,GAAG;AAC3C,QAAQ,OAAO,EAAE,wCAAwC;AACzD,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,2BAA2B,GAAG;AAC9D,QAAQ,OAAO,EAAE,gDAAgD;AACjE,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,gBAAgB,GAAG;AACnD,QAAQ,OAAO,EAAE,6CAA6C;AAC9D,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,mBAAmB,GAAG;AACtD,QAAQ,OAAO,EAAE,8EAA8E;AAC/F,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,4BAA4B,GAAG;AAC/D,QAAQ,OAAO,EAAE,mGAAmG;AACpH,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,kCAAkC,GAAG;AACrE,QAAQ,OAAO,EAAE,6DAA6D;AAC9E,KAAK;AACL,IAAI,CAAC,0BAA0B,CAAC,uBAAuB,GAAG;AAC1D,QAAQ,OAAO,EAAE,kDAAkD;AACnE,KAAK;AACL;;;;"}

package/dist/esm/index.d.ts

@@ -1,6 +1,6 @@
 export { uploadData, downloadData, remove, list, getProperties, copy, getUrl, } from './providers/s3';
-export { UploadDataInput, DownloadDataInput, RemoveInput, ListAllInput, ListPaginateInput, GetPropertiesInput, CopyInput, GetUrlInput, } from './providers/s3/types/inputs';
-export { UploadDataOutput, DownloadDataOutput, RemoveOutput, ListAllOutput, ListPaginateOutput, GetPropertiesOutput, CopyOutput, GetUrlOutput, } from './providers/s3/types/outputs';
+export { UploadDataInput, UploadDataWithPathInput, DownloadDataInput, DownloadDataWithPathInput, RemoveInput, RemoveWithPathInput, ListAllInput, ListAllWithPathInput, ListPaginateInput, ListPaginateWithPathInput, GetPropertiesInput, GetPropertiesWithPathInput, CopyInput, CopyWithPathInput, GetUrlInput, GetUrlWithPathInput, } from './providers/s3/types/inputs';
+export { UploadDataOutput, UploadDataWithPathOutput, DownloadDataOutput, DownloadDataWithPathOutput, RemoveOutput, RemoveWithPathOutput, ListAllOutput, ListAllWithPathOutput, ListPaginateOutput, ListPaginateWithPathOutput, GetPropertiesOutput, GetPropertiesWithPathOutput, CopyOutput, CopyWithPathOutput, GetUrlOutput, GetUrlWithPathOutput, } from './providers/s3/types/outputs';
 export { TransferProgressEvent } from './types';
 export { isCancelError } from './errors/CanceledError';
 export { StorageError } from './errors/StorageError';

package/dist/esm/providers/s3/apis/copy.d.ts

@@ -1,12 +1,25 @@
-import { CopyInput, CopyOutput } from '../types';
+import { CopyInput, CopyOutput, CopyWithPathInput, CopyWithPathOutput } from '../types';
 /**
- * Copy an object from a source object to a new object within the same bucket. Can optionally copy files across
- * different level or identityId (if source object's level is 'protected').
+ * Copy an object from a source to a destination object within the same bucket.
  *
- * @param input - The CopyInput object.
- * @returns Output containing the destination key.
- * @throws service: {@link S3Exception} - Thrown when checking for existence of the object
- * @throws validation: {@link StorageValidationErrorCode } - Thrown when
- * source or destination key are not defined.
+ * @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 const copy: (input: CopyInput) => Promise<CopyOutput>;
+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>;

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

@@ -3,19 +3,9 @@ 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
-/**
- * Copy an object from a source object to a new object within the same bucket. Can optionally copy files across
- * different level or identityId (if source object's level is 'protected').
- *
- * @param input - The CopyInput object.
- * @returns Output containing the destination key.
- * @throws service: {@link S3Exception} - Thrown when checking for existence of the object
- * @throws validation: {@link StorageValidationErrorCode } - Thrown when
- * source or destination key are not defined.
- */
-const copy = async (input) => {
+function copy(input) {
     return copy$1(Amplify, input);
-};
+}
 
 export { copy };
 //# sourceMappingURL=copy.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"copy.mjs","sources":["../../../../../src/providers/s3/apis/copy.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { Amplify } from '@aws-amplify/core';\nimport { copy as copyInternal } from './internal/copy';\n/**\n * Copy an object from a source object to a new object within the same bucket. Can optionally copy files across\n * different level or identityId (if source object's level is 'protected').\n *\n * @param input - The CopyInput object.\n * @returns Output containing the destination key.\n * @throws service: {@link S3Exception} - Thrown when checking for existence of the object\n * @throws validation: {@link StorageValidationErrorCode } - Thrown when\n * source or destination key are not defined.\n */\nexport const copy = async (input) => {\n    return copyInternal(Amplify, input);\n};\n"],"names":["copyInternal"],"mappings":";;;AAAA;AACA;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,IAAI,GAAG,OAAO,KAAK,KAAK;AACrC,IAAI,OAAOA,MAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AACxC;;;;"}
+{"version":3,"file":"copy.mjs","sources":["../../../../../src/providers/s3/apis/copy.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { Amplify } from '@aws-amplify/core';\nimport { copy as copyInternal } from './internal/copy';\nexport function copy(input) {\n    return copyInternal(Amplify, input);\n}\n"],"names":["copyInternal"],"mappings":";;;AAAA;AACA;AAGO,SAAS,IAAI,CAAC,KAAK,EAAE;AAC5B,IAAI,OAAOA,MAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AACxC;;;;"}

package/dist/esm/providers/s3/apis/downloadData.d.ts

@@ -1,23 +1,23 @@
-import { DownloadDataInput, DownloadDataOutput } from '../types';
+import { DownloadDataInput, DownloadDataOutput, DownloadDataWithPathInput, DownloadDataWithPathOutput } from '../types';
 /**
  * Download S3 object data to memory
  *
- * @param input - The DownloadDataInput object.
+ * @param input - The `DownloadDataWithPathInput` object.
  * @returns A cancelable task exposing result promise from `result` property.
- * @throws service: {@link S3Exception} - thrown when checking for existence of the object
- * @throws validation: {@link StorageValidationErrorCode } - Validation errors
+ * @throws service: `S3Exception` - thrown when checking for existence of the object
+ * @throws validation: `StorageValidationErrorCode` - Validation errors
  *
  * @example
  * ```ts
  * // Download a file from s3 bucket
- * const { body, eTag } = await downloadData({ key, data: file, options: {
+ * const { body, eTag } = await downloadData({ path, options: {
  *   onProgress, // Optional progress callback.
  * } }).result;
  * ```
  * @example
  * ```ts
  * // Cancel a task
- * const downloadTask = downloadData({ key, data: file });
+ * const downloadTask = downloadData({ path });
  * //...
  * downloadTask.cancel();
  * try {
@@ -29,4 +29,38 @@ import { DownloadDataInput, DownloadDataOutput } from '../types';
  * }
  *```
  */
-export declare const downloadData: (input: DownloadDataInput) => DownloadDataOutput;
+export declare function downloadData(input: DownloadDataWithPathInput): DownloadDataWithPathOutput;
+/**
+ * @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/download/#downloaddata | path} instead.
+ *
+ * Download S3 object data to memory
+ *
+ * @param input - The `DownloadDataInput` object.
+ * @returns A cancelable task exposing result promise from `result` property.
+ * @throws service: `S3Exception` - thrown when checking for existence of the object
+ * @throws validation: `StorageValidationErrorCode` - Validation errors
+ *
+ * @example
+ * ```ts
+ * // Download a file from s3 bucket
+ * const { body, eTag } = await downloadData({ key, options: {
+ *   onProgress, // Optional progress callback.
+ * } }).result;
+ * ```
+ * @example
+ * ```ts
+ * // Cancel a task
+ * const downloadTask = downloadData({ key });
+ * //...
+ * downloadTask.cancel();
+ * try {
+ * 	await downloadTask.result;
+ * } catch (error) {
+ * 	if(isCancelError(error)) {
+ *    // Handle error thrown by task cancelation.
+ * 	}
+ * }
+ *```
+ */
+export declare function downloadData(input: DownloadDataInput): DownloadDataOutput;

package/dist/esm/providers/s3/apis/downloadData.mjs

@@ -8,6 +8,9 @@ import 'fast-xml-parser';
 import '../utils/client/runtime/s3TransferHandler/xhr.mjs';
 import 'buffer';
 import { createDownloadTask } from '../utils/transferTask.mjs';
+import { validateStorageOperationInput } from '../utils/validateStorageOperationInput.mjs';
+import '../../../errors/types/validation.mjs';
+import { STORAGE_INPUT_KEY } from '../utils/constants.mjs';
 import '../utils/client/base.mjs';
 import { getObject } from '../utils/client/getObject.mjs';
 import '../utils/client/listObjectsV2.mjs';
@@ -21,42 +24,11 @@ import '../utils/client/copyObject.mjs';
 import '../utils/client/headObject.mjs';
 import '../utils/client/deleteObject.mjs';
 import { getStorageUserAgentValue } from '../utils/userAgent.mjs';
-import '../../../errors/types/validation.mjs';
 import { logger } from '../../../utils/logger.mjs';
 
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-/**
- * Download S3 object data to memory
- *
- * @param input - The DownloadDataInput object.
- * @returns A cancelable task exposing result promise from `result` property.
- * @throws service: {@link S3Exception} - thrown when checking for existence of the object
- * @throws validation: {@link StorageValidationErrorCode } - Validation errors
- *
- * @example
- * ```ts
- * // Download a file from s3 bucket
- * const { body, eTag } = await downloadData({ key, data: file, options: {
- *   onProgress, // Optional progress callback.
- * } }).result;
- * ```
- * @example
- * ```ts
- * // Cancel a task
- * const downloadTask = downloadData({ key, data: file });
- * //...
- * downloadTask.cancel();
- * try {
- * 	await downloadTask.result;
- * } catch (error) {
- * 	if(isCancelError(error)) {
- *    // Handle error thrown by task cancelation.
- * 	}
- * }
- *```
- */
-const downloadData = (input) => {
+function downloadData(input) {
     const abortController = new AbortController();
     const downloadTask = createDownloadTask({
         job: downloadDataJob(input, abortController.signal),
@@ -65,11 +37,13 @@ const downloadData = (input) => {
         },
     });
     return downloadTask;
-};
-const downloadDataJob = ({ options: downloadDataOptions, key }, abortSignal) => async () => {
-    const { bucket, keyPrefix, s3Config } = await resolveS3ConfigAndInput(Amplify, downloadDataOptions);
-    const finalKey = keyPrefix + key;
-    logger.debug(`download ${key} from ${finalKey}.`);
+}
+const downloadDataJob = (downloadDataInput, abortSignal) => async () => {
+    const { options: downloadDataOptions } = downloadDataInput;
+    const { bucket, keyPrefix, s3Config, identityId } = await resolveS3ConfigAndInput(Amplify, downloadDataOptions);
+    const { inputType, objectKey } = validateStorageOperationInput(downloadDataInput, identityId);
+    const finalKey = inputType === STORAGE_INPUT_KEY ? keyPrefix + objectKey : objectKey;
+    logger.debug(`download ${objectKey} from ${finalKey}.`);
     const { Body: body, LastModified: lastModified, ContentLength: size, ETag: eTag, Metadata: metadata, VersionId: versionId, ContentType: contentType, } = await getObject({
         ...s3Config,
         abortSignal,
@@ -82,8 +56,7 @@ const downloadDataJob = ({ options: downloadDataOptions, key }, abortSignal) =>
             Range: `bytes=${downloadDataOptions.bytesRange.start}-${downloadDataOptions.bytesRange.end}`,
         }),
     });
-    return {
-        key,
+    const result = {
         body,
         lastModified,
         size,
@@ -92,6 +65,9 @@ const downloadDataJob = ({ options: downloadDataOptions, key }, abortSignal) =>
         metadata,
         versionId,
     };
+    return inputType === STORAGE_INPUT_KEY
+        ? { key: objectKey, ...result }
+        : { path: objectKey, ...result };
 };
 
 export { downloadData };

package/dist/esm/providers/s3/apis/downloadData.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"downloadData.mjs","sources":["../../../../../src/providers/s3/apis/downloadData.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { Amplify } from '@aws-amplify/core';\nimport { StorageAction } from '@aws-amplify/core/internals/utils';\nimport { resolveS3ConfigAndInput } from '../utils/resolveS3ConfigAndInput';\nimport { createDownloadTask } from '../utils';\nimport { getObject } from '../utils/client';\nimport { getStorageUserAgentValue } from '../utils/userAgent';\nimport { logger } from '../../../utils';\n/**\n * Download S3 object data to memory\n *\n * @param input - The DownloadDataInput object.\n * @returns A cancelable task exposing result promise from `result` property.\n * @throws service: {@link S3Exception} - thrown when checking for existence of the object\n * @throws validation: {@link StorageValidationErrorCode } - Validation errors\n *\n * @example\n * ```ts\n * // Download a file from s3 bucket\n * const { body, eTag } = await downloadData({ key, data: file, options: {\n *   onProgress, // Optional progress callback.\n * } }).result;\n * ```\n * @example\n * ```ts\n * // Cancel a task\n * const downloadTask = downloadData({ key, data: file });\n * //...\n * downloadTask.cancel();\n * try {\n * \tawait downloadTask.result;\n * } catch (error) {\n * \tif(isCancelError(error)) {\n *    // Handle error thrown by task cancelation.\n * \t}\n * }\n *```\n */\nexport const downloadData = (input) => {\n    const abortController = new AbortController();\n    const downloadTask = createDownloadTask({\n        job: downloadDataJob(input, abortController.signal),\n        onCancel: (message) => {\n            abortController.abort(message);\n        },\n    });\n    return downloadTask;\n};\nconst downloadDataJob = ({ options: downloadDataOptions, key }, abortSignal) => async () => {\n    const { bucket, keyPrefix, s3Config } = await resolveS3ConfigAndInput(Amplify, downloadDataOptions);\n    const finalKey = keyPrefix + key;\n    logger.debug(`download ${key} from ${finalKey}.`);\n    const { Body: body, LastModified: lastModified, ContentLength: size, ETag: eTag, Metadata: metadata, VersionId: versionId, ContentType: contentType, } = await getObject({\n        ...s3Config,\n        abortSignal,\n        onDownloadProgress: downloadDataOptions?.onProgress,\n        userAgentValue: getStorageUserAgentValue(StorageAction.DownloadData),\n    }, {\n        Bucket: bucket,\n        Key: finalKey,\n        ...(downloadDataOptions?.bytesRange && {\n            Range: `bytes=${downloadDataOptions.bytesRange.start}-${downloadDataOptions.bytesRange.end}`,\n        }),\n    });\n    return {\n        key,\n        body,\n        lastModified,\n        size,\n        contentType,\n        eTag,\n        metadata,\n        versionId,\n    };\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AACA;AAQA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,YAAY,GAAG,CAAC,KAAK,KAAK;AACvC,IAAI,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;AAClD,IAAI,MAAM,YAAY,GAAG,kBAAkB,CAAC;AAC5C,QAAQ,GAAG,EAAE,eAAe,CAAC,KAAK,EAAE,eAAe,CAAC,MAAM,CAAC;AAC3D,QAAQ,QAAQ,EAAE,CAAC,OAAO,KAAK;AAC/B,YAAY,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC3C,SAAS;AACT,KAAK,CAAC,CAAC;AACP,IAAI,OAAO,YAAY,CAAC;AACxB,EAAE;AACF,MAAM,eAAe,GAAG,CAAC,EAAE,OAAO,EAAE,mBAAmB,EAAE,GAAG,EAAE,EAAE,WAAW,KAAK,YAAY;AAC5F,IAAI,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,MAAM,uBAAuB,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;AACxG,IAAI,MAAM,QAAQ,GAAG,SAAS,GAAG,GAAG,CAAC;AACrC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AACtD,IAAI,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,WAAW,GAAG,GAAG,MAAM,SAAS,CAAC;AAC7K,QAAQ,GAAG,QAAQ;AACnB,QAAQ,WAAW;AACnB,QAAQ,kBAAkB,EAAE,mBAAmB,EAAE,UAAU;AAC3D,QAAQ,cAAc,EAAE,wBAAwB,CAAC,aAAa,CAAC,YAAY,CAAC;AAC5E,KAAK,EAAE;AACP,QAAQ,MAAM,EAAE,MAAM;AACtB,QAAQ,GAAG,EAAE,QAAQ;AACrB,QAAQ,IAAI,mBAAmB,EAAE,UAAU,IAAI;AAC/C,YAAY,KAAK,EAAE,CAAC,MAAM,EAAE,mBAAmB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;AACxG,SAAS;AACT,KAAK,CAAC,CAAC;AACP,IAAI,OAAO;AACX,QAAQ,GAAG;AACX,QAAQ,IAAI;AACZ,QAAQ,YAAY;AACpB,QAAQ,IAAI;AACZ,QAAQ,WAAW;AACnB,QAAQ,IAAI;AACZ,QAAQ,QAAQ;AAChB,QAAQ,SAAS;AACjB,KAAK,CAAC;AACN,CAAC;;;;"}
+{"version":3,"file":"downloadData.mjs","sources":["../../../../../src/providers/s3/apis/downloadData.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { Amplify } from '@aws-amplify/core';\nimport { StorageAction } from '@aws-amplify/core/internals/utils';\nimport { resolveS3ConfigAndInput } from '../utils/resolveS3ConfigAndInput';\nimport { createDownloadTask, validateStorageOperationInput } from '../utils';\nimport { getObject } from '../utils/client';\nimport { getStorageUserAgentValue } from '../utils/userAgent';\nimport { logger } from '../../../utils';\nimport { STORAGE_INPUT_KEY } from '../utils/constants';\nexport function downloadData(input) {\n    const abortController = new AbortController();\n    const downloadTask = createDownloadTask({\n        job: downloadDataJob(input, abortController.signal),\n        onCancel: (message) => {\n            abortController.abort(message);\n        },\n    });\n    return downloadTask;\n}\nconst downloadDataJob = (downloadDataInput, abortSignal) => async () => {\n    const { options: downloadDataOptions } = downloadDataInput;\n    const { bucket, keyPrefix, s3Config, identityId } = await resolveS3ConfigAndInput(Amplify, downloadDataOptions);\n    const { inputType, objectKey } = validateStorageOperationInput(downloadDataInput, identityId);\n    const finalKey = inputType === STORAGE_INPUT_KEY ? keyPrefix + objectKey : objectKey;\n    logger.debug(`download ${objectKey} from ${finalKey}.`);\n    const { Body: body, LastModified: lastModified, ContentLength: size, ETag: eTag, Metadata: metadata, VersionId: versionId, ContentType: contentType, } = await getObject({\n        ...s3Config,\n        abortSignal,\n        onDownloadProgress: downloadDataOptions?.onProgress,\n        userAgentValue: getStorageUserAgentValue(StorageAction.DownloadData),\n    }, {\n        Bucket: bucket,\n        Key: finalKey,\n        ...(downloadDataOptions?.bytesRange && {\n            Range: `bytes=${downloadDataOptions.bytesRange.start}-${downloadDataOptions.bytesRange.end}`,\n        }),\n    });\n    const result = {\n        body,\n        lastModified,\n        size,\n        contentType,\n        eTag,\n        metadata,\n        versionId,\n    };\n    return inputType === STORAGE_INPUT_KEY\n        ? { key: objectKey, ...result }\n        : { path: objectKey, ...result };\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AACA;AASO,SAAS,YAAY,CAAC,KAAK,EAAE;AACpC,IAAI,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;AAClD,IAAI,MAAM,YAAY,GAAG,kBAAkB,CAAC;AAC5C,QAAQ,GAAG,EAAE,eAAe,CAAC,KAAK,EAAE,eAAe,CAAC,MAAM,CAAC;AAC3D,QAAQ,QAAQ,EAAE,CAAC,OAAO,KAAK;AAC/B,YAAY,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC3C,SAAS;AACT,KAAK,CAAC,CAAC;AACP,IAAI,OAAO,YAAY,CAAC;AACxB,CAAC;AACD,MAAM,eAAe,GAAG,CAAC,iBAAiB,EAAE,WAAW,KAAK,YAAY;AACxE,IAAI,MAAM,EAAE,OAAO,EAAE,mBAAmB,EAAE,GAAG,iBAAiB,CAAC;AAC/D,IAAI,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,MAAM,uBAAuB,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;AACpH,IAAI,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,6BAA6B,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAC;AAClG,IAAI,MAAM,QAAQ,GAAG,SAAS,KAAK,iBAAiB,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;AACzF,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5D,IAAI,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,WAAW,GAAG,GAAG,MAAM,SAAS,CAAC;AAC7K,QAAQ,GAAG,QAAQ;AACnB,QAAQ,WAAW;AACnB,QAAQ,kBAAkB,EAAE,mBAAmB,EAAE,UAAU;AAC3D,QAAQ,cAAc,EAAE,wBAAwB,CAAC,aAAa,CAAC,YAAY,CAAC;AAC5E,KAAK,EAAE;AACP,QAAQ,MAAM,EAAE,MAAM;AACtB,QAAQ,GAAG,EAAE,QAAQ;AACrB,QAAQ,IAAI,mBAAmB,EAAE,UAAU,IAAI;AAC/C,YAAY,KAAK,EAAE,CAAC,MAAM,EAAE,mBAAmB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;AACxG,SAAS;AACT,KAAK,CAAC,CAAC;AACP,IAAI,MAAM,MAAM,GAAG;AACnB,QAAQ,IAAI;AACZ,QAAQ,YAAY;AACpB,QAAQ,IAAI;AACZ,QAAQ,WAAW;AACnB,QAAQ,IAAI;AACZ,QAAQ,QAAQ;AAChB,QAAQ,SAAS;AACjB,KAAK,CAAC;AACN,IAAI,OAAO,SAAS,KAAK,iBAAiB;AAC1C,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,EAAE;AACvC,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,EAAE,CAAC;AACzC,CAAC;;;;"}

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

@@ -1,11 +1,24 @@
-import { GetPropertiesInput, GetPropertiesOutput } from '../types';
+import { GetPropertiesInput, GetPropertiesOutput, GetPropertiesWithPathInput, GetPropertiesWithPathOutput } from '../types';
 /**
  * Gets the properties of a file. The properties include S3 system metadata and
  * the user metadata that was provided when uploading the file.
  *
- * @param input - The GetPropertiesInput object.
+ * @param input - The `GetPropertiesWithPathInput` object.
  * @returns Requested object properties.
- * @throws A {@link S3Exception} when the underlying S3 service returned error.
- * @throws A {@link StorageValidationErrorCode} when API call parameters are invalid.
+ * @throws An `S3Exception` when the underlying S3 service returned error.
+ * @throws A `StorageValidationErrorCode` when API call parameters are invalid.
  */
-export declare const getProperties: (input: GetPropertiesInput) => Promise<GetPropertiesOutput>;
+export declare function getProperties(input: GetPropertiesWithPathInput): Promise<GetPropertiesWithPathOutput>;
+/**
+ * @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 input - The `GetPropertiesInput` object.
+ * @returns Requested object properties.
+ * @throws An `S3Exception` when the underlying S3 service returned error.
+ * @throws A `StorageValidationErrorCode` when API call parameters are invalid.
+ */
+export declare function getProperties(input: GetPropertiesInput): Promise<GetPropertiesOutput>;

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

@@ -3,18 +3,9 @@ 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
-/**
- * Gets the properties of a file. The properties include S3 system metadata and
- * the user metadata that was provided when uploading the file.
- *
- * @param input - The GetPropertiesInput object.
- * @returns Requested object properties.
- * @throws A {@link S3Exception} when the underlying S3 service returned error.
- * @throws A {@link StorageValidationErrorCode} when API call parameters are invalid.
- */
-const getProperties = (input) => {
+function getProperties(input) {
     return getProperties$1(Amplify, input);
-};
+}
 
 export { getProperties };
 //# sourceMappingURL=getProperties.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"getProperties.mjs","sources":["../../../../../src/providers/s3/apis/getProperties.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { Amplify } from '@aws-amplify/core';\nimport { getProperties as getPropertiesInternal } from './internal/getProperties';\n/**\n * Gets the properties of a file. The properties include S3 system metadata and\n * the user metadata that was provided when uploading the file.\n *\n * @param input - The GetPropertiesInput object.\n * @returns Requested object properties.\n * @throws A {@link S3Exception} when the underlying S3 service returned error.\n * @throws A {@link StorageValidationErrorCode} when API call parameters are invalid.\n */\nexport const getProperties = (input) => {\n    return getPropertiesInternal(Amplify, input);\n};\n"],"names":["getPropertiesInternal"],"mappings":";;;AAAA;AACA;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,aAAa,GAAG,CAAC,KAAK,KAAK;AACxC,IAAI,OAAOA,eAAqB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AACjD;;;;"}
+{"version":3,"file":"getProperties.mjs","sources":["../../../../../src/providers/s3/apis/getProperties.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { Amplify } from '@aws-amplify/core';\nimport { getProperties as getPropertiesInternal } from './internal/getProperties';\nexport function getProperties(input) {\n    return getPropertiesInternal(Amplify, input);\n}\n"],"names":["getPropertiesInternal"],"mappings":";;;AAAA;AACA;AAGO,SAAS,aAAa,CAAC,KAAK,EAAE;AACrC,IAAI,OAAOA,eAAqB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AACjD;;;;"}

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

@@ -1,4 +1,4 @@
-import { GetUrlInput, GetUrlOutput } from '../types';
+import { GetUrlInput, GetUrlOutput, GetUrlWithPathInput, GetUrlWithPathOutput } from '../types';
 /**
  * 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
@@ -6,13 +6,33 @@ import { GetUrlInput, GetUrlOutput } from '../types';
  *
  * 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 {@link StorageError} if the object does not exist.
+ * URL, and will throw `StorageError` if the object does not exist.
  *
- * @param input - The GetUrlInput object.
- * @returns Presigned URL and timestamp when the URL MAY expire.
- * @throws service: {@link S3Exception} - thrown when checking for existence of the object
- * @throws validation: {@link StorageValidationErrorCode } - Validation errors
+ * @param input - The `GetUrlWithPathInput` 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.
  *
  */
-export declare const getUrl: (input: GetUrlInput) => Promise<GetUrlOutput>;
+export declare function getUrl(input: GetUrlWithPathInput): Promise<GetUrlWithPathOutput>;
+/**
+ * @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 input - The `GetUrlInput` 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.
+ *
+ */
+export declare function getUrl(input: GetUrlInput): Promise<GetUrlOutput>;

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

@@ -3,25 +3,9 @@ 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
-/**
- * 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 {@link StorageError} if the object does not exist.
- *
- * @param input - The GetUrlInput object.
- * @returns Presigned URL and timestamp when the URL MAY expire.
- * @throws service: {@link S3Exception} - thrown when checking for existence of the object
- * @throws validation: {@link StorageValidationErrorCode } - Validation errors
- * thrown either username or key are not defined.
- *
- */
-const getUrl = (input) => {
+function getUrl(input) {
     return getUrl$1(Amplify, input);
-};
+}
 
 export { getUrl };
 //# sourceMappingURL=getUrl.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"getUrl.mjs","sources":["../../../../../src/providers/s3/apis/getUrl.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { Amplify } from '@aws-amplify/core';\nimport { getUrl as getUrlInternal } from './internal/getUrl';\n/**\n * Get a temporary presigned URL to download the specified S3 object.\n * The presigned URL expires when the associated role used to sign the request expires or\n * the option  `expiresIn` is reached. The `expiresAt` property in the output object indicates when the URL MAY expire.\n *\n * By default, it will not validate the object that exists in S3. If you set the `options.validateObjectExistence`\n * to true, this method will verify the given object already exists in S3 before returning a presigned\n * URL, and will throw {@link StorageError} if the object does not exist.\n *\n * @param input - The GetUrlInput object.\n * @returns Presigned URL and timestamp when the URL MAY expire.\n * @throws service: {@link S3Exception} - thrown when checking for existence of the object\n * @throws validation: {@link StorageValidationErrorCode } - Validation errors\n * thrown either username or key are not defined.\n *\n */\nexport const getUrl = (input) => {\n    return getUrlInternal(Amplify, input);\n};\n"],"names":["getUrlInternal"],"mappings":";;;AAAA;AACA;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,MAAM,GAAG,CAAC,KAAK,KAAK;AACjC,IAAI,OAAOA,QAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAC1C;;;;"}
+{"version":3,"file":"getUrl.mjs","sources":["../../../../../src/providers/s3/apis/getUrl.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { Amplify } from '@aws-amplify/core';\nimport { getUrl as getUrlInternal } from './internal/getUrl';\nexport function getUrl(input) {\n    return getUrlInternal(Amplify, input);\n}\n"],"names":["getUrlInternal"],"mappings":";;;AAAA;AACA;AAGO,SAAS,MAAM,CAAC,KAAK,EAAE;AAC9B,IAAI,OAAOA,QAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAC1C;;;;"}

package/dist/esm/providers/s3/apis/internal/copy.d.ts

@@ -1,3 +1,5 @@
 import { AmplifyClassV6 } from '@aws-amplify/core';
-import { CopyInput, CopyOutput } from '../../types';
-export declare const copy: (amplify: AmplifyClassV6, input: CopyInput) => Promise<CopyOutput>;
+import { CopyInput, CopyOutput, CopyWithPathInput, CopyWithPathOutput } from '../../types';
+export declare const copy: (amplify: AmplifyClassV6, input: CopyInput | CopyWithPathInput) => Promise<CopyOutput | CopyWithPathOutput>;
+/** @deprecated Use {@link copyWithPath} instead. */
+export declare const copyWithKey: (amplify: AmplifyClassV6, input: CopyInput) => Promise<CopyOutput>;

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

@@ -9,6 +9,8 @@ import { resolveS3ConfigAndInput } from '../../utils/resolveS3ConfigAndInput.mjs
 import { assertValidationError } from '../../../../errors/utils/assertValidationError.mjs';
 import { StorageValidationErrorCode } from '../../../../errors/types/validation.mjs';
 import { logger } from '../../../../utils/logger.mjs';
+import { validateStorageOperationInput } from '../../utils/validateStorageOperationInput.mjs';
+import { isInputWithPath } from '../../utils/isInputWithPath.mjs';
 import '../../utils/client/base.mjs';
 import '../../utils/client/getObject.mjs';
 import '../../utils/client/listObjectsV2.mjs';
@@ -25,7 +27,32 @@ import { getStorageUserAgentValue } from '../../utils/userAgent.mjs';
 
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+const isCopyInputWithPath = (input) => isInputWithPath(input.source);
 const copy = async (amplify, input) => {
+    return isCopyInputWithPath(input)
+        ? copyWithPath(amplify, input)
+        : copyWithKey(amplify, input);
+};
+const copyWithPath = async (amplify, input) => {
+    const { source, destination } = input;
+    const { s3Config, bucket, identityId } = await resolveS3ConfigAndInput(amplify);
+    assertValidationError(!!source.path, StorageValidationErrorCode.NoSourcePath);
+    assertValidationError(!!destination.path, StorageValidationErrorCode.NoDestinationPath);
+    const { objectKey: sourcePath } = validateStorageOperationInput(source, identityId);
+    const { objectKey: destinationPath } = validateStorageOperationInput(destination, identityId);
+    const finalCopySource = `${bucket}/${sourcePath}`;
+    const finalCopyDestination = destinationPath;
+    logger.debug(`copying "${finalCopySource}" to "${finalCopyDestination}".`);
+    await serviceCopy({
+        source: finalCopySource,
+        destination: finalCopyDestination,
+        bucket,
+        s3Config,
+    });
+    return { path: finalCopyDestination };
+};
+/** @deprecated Use {@link copyWithPath} instead. */
+const copyWithKey = async (amplify, input) => {
     const { source: { key: sourceKey }, destination: { key: destinationKey }, } = input;
     assertValidationError(!!sourceKey, StorageValidationErrorCode.NoSourceKey);
     assertValidationError(!!destinationKey, StorageValidationErrorCode.NoDestinationKey);
@@ -35,19 +62,27 @@ const copy = async (amplify, input) => {
     const finalCopySource = `${bucket}/${sourceKeyPrefix}${sourceKey}`;
     const finalCopyDestination = `${destinationKeyPrefix}${destinationKey}`;
     logger.debug(`copying "${finalCopySource}" to "${finalCopyDestination}".`);
+    await serviceCopy({
+        source: finalCopySource,
+        destination: finalCopyDestination,
+        bucket,
+        s3Config,
+    });
+    return {
+        key: destinationKey,
+    };
+};
+const serviceCopy = async ({ source, destination, bucket, s3Config, }) => {
     await copyObject({
         ...s3Config,
         userAgentValue: getStorageUserAgentValue(StorageAction.Copy),
     }, {
         Bucket: bucket,
-        CopySource: finalCopySource,
-        Key: finalCopyDestination,
+        CopySource: source,
+        Key: destination,
         MetadataDirective: 'COPY', // Copies over metadata like contentType as well
     });
-    return {
-        key: destinationKey,
-    };
 };
 
-export { copy };
+export { copy, copyWithKey };
 //# sourceMappingURL=copy.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"copy.mjs","sources":["../../../../../../src/providers/s3/apis/internal/copy.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { StorageAction } from '@aws-amplify/core/internals/utils';\nimport { resolveS3ConfigAndInput } from '../../utils';\nimport { StorageValidationErrorCode } from '../../../../errors/types/validation';\nimport { assertValidationError } from '../../../../errors/utils/assertValidationError';\nimport { copyObject } from '../../utils/client';\nimport { getStorageUserAgentValue } from '../../utils/userAgent';\nimport { logger } from '../../../../utils';\nexport const copy = async (amplify, input) => {\n    const { source: { key: sourceKey }, destination: { key: destinationKey }, } = input;\n    assertValidationError(!!sourceKey, StorageValidationErrorCode.NoSourceKey);\n    assertValidationError(!!destinationKey, StorageValidationErrorCode.NoDestinationKey);\n    const { s3Config, bucket, keyPrefix: sourceKeyPrefix, } = await resolveS3ConfigAndInput(amplify, input.source);\n    const { keyPrefix: destinationKeyPrefix } = await resolveS3ConfigAndInput(amplify, input.destination); // resolveS3ConfigAndInput does not make extra API calls or storage access if called repeatedly.\n    // TODO(ashwinkumar6) V6-logger: warn `You may copy files from another user if the source level is \"protected\", currently it's ${srcLevel}`\n    const finalCopySource = `${bucket}/${sourceKeyPrefix}${sourceKey}`;\n    const finalCopyDestination = `${destinationKeyPrefix}${destinationKey}`;\n    logger.debug(`copying \"${finalCopySource}\" to \"${finalCopyDestination}\".`);\n    await copyObject({\n        ...s3Config,\n        userAgentValue: getStorageUserAgentValue(StorageAction.Copy),\n    }, {\n        Bucket: bucket,\n        CopySource: finalCopySource,\n        Key: finalCopyDestination,\n        MetadataDirective: 'COPY', // Copies over metadata like contentType as well\n    });\n    return {\n        key: destinationKey,\n    };\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AACA;AAQY,MAAC,IAAI,GAAG,OAAO,OAAO,EAAE,KAAK,KAAK;AAC9C,IAAI,MAAM,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE,WAAW,EAAE,EAAE,GAAG,EAAE,cAAc,EAAE,GAAG,GAAG,KAAK,CAAC;AACxF,IAAI,qBAAqB,CAAC,CAAC,CAAC,SAAS,EAAE,0BAA0B,CAAC,WAAW,CAAC,CAAC;AAC/E,IAAI,qBAAqB,CAAC,CAAC,CAAC,cAAc,EAAE,0BAA0B,CAAC,gBAAgB,CAAC,CAAC;AACzF,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,eAAe,GAAG,GAAG,MAAM,uBAAuB,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;AACnH,IAAI,MAAM,EAAE,SAAS,EAAE,oBAAoB,EAAE,GAAG,MAAM,uBAAuB,CAAC,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;AAC1G;AACA,IAAI,MAAM,eAAe,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,eAAe,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;AACvE,IAAI,MAAM,oBAAoB,GAAG,CAAC,EAAE,oBAAoB,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC;AAC5E,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,eAAe,CAAC,MAAM,EAAE,oBAAoB,CAAC,EAAE,CAAC,CAAC,CAAC;AAC/E,IAAI,MAAM,UAAU,CAAC;AACrB,QAAQ,GAAG,QAAQ;AACnB,QAAQ,cAAc,EAAE,wBAAwB,CAAC,aAAa,CAAC,IAAI,CAAC;AACpE,KAAK,EAAE;AACP,QAAQ,MAAM,EAAE,MAAM;AACtB,QAAQ,UAAU,EAAE,eAAe;AACnC,QAAQ,GAAG,EAAE,oBAAoB;AACjC,QAAQ,iBAAiB,EAAE,MAAM;AACjC,KAAK,CAAC,CAAC;AACP,IAAI,OAAO;AACX,QAAQ,GAAG,EAAE,cAAc;AAC3B,KAAK,CAAC;AACN;;;;"}
+{"version":3,"file":"copy.mjs","sources":["../../../../../../src/providers/s3/apis/internal/copy.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { StorageAction } from '@aws-amplify/core/internals/utils';\nimport { isInputWithPath, resolveS3ConfigAndInput, validateStorageOperationInput, } from '../../utils';\nimport { StorageValidationErrorCode } from '../../../../errors/types/validation';\nimport { assertValidationError } from '../../../../errors/utils/assertValidationError';\nimport { copyObject } from '../../utils/client';\nimport { getStorageUserAgentValue } from '../../utils/userAgent';\nimport { logger } from '../../../../utils';\nconst isCopyInputWithPath = (input) => isInputWithPath(input.source);\nexport const copy = async (amplify, input) => {\n    return isCopyInputWithPath(input)\n        ? copyWithPath(amplify, input)\n        : copyWithKey(amplify, input);\n};\nconst copyWithPath = async (amplify, input) => {\n    const { source, destination } = input;\n    const { s3Config, bucket, identityId } = await resolveS3ConfigAndInput(amplify);\n    assertValidationError(!!source.path, StorageValidationErrorCode.NoSourcePath);\n    assertValidationError(!!destination.path, StorageValidationErrorCode.NoDestinationPath);\n    const { objectKey: sourcePath } = validateStorageOperationInput(source, identityId);\n    const { objectKey: destinationPath } = validateStorageOperationInput(destination, identityId);\n    const finalCopySource = `${bucket}/${sourcePath}`;\n    const finalCopyDestination = destinationPath;\n    logger.debug(`copying \"${finalCopySource}\" to \"${finalCopyDestination}\".`);\n    await serviceCopy({\n        source: finalCopySource,\n        destination: finalCopyDestination,\n        bucket,\n        s3Config,\n    });\n    return { path: finalCopyDestination };\n};\n/** @deprecated Use {@link copyWithPath} instead. */\nexport const copyWithKey = async (amplify, input) => {\n    const { source: { key: sourceKey }, destination: { key: destinationKey }, } = input;\n    assertValidationError(!!sourceKey, StorageValidationErrorCode.NoSourceKey);\n    assertValidationError(!!destinationKey, StorageValidationErrorCode.NoDestinationKey);\n    const { s3Config, bucket, keyPrefix: sourceKeyPrefix, } = await resolveS3ConfigAndInput(amplify, input.source);\n    const { keyPrefix: destinationKeyPrefix } = await resolveS3ConfigAndInput(amplify, input.destination); // resolveS3ConfigAndInput does not make extra API calls or storage access if called repeatedly.\n    // TODO(ashwinkumar6) V6-logger: warn `You may copy files from another user if the source level is \"protected\", currently it's ${srcLevel}`\n    const finalCopySource = `${bucket}/${sourceKeyPrefix}${sourceKey}`;\n    const finalCopyDestination = `${destinationKeyPrefix}${destinationKey}`;\n    logger.debug(`copying \"${finalCopySource}\" to \"${finalCopyDestination}\".`);\n    await serviceCopy({\n        source: finalCopySource,\n        destination: finalCopyDestination,\n        bucket,\n        s3Config,\n    });\n    return {\n        key: destinationKey,\n    };\n};\nconst serviceCopy = async ({ source, destination, bucket, s3Config, }) => {\n    await copyObject({\n        ...s3Config,\n        userAgentValue: getStorageUserAgentValue(StorageAction.Copy),\n    }, {\n        Bucket: bucket,\n        CopySource: source,\n        Key: destination,\n        MetadataDirective: 'COPY', // Copies over metadata like contentType as well\n    });\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AACA;AAQA,MAAM,mBAAmB,GAAG,CAAC,KAAK,KAAK,eAAe,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AACzD,MAAC,IAAI,GAAG,OAAO,OAAO,EAAE,KAAK,KAAK;AAC9C,IAAI,OAAO,mBAAmB,CAAC,KAAK,CAAC;AACrC,UAAU,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC;AACtC,UAAU,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AACtC,EAAE;AACF,MAAM,YAAY,GAAG,OAAO,OAAO,EAAE,KAAK,KAAK;AAC/C,IAAI,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC;AAC1C,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,uBAAuB,CAAC,OAAO,CAAC,CAAC;AACpF,IAAI,qBAAqB,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,0BAA0B,CAAC,YAAY,CAAC,CAAC;AAClF,IAAI,qBAAqB,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,0BAA0B,CAAC,iBAAiB,CAAC,CAAC;AAC5F,IAAI,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,6BAA6B,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AACxF,IAAI,MAAM,EAAE,SAAS,EAAE,eAAe,EAAE,GAAG,6BAA6B,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;AAClG,IAAI,MAAM,eAAe,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC;AACtD,IAAI,MAAM,oBAAoB,GAAG,eAAe,CAAC;AACjD,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,eAAe,CAAC,MAAM,EAAE,oBAAoB,CAAC,EAAE,CAAC,CAAC,CAAC;AAC/E,IAAI,MAAM,WAAW,CAAC;AACtB,QAAQ,MAAM,EAAE,eAAe;AAC/B,QAAQ,WAAW,EAAE,oBAAoB;AACzC,QAAQ,MAAM;AACd,QAAQ,QAAQ;AAChB,KAAK,CAAC,CAAC;AACP,IAAI,OAAO,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;AAC1C,CAAC,CAAC;AACF;AACY,MAAC,WAAW,GAAG,OAAO,OAAO,EAAE,KAAK,KAAK;AACrD,IAAI,MAAM,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE,WAAW,EAAE,EAAE,GAAG,EAAE,cAAc,EAAE,GAAG,GAAG,KAAK,CAAC;AACxF,IAAI,qBAAqB,CAAC,CAAC,CAAC,SAAS,EAAE,0BAA0B,CAAC,WAAW,CAAC,CAAC;AAC/E,IAAI,qBAAqB,CAAC,CAAC,CAAC,cAAc,EAAE,0BAA0B,CAAC,gBAAgB,CAAC,CAAC;AACzF,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,eAAe,GAAG,GAAG,MAAM,uBAAuB,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;AACnH,IAAI,MAAM,EAAE,SAAS,EAAE,oBAAoB,EAAE,GAAG,MAAM,uBAAuB,CAAC,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;AAC1G;AACA,IAAI,MAAM,eAAe,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,eAAe,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;AACvE,IAAI,MAAM,oBAAoB,GAAG,CAAC,EAAE,oBAAoB,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC;AAC5E,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,eAAe,CAAC,MAAM,EAAE,oBAAoB,CAAC,EAAE,CAAC,CAAC,CAAC;AAC/E,IAAI,MAAM,WAAW,CAAC;AACtB,QAAQ,MAAM,EAAE,eAAe;AAC/B,QAAQ,WAAW,EAAE,oBAAoB;AACzC,QAAQ,MAAM;AACd,QAAQ,QAAQ;AAChB,KAAK,CAAC,CAAC;AACP,IAAI,OAAO;AACX,QAAQ,GAAG,EAAE,cAAc;AAC3B,KAAK,CAAC;AACN,EAAE;AACF,MAAM,WAAW,GAAG,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,GAAG,KAAK;AAC1E,IAAI,MAAM,UAAU,CAAC;AACrB,QAAQ,GAAG,QAAQ;AACnB,QAAQ,cAAc,EAAE,wBAAwB,CAAC,aAAa,CAAC,IAAI,CAAC;AACpE,KAAK,EAAE;AACP,QAAQ,MAAM,EAAE,MAAM;AACtB,QAAQ,UAAU,EAAE,MAAM;AAC1B,QAAQ,GAAG,EAAE,WAAW;AACxB,QAAQ,iBAAiB,EAAE,MAAM;AACjC,KAAK,CAAC,CAAC;AACP,CAAC;;;;"}

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

@@ -1,4 +1,4 @@
 import { AmplifyClassV6 } from '@aws-amplify/core';
 import { StorageAction } from '@aws-amplify/core/internals/utils';
-import { GetPropertiesInput, GetPropertiesOutput } from '../../types';
-export declare const getProperties: (amplify: AmplifyClassV6, input: GetPropertiesInput, action?: StorageAction) => Promise<GetPropertiesOutput>;
+import { GetPropertiesInput, GetPropertiesOutput, GetPropertiesWithPathInput, GetPropertiesWithPathOutput } from '../../types';
+export declare const getProperties: (amplify: AmplifyClassV6, input: GetPropertiesInput | GetPropertiesWithPathInput, action?: StorageAction) => Promise<GetPropertiesOutput | GetPropertiesWithPathOutput>;

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

@@ -8,6 +8,8 @@ import 'buffer';
 import { resolveS3ConfigAndInput } from '../../utils/resolveS3ConfigAndInput.mjs';
 import '../../../../errors/types/validation.mjs';
 import { logger } from '../../../../utils/logger.mjs';
+import { validateStorageOperationInput } from '../../utils/validateStorageOperationInput.mjs';
+import { STORAGE_INPUT_KEY } from '../../utils/constants.mjs';
 import '../../utils/client/base.mjs';
 import '../../utils/client/getObject.mjs';
 import '../../utils/client/listObjectsV2.mjs';
@@ -25,10 +27,11 @@ import { getStorageUserAgentValue } from '../../utils/userAgent.mjs';
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 const getProperties = async (amplify, input, action) => {
-    const { key, options } = input;
-    const { s3Config, bucket, keyPrefix } = await resolveS3ConfigAndInput(amplify, options);
-    const finalKey = `${keyPrefix}${key}`;
-    logger.debug(`get properties of ${key} from ${finalKey}`);
+    const { options: getPropertiesOptions } = input;
+    const { s3Config, bucket, keyPrefix, identityId } = await resolveS3ConfigAndInput(amplify, getPropertiesOptions);
+    const { inputType, objectKey } = validateStorageOperationInput(input, identityId);
+    const finalKey = inputType === STORAGE_INPUT_KEY ? keyPrefix + objectKey : objectKey;
+    logger.debug(`get properties of ${objectKey} from ${finalKey}`);
     const response = await headObject({
         ...s3Config,
         userAgentValue: getStorageUserAgentValue(action ?? StorageAction.GetProperties),
@@ -36,8 +39,7 @@ const getProperties = async (amplify, input, action) => {
         Bucket: bucket,
         Key: finalKey,
     });
-    return {
-        key,
+    const result = {
         contentType: response.ContentType,
         size: response.ContentLength,
         eTag: response.ETag,
@@ -45,6 +47,9 @@ const getProperties = async (amplify, input, action) => {
         metadata: response.Metadata,
         versionId: response.VersionId,
     };
+    return inputType === STORAGE_INPUT_KEY
+        ? { key: objectKey, ...result }
+        : { path: objectKey, ...result };
 };
 
 export { getProperties };

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

@@ -1 +1 @@
-{"version":3,"file":"getProperties.mjs","sources":["../../../../../../src/providers/s3/apis/internal/getProperties.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { StorageAction } from '@aws-amplify/core/internals/utils';\nimport { resolveS3ConfigAndInput } from '../../utils';\nimport { headObject } from '../../utils/client';\nimport { getStorageUserAgentValue } from '../../utils/userAgent';\nimport { logger } from '../../../../utils';\nexport const getProperties = async (amplify, input, action) => {\n    const { key, options } = input;\n    const { s3Config, bucket, keyPrefix } = await resolveS3ConfigAndInput(amplify, options);\n    const finalKey = `${keyPrefix}${key}`;\n    logger.debug(`get properties of ${key} from ${finalKey}`);\n    const response = await headObject({\n        ...s3Config,\n        userAgentValue: getStorageUserAgentValue(action ?? StorageAction.GetProperties),\n    }, {\n        Bucket: bucket,\n        Key: finalKey,\n    });\n    return {\n        key,\n        contentType: response.ContentType,\n        size: response.ContentLength,\n        eTag: response.ETag,\n        lastModified: response.LastModified,\n        metadata: response.Metadata,\n        versionId: response.VersionId,\n    };\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA;AACA;AAMY,MAAC,aAAa,GAAG,OAAO,OAAO,EAAE,KAAK,EAAE,MAAM,KAAK;AAC/D,IAAI,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;AACnC,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AAC5F,IAAI,MAAM,QAAQ,GAAG,CAAC,EAAE,SAAS,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;AAC1C,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,kBAAkB,EAAE,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;AAC9D,IAAI,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC;AACtC,QAAQ,GAAG,QAAQ;AACnB,QAAQ,cAAc,EAAE,wBAAwB,CAAC,MAAM,IAAI,aAAa,CAAC,aAAa,CAAC;AACvF,KAAK,EAAE;AACP,QAAQ,MAAM,EAAE,MAAM;AACtB,QAAQ,GAAG,EAAE,QAAQ;AACrB,KAAK,CAAC,CAAC;AACP,IAAI,OAAO;AACX,QAAQ,GAAG;AACX,QAAQ,WAAW,EAAE,QAAQ,CAAC,WAAW;AACzC,QAAQ,IAAI,EAAE,QAAQ,CAAC,aAAa;AACpC,QAAQ,IAAI,EAAE,QAAQ,CAAC,IAAI;AAC3B,QAAQ,YAAY,EAAE,QAAQ,CAAC,YAAY;AAC3C,QAAQ,QAAQ,EAAE,QAAQ,CAAC,QAAQ;AACnC,QAAQ,SAAS,EAAE,QAAQ,CAAC,SAAS;AACrC,KAAK,CAAC;AACN;;;;"}
+{"version":3,"file":"getProperties.mjs","sources":["../../../../../../src/providers/s3/apis/internal/getProperties.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { StorageAction } from '@aws-amplify/core/internals/utils';\nimport { resolveS3ConfigAndInput, validateStorageOperationInput, } from '../../utils';\nimport { headObject } from '../../utils/client';\nimport { getStorageUserAgentValue } from '../../utils/userAgent';\nimport { logger } from '../../../../utils';\nimport { STORAGE_INPUT_KEY } from '../../utils/constants';\nexport const getProperties = async (amplify, input, action) => {\n    const { options: getPropertiesOptions } = input;\n    const { s3Config, bucket, keyPrefix, identityId } = await resolveS3ConfigAndInput(amplify, getPropertiesOptions);\n    const { inputType, objectKey } = validateStorageOperationInput(input, identityId);\n    const finalKey = inputType === STORAGE_INPUT_KEY ? keyPrefix + objectKey : objectKey;\n    logger.debug(`get properties of ${objectKey} from ${finalKey}`);\n    const response = await headObject({\n        ...s3Config,\n        userAgentValue: getStorageUserAgentValue(action ?? StorageAction.GetProperties),\n    }, {\n        Bucket: bucket,\n        Key: finalKey,\n    });\n    const result = {\n        contentType: response.ContentType,\n        size: response.ContentLength,\n        eTag: response.ETag,\n        lastModified: response.LastModified,\n        metadata: response.Metadata,\n        versionId: response.VersionId,\n    };\n    return inputType === STORAGE_INPUT_KEY\n        ? { key: objectKey, ...result }\n        : { path: objectKey, ...result };\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AACA;AAOY,MAAC,aAAa,GAAG,OAAO,OAAO,EAAE,KAAK,EAAE,MAAM,KAAK;AAC/D,IAAI,MAAM,EAAE,OAAO,EAAE,oBAAoB,EAAE,GAAG,KAAK,CAAC;AACpD,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,MAAM,uBAAuB,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;AACrH,IAAI,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,6BAA6B,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AACtF,IAAI,MAAM,QAAQ,GAAG,SAAS,KAAK,iBAAiB,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;AACzF,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,kBAAkB,EAAE,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;AACpE,IAAI,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC;AACtC,QAAQ,GAAG,QAAQ;AACnB,QAAQ,cAAc,EAAE,wBAAwB,CAAC,MAAM,IAAI,aAAa,CAAC,aAAa,CAAC;AACvF,KAAK,EAAE;AACP,QAAQ,MAAM,EAAE,MAAM;AACtB,QAAQ,GAAG,EAAE,QAAQ;AACrB,KAAK,CAAC,CAAC;AACP,IAAI,MAAM,MAAM,GAAG;AACnB,QAAQ,WAAW,EAAE,QAAQ,CAAC,WAAW;AACzC,QAAQ,IAAI,EAAE,QAAQ,CAAC,aAAa;AACpC,QAAQ,IAAI,EAAE,QAAQ,CAAC,IAAI;AAC3B,QAAQ,YAAY,EAAE,QAAQ,CAAC,YAAY;AAC3C,QAAQ,QAAQ,EAAE,QAAQ,CAAC,QAAQ;AACnC,QAAQ,SAAS,EAAE,QAAQ,CAAC,SAAS;AACrC,KAAK,CAAC;AACN,IAAI,OAAO,SAAS,KAAK,iBAAiB;AAC1C,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,EAAE;AACvC,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,EAAE,CAAC;AACzC;;;;"}