Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

get_images requires WidthPixels when documentation says it shouldn't #3900

Closed
daveisfera opened this issue Oct 16, 2023 · 2 comments
Closed
Assignees
Labels
bug This issue is a confirmed bug. investigating This issue is being investigated and/or work is in progress to resolve the issue. kinesis-video-archived-media p3 This is a minor priority issue

Comments

@daveisfera
Copy link

Describe the bug

The documentation says that HeightPixels can be set and WidthPixels will be calculated, but this doesn't work

Expected Behavior

Setting only HeightPixels would be allowed

Current Behavior

This error is output:

ClientError An error occurred (InvalidArgumentException) when calling the GetImages operation: Height and width for the images need to be provided or none.

Reproduction Steps

  • Run kinesis-video-archived-media.get_images with only HeightPixels set
  • Observer the error

Possible Solution

Fix check so only HeightPixels can be set

Additional Information/Context

No response

SDK version used

1.28.64

Environment details (OS name and version, etc.)

Debian Bookworm

@daveisfera daveisfera added bug This issue is a confirmed bug. needs-triage This issue or PR still needs to be triaged. labels Oct 16, 2023
@RyanFitzSimmonsAK RyanFitzSimmonsAK self-assigned this Oct 17, 2023
@RyanFitzSimmonsAK RyanFitzSimmonsAK added investigating This issue is being investigated and/or work is in progress to resolve the issue. p3 This is a minor priority issue kinesis-video-archived-media and removed needs-triage This issue or PR still needs to be triaged. labels Oct 17, 2023
@RyanFitzSimmonsAK
Copy link
Contributor

Hi @daveisfera, thanks for reaching out. It looks like this page has some conflicting documentation. WidthPixels says "...If only the WidthPixels parameter is provided or if only the HeightPixels is provided, a ValidationException will be thrown." HeightPixels says "...If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio." I've reached out to the service team to clarify which is the intended behavior. In the meantime, as this is a issue with the service documentation, I'm going to close this issue and reopen a tracking issue in the cross-SDK repository (https://github.com/aws/aws-sdk). Refer to that issue for any updates. Thanks!

@github-actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a confirmed bug. investigating This issue is being investigated and/or work is in progress to resolve the issue. kinesis-video-archived-media p3 This is a minor priority issue
Projects
None yet
Development

No branches or pull requests

2 participants