Rename expiration param which accepts Date|string|number to expiresIn which accepts number in seconds

[trivikr]

Is your feature request related to a problem? Please describe.

• While calling presign API, the SDK customer has to compute expiration value which is either a {Date} object, a unix (epoch) timestamp in seconds, or a string that can be understood by the JavaScript {Date} constructor.
• This is in addition to computing optional signingDate which also accepts the all the three values (Date|string|number).

Describe the solution you'd like Allow SDK customer just to pass number in seconds after which the presigned URL should expire.

• If customer is already passing signingDate, then they just pass expires seconds after which the URL should expire.
• If the customer is not passing signingDate, then they just pass expires seconds after which URL should expire.

In both the cases, customer doesn't have to compute expiration Date|string|number

Describe alternatives you've considered Compute expiration Date|string|number, and pass while calling presign API

Update: param name will be changed to expiresIn as per findings in https://github.com/aws/aws-sdk-js-v3/issues/1035#issuecomment-602816992

[trivikr]

In v2, we accept expires param - number in seconds after which presigned URL should expire

• lib/services/s3.js https://github.com/aws/aws-sdk-js/blob/2f5261f46eb95a33ddb72ba27a6f7304e4f9ded9/lib/services/s3.js#L1016-L1035
• lib/polly/presigner.js https://github.com/aws/aws-sdk-js/blob/2f5261f46eb95a33ddb72ba27a6f7304e4f9ded9/lib/polly/presigner.js#L105-L114
• lib/request.js https://github.com/aws/aws-sdk-js/blob/2f5261f46eb95a33ddb72ba27a6f7304e4f9ded9/lib/request.js#L708-L717

[trivikr]

Some history in v3:

• PR in which expires was initially added as Date|string|number https://github.com/aws/aws-sdk-js-v3/pull/28
• PR in which expires was renamed to expiration without changing the type https://github.com/aws/aws-sdk-js-v3/pull/36

[trivikr]

The S3 operations except both Date/time for Expires parameter though

• PutObject API
• CopyObject API
• CreateMultipartUpload API

SDKs that accept expires in seconds for presign API:

• aws cli https://docs.aws.amazon.com/cli/latest/reference/s3/presign.html#options
• python https://boto3.amazonaws.com/v1/documentation/api/latest/guide/s3-presigned-urls.html
• Ruby https://docs.aws.amazon.com/sdk-for-ruby/v2/api/Aws/S3/Presigner.html#instance_method_details

SDKs which accept dates for presigned URLs:

• Java
• .NET

Renaming the param to expiresIn just like CLI/python/Ruby so that it's self-explanatory

[lock[bot]]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.