'version' parameter name not consistant for Read-S3Object when comparing to other similar S3 object cmdlets #369
Description
Describe the feature
I ran into something that may seem minor, as it affects overall cognitive load when dealing with parameter names when using certain S3 cmdlets.
In this instance, the parameter name for Read-S3Object does not follow the same naming scheme as other similar cmdlets for S3 objects.
| Cmdlet | Parameter name |
|---|---|
| Copy-S3Object | VersionId |
| Get-S3ObjectAttribute | VersionId |
| Get-S3ObjectLegalHold | VersionId |
| Get-S3ObjectMetadata | VersionId |
| Get-S3ObjectRetention | VersionId |
| Get-S3ObjectTagSet | VersionId |
| Remove-S3Object | VersionId |
| Read-S3Object | Version |
| Remove-S3ObjectTagSet | VersionId |
| Restore-S3Object | VersionId |
| Write-S3GetObjectResponse | VersionId |
I may have missed some other examples, but it seems pretty clear for some reason Read-S3Object has a different parameter name.
This always trips me up if I am not thinking about it, as typically I automatically use -VersionId as the parameter name when needing to deal with specific versions when using S3 Object cmdlets.
Use Case
#1 - Consistency is king
#2 - Not having to remember a different parameter name for a single cmdlet when the rest are the same.
Proposed Solution
To avoid a breaking change, can we have a parameter alias of -VersionId added to -Version
Other Information
No response
Acknowledgements
- I may be able to implement this feature request
- This feature might incur a breaking change
AWS Tools for PowerShell version used
AWS.Tools.S3 4.1.579
PowerShell version used
Name Value
---- -----
PSVersion 7.4.6
PSEdition Core
GitCommitId 7.4.6
OS Microsoft Windows 10.0.22631
Platform Win32NT
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
WSManStackVersion 3.0
Operating System and version
Windows 10 and 11