ListObjects and ListObjectsV2 examples show MaxKeys as a string, should be an integer

[morzahavi]

Describe the bug

The documentation specifies a string for the variable "MaxKeys" in list_objects_v2 fuction, but this raises an error as it expects an integer.

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

Regression Issue

• Select this option if this issue appears to be a regression.

Expected Behavior

I followed the documentation and got en error:
Invalid type for parameter MaxKeys, value: 2, type: <class 'str'>, valid types: <class 'int'>

Current Behavior

Raises error despite of documentation guidelines

Reproduction Steps

BUCKET = "example_bucket"
PREFIX = "example_prefix"
objects_list = s3.list_objects_v2(
    Bucket=BUCKET,
    Prefix=PREFIX,
    MaxKeys=2
)

Possible Solution

Change documentation, or change the function.

Additional Information/Context

No response

SDK version used

1.36.3

Environment details (OS name and version, etc.)

Ubuntu 24.04.1

[RyanFitzSimmonsAK]

Hi @morzahavi, thanks for reaching out. Looking at the documentation for both ListObjects and ListObjectsV2, the parameter documentation for MaxKeys seems to correctly document it as an integer.

ListObjects

MaxKeys (integer) – Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

ListObjectsV2

MaxKeys (integer) – Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

However, the examples show it as a string. I'll cut a ticket with the service team to make that an integer, and make pull requests to fix it in botocore.

Ticket # for internal use : P199564241