list_object_versions example does not match description

[jrotenstein]

Describe the issue

The example says "The request limits the number of items returned to two."

However, MaxKeys is not specified in the example, so this is incorrect.

response = client.list_object_versions(
    Bucket='examplebucket',
    Prefix='HappyFace.jpg',
)

print(response)

It should include: MaxKeys=2

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3/client/list_object_versions.html

[tim-finnigan]

Hi @jrotenstein thanks for bringing this to our attention. I can confirm that the example you referenced should include MaxKeys=2 in order to limit the number of items returned to two.

Examples like this are provided by service teams and documented across AWS SDKs (for example JavaScript and Ruby). So we need to forward this issue to the S3 team so that they can fix the issue upstream. I created a new issue to track this going forward: aws/aws-sdk#650.

[github-actions]

⚠️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.