Skip to content

Commit

Permalink
Deprecate S3 CopySource parameter for CopyObject & UploadPartCopy (#2623
Browse files Browse the repository at this point in the history
)

## Motivation and Context

In #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
#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

Co-authored-by: Bennett Lynch <[email protected]>
  • Loading branch information
Bennett-Lynch and Bennett Lynch authored Jul 24, 2021
1 parent 5c7b6dd commit 0eae84b
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .changes/next-release/documentation-AmazonS3-259552c.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"category": "Amazon S3",
"contributor": "",
"type": "documentation",
"description": "Deprecate S3 CopySource parameter for CopyObject & UploadPartCopy"
}
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@
],
"modify": [
{
"CopySource": {
"deprecated": true,
"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."
},
"Bucket": {
"emitPropertyName": "DestinationBucket",
"existingNameDeprecated": true
Expand Down Expand Up @@ -65,6 +69,10 @@
],
"modify": [
{
"CopySource": {
"deprecated": true,
"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."
},
"Bucket": {
"emitPropertyName": "DestinationBucket",
"existingNameDeprecated": true
Expand Down

0 comments on commit 0eae84b

Please sign in to comment.