Support Tagging Directive in S3 Copy

[simon-vdk]

Is this related to a new or existing framework?

React

Is this related to a new or existing API?

Storage

Is this related to another service?

S3

Describe the feature you'd like to request

The storage API does not support the x-amz-tagging-directive header for the S3 copy. Supporting it would enable other issues depending on amplify-js, notably this one on S3 Storage browser

Describe the solution you'd like

Leave the option to use COPY or REPLACE for the tagging directive when copying object

Describe alternatives you've considered

Fork

Additional context

This issue on S3 Storage browser depends on the present issue

Is this something that you'd be interested in working on?

• 👋 I may be able to implement this feature request
• ⚠️ This feature might incur a breaking change

[simon-vdk]

Until resolution, and if that can help others, we got it to work for our needs (by default, use TaggingDirective: 'REPLACE' instead of COPY) using patch-package and the following patch file (works for @aws-amplify/storage version 6.9.3)

This could be a starting point for this issue resolution, however we should go further and add the option in the public interface (so storage browser could configure this as well, see linked issue)

diff --git a/node_modules/@aws-amplify/storage/dist/cjs/providers/s3/apis/internal/copy.js b/node_modules/@aws-amplify/storage/dist/cjs/providers/s3/apis/internal/copy.js
index ef41f96..f5eb299 100644
--- a/node_modules/@aws-amplify/storage/dist/cjs/providers/s3/apis/internal/copy.js
+++ b/node_modules/@aws-amplify/storage/dist/cjs/providers/s3/apis/internal/copy.js
@@ -125,6 +125,7 @@ const serviceCopy = async ({ source, destination, bucket, s3Config, notModifiedS
         CopySource: source,
         Key: destination,
         MetadataDirective: 'COPY', // Copies over metadata like contentType as well
+        TaggingDirective: 'REPLACE', // DOES NOT copy over tags; see https://github.com/aws-amplify/amplify-ui/issues/6621
         CopySourceIfMatch: eTag,
         CopySourceIfUnmodifiedSince: notModifiedSince,
         ExpectedSourceBucketOwner: expectedSourceBucketOwner,
diff --git a/node_modules/@aws-amplify/storage/dist/cjs/providers/s3/utils/client/s3data/copyObject.js b/node_modules/@aws-amplify/storage/dist/cjs/providers/s3/utils/client/s3data/copyObject.js
index 5011df3..2146991 100644
--- a/node_modules/@aws-amplify/storage/dist/cjs/providers/s3/utils/client/s3data/copyObject.js
+++ b/node_modules/@aws-amplify/storage/dist/cjs/providers/s3/utils/client/s3data/copyObject.js
@@ -17,6 +17,7 @@ const copyObjectSerializer = async (input, endpoint) => {
         ...(0, utils_2.assignStringVariables)({
             'x-amz-copy-source': input.CopySource,
             'x-amz-metadata-directive': input.MetadataDirective,
+            'x-amz-tagging-directive': input.TaggingDirective,
             'x-amz-copy-source-if-match': input.CopySourceIfMatch,
             'x-amz-copy-source-if-unmodified-since': input.CopySourceIfUnmodifiedSince?.toUTCString(),
             'x-amz-source-expected-bucket-owner': input.ExpectedSourceBucketOwner,
@@ -45,6 +46,7 @@ const validateCopyObjectHeaders = (input, headers) => {
     const validations = [
         headers['x-amz-copy-source'] === input.CopySource,
         (0, utils_2.bothNilOrEqual)(input.MetadataDirective, headers['x-amz-metadata-directive']),
+        (0, utils_2.bothNilOrEqual)(input.TaggingDirective, headers['x-amz-tagging-directive']),
         (0, utils_2.bothNilOrEqual)(input.CopySourceIfMatch, headers['x-amz-copy-source-if-match']),
         (0, utils_2.bothNilOrEqual)(input.CopySourceIfUnmodifiedSince?.toUTCString(), headers['x-amz-copy-source-if-unmodified-since']),
     ];
diff --git a/node_modules/@aws-amplify/storage/dist/esm/providers/s3/apis/internal/copy.mjs b/node_modules/@aws-amplify/storage/dist/esm/providers/s3/apis/internal/copy.mjs
index 85a825f..aedc089 100644
--- a/node_modules/@aws-amplify/storage/dist/esm/providers/s3/apis/internal/copy.mjs
+++ b/node_modules/@aws-amplify/storage/dist/esm/providers/s3/apis/internal/copy.mjs
@@ -140,6 +140,7 @@ const serviceCopy = async ({ source, destination, bucket, s3Config, notModifiedS
         CopySource: source,
         Key: destination,
         MetadataDirective: 'COPY', // Copies over metadata like contentType as well
+        TaggingDirective: 'REPLACE', // DOES NOT copy over tags; see https://github.com/aws-amplify/amplify-ui/issues/6621
         CopySourceIfMatch: eTag,
         CopySourceIfUnmodifiedSince: notModifiedSince,
         ExpectedSourceBucketOwner: expectedSourceBucketOwner,
diff --git a/node_modules/@aws-amplify/storage/dist/esm/providers/s3/utils/client/s3data/copyObject.d.ts b/node_modules/@aws-amplify/storage/dist/esm/providers/s3/utils/client/s3data/copyObject.d.ts
index 353630d..b9f6344 100644
--- a/node_modules/@aws-amplify/storage/dist/esm/providers/s3/utils/client/s3data/copyObject.d.ts
+++ b/node_modules/@aws-amplify/storage/dist/esm/providers/s3/utils/client/s3data/copyObject.d.ts
@@ -1,6 +1,6 @@
 import { Endpoint, HttpResponse } from '@aws-amplify/core/internals/aws-client-utils';
 import type { CopyObjectCommandInput, CopyObjectCommandOutput } from './types';
-export type CopyObjectInput = Pick<CopyObjectCommandInput, 'Bucket' | 'CopySource' | 'Key' | 'MetadataDirective' | 'CacheControl' | 'ContentType' | 'ContentDisposition' | 'ContentLanguage' | 'Expires' | 'ACL' | 'Tagging' | 'Metadata' | 'CopySourceIfUnmodifiedSince' | 'CopySourceIfMatch' | 'ExpectedSourceBucketOwner' | 'ExpectedBucketOwner'>;
+export type CopyObjectInput = Pick<CopyObjectCommandInput, 'Bucket' | 'CopySource' | 'Key' | 'MetadataDirective' | 'TaggingDirective' | 'CacheControl' | 'ContentType' | 'ContentDisposition' | 'ContentLanguage' | 'Expires' | 'ACL' | 'Tagging' | 'Metadata' | 'CopySourceIfUnmodifiedSince' | 'CopySourceIfMatch' | 'ExpectedSourceBucketOwner' | 'ExpectedBucketOwner'>;
 export type CopyObjectOutput = CopyObjectCommandOutput;
 export declare const validateCopyObjectHeaders: (input: CopyObjectInput, headers: Record<string, string>) => void;
 export declare const copyObject: (config: {
diff --git a/node_modules/@aws-amplify/storage/dist/esm/providers/s3/utils/client/s3data/copyObject.mjs b/node_modules/@aws-amplify/storage/dist/esm/providers/s3/utils/client/s3data/copyObject.mjs
index e0a0fbf..a19d84f 100644
--- a/node_modules/@aws-amplify/storage/dist/esm/providers/s3/utils/client/s3data/copyObject.mjs
+++ b/node_modules/@aws-amplify/storage/dist/esm/providers/s3/utils/client/s3data/copyObject.mjs
@@ -21,6 +21,7 @@ const copyObjectSerializer = async (input, endpoint) => {
         ...assignStringVariables({
             'x-amz-copy-source': input.CopySource,
             'x-amz-metadata-directive': input.MetadataDirective,
+            'x-amz-tagging-directive': input.TaggingDirective,
             'x-amz-copy-source-if-match': input.CopySourceIfMatch,
             'x-amz-copy-source-if-unmodified-since': input.CopySourceIfUnmodifiedSince?.toUTCString(),
             'x-amz-source-expected-bucket-owner': input.ExpectedSourceBucketOwner,
@@ -49,6 +50,7 @@ const validateCopyObjectHeaders = (input, headers) => {
     const validations = [
         headers['x-amz-copy-source'] === input.CopySource,
         bothNilOrEqual(input.MetadataDirective, headers['x-amz-metadata-directive']),
+        bothNilOrEqual(input.TaggingDirective, headers['x-amz-tagging-directive']),
         bothNilOrEqual(input.CopySourceIfMatch, headers['x-amz-copy-source-if-match']),
         bothNilOrEqual(input.CopySourceIfUnmodifiedSince?.toUTCString(), headers['x-amz-copy-source-if-unmodified-since']),
     ];
diff --git a/node_modules/@aws-amplify/storage/src/providers/s3/apis/internal/copy.ts b/node_modules/@aws-amplify/storage/src/providers/s3/apis/internal/copy.ts
index 85898ea..5ced1be 100644
--- a/node_modules/@aws-amplify/storage/src/providers/s3/apis/internal/copy.ts
+++ b/node_modules/@aws-amplify/storage/src/providers/s3/apis/internal/copy.ts
@@ -213,6 +213,7 @@ const serviceCopy = async ({
 			CopySource: source,
 			Key: destination,
 			MetadataDirective: 'COPY', // Copies over metadata like contentType as well
+			TaggingDirective: 'REPLACE', // DOES NOT copy over tags; see https://github.com/aws-amplify/amplify-ui/issues/6621
 			CopySourceIfMatch: eTag,
 			CopySourceIfUnmodifiedSince: notModifiedSince,
 			ExpectedSourceBucketOwner: expectedSourceBucketOwner,
diff --git a/node_modules/@aws-amplify/storage/src/providers/s3/utils/client/s3data/copyObject.ts b/node_modules/@aws-amplify/storage/src/providers/s3/utils/client/s3data/copyObject.ts
index 9ad63e5..5a2cb2e 100644
--- a/node_modules/@aws-amplify/storage/src/providers/s3/utils/client/s3data/copyObject.ts
+++ b/node_modules/@aws-amplify/storage/src/providers/s3/utils/client/s3data/copyObject.ts
@@ -35,6 +35,7 @@ export type CopyObjectInput = Pick<
 	| 'CopySource'
 	| 'Key'
 	| 'MetadataDirective'
+	| 'TaggingDirective'
 	| 'CacheControl'
 	| 'ContentType'
 	| 'ContentDisposition'
@@ -60,6 +61,7 @@ const copyObjectSerializer = async (
 		...assignStringVariables({
 			'x-amz-copy-source': input.CopySource,
 			'x-amz-metadata-directive': input.MetadataDirective,
+			'x-amz-tagging-directive': input.TaggingDirective,
 			'x-amz-copy-source-if-match': input.CopySourceIfMatch,
 			'x-amz-copy-source-if-unmodified-since':
 				input.CopySourceIfUnmodifiedSince?.toUTCString(),
@@ -97,6 +99,10 @@ export const validateCopyObjectHeaders = (
 			input.MetadataDirective,
 			headers['x-amz-metadata-directive'],
 		),
+		bothNilOrEqual(
+			input.TaggingDirective,
+			headers['x-amz-tagging-directive'],
+		),
 		bothNilOrEqual(
 			input.CopySourceIfMatch,
 			headers['x-amz-copy-source-if-match'],

[pranavosu]

Hey @simon-vdk, thanks for creating this issue! we will look into adding this feature