boto / botocore

The low-level, core functionality of boto3 and the AWS CLI.
Apache License 2.0
1.5k stars 1.09k forks source link

[Documentation] SSM GetParametersByPath MaxResults Value is Incorrect #2086

Closed rp4fx12 closed 2 years ago

rp4fx12 commented 4 years ago

Describe the bug

The documentation on SSM GetParametersByPath does not reference an appropriate value for MaxResults. This leads to confusion when invoking the API. The value in the document is specified as 123 when at max it can be 10.

Steps to reproduce

View document here: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ssm.html#SSM.Client.get_parameters_by_path

Expected behavior

Update to the documentation with an appropriate value in the MaxRequests Section. In addition, it would be nice to specify the limits on the MaxRequests call in the documentation.

Debug logs

N/A

rp4fx12 commented 4 years ago

I may be wrong but I believe the 123 comes from this block of code - https://github.com/boto/botocore/blob/879f8440a4e9ace5d3cf145ce8b3d5e5ffb892ef/botocore/docs/shape.py#L93.

swetashre commented 4 years ago

@rp4fx12 - Thank you for your post. We are using 123 as a general value for integer type in every request syntax in the documentation. This request syntax does not contain the actual value. So if you can see for string type parameter we are using string as value in there. In this case what we can do is update our documentation clarifying about request syntax does not contain actual value.

Boto3 documentation is generated from API reference https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_GetParametersByPath.html

github-actions[bot] commented 2 years ago

Greetings! It looks like this issue hasn’t been active in longer than one year. We encourage you to check if this is still an issue in the latest release. In the absence of more information, we will be closing this issue soon. If you find that this is still a problem, please feel free to provide a comment or upvote with a reaction on the initial post to prevent automatic closure. If the issue is already closed, please feel free to open a new one.

pkit commented 5 months ago

I do not see 10 as maximum possible value anywhere in the docs. Why is that? Users are expected to trial and error?