Skip to content

Commit 7ebef94

Browse files
author
Bennett Lynch
committed
Deprecate S3 CopySource parameter for CopyObject & UploadPartCopy
## Motivation and Context In aws#2612 we recently introduced replacement parameters for the S3 CopySource parameter. However, we did not officially deprecate it since our codegen tooling lacked support for deprecated members at the time. With aws#2622 we have since added support for deprecated members to both models and model modifications via customization.config files. Now that this feature is fully supported, we should deprecate the CopySource parameter to increase visibility and improve discoverability of the new parameters that are offered. This will make users more likely to discover the new parameters, allowing them to simplify their application code accordingly. ## Description * Annotate the CopySource parameter as deprecated for both CopySource and UploadPartCopy
1 parent 5c7b6dd commit 7ebef94

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"category": "Amazon S3",
3+
"contributor": "",
4+
"type": "documentation",
5+
"description": "Deprecate S3 CopySource parameter for CopyObject & UploadPartCopy"
6+
}

services/s3/src/main/resources/codegen-resources/customization.config

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@
3535
],
3636
"modify": [
3737
{
38+
"CopySource": {
39+
"deprecated": true,
40+
"deprecatedMessage": "The {@code copySource} parameter has been deprecated in favor of the more user-friendly {@code sourceBucket}, {@code sourceKey}, and {@code sourceVersionId} parameters. The {@code copySource} parameter will remain fully functional, but it must not be used in conjunction with its replacement parameters."
41+
},
3842
"Bucket": {
3943
"emitPropertyName": "DestinationBucket",
4044
"existingNameDeprecated": true
@@ -65,6 +69,10 @@
6569
],
6670
"modify": [
6771
{
72+
"CopySource": {
73+
"deprecated": true,
74+
"deprecatedMessage": "The {@code copySource} parameter has been deprecated in favor of the more user-friendly {@code sourceBucket}, {@code sourceKey}, and {@code sourceVersionId} parameters. The {@code copySource} parameter will remain fully functional, but it must not be used in conjunction with its replacement parameters."
75+
},
6876
"Bucket": {
6977
"emitPropertyName": "DestinationBucket",
7078
"existingNameDeprecated": true

0 commit comments

Comments
 (0)