Wrong limit value in sample code for boto3 describe_log_groups

[puidenz]

Describe the issue

The sample code uses limit=123; however, the valid value is 1 to 50 for DescribeLogGroups.

response = client.describe_log_groups(
    accountIdentifiers=[
        'string',
    ],
    logGroupNamePrefix='string',
    logGroupNamePattern='string',
    nextToken='string',
    limit=123,
    includeLinkedAccounts=True|False,
    logGroupClass='STANDARD'|'INFREQUENT_ACCESS'
)

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/logs/client/describe_log_groups.html#describe-log-groups

[RyanFitzSimmonsAK]

Hi @puidenz, thanks for reaching out. This is pretty common in SDK examples; the examples aren't intended to be copied and ran off-the-shelf. They exist to demonstrate the correct syntax and explain other nuances. All of the other parameters in DescribeLogGroups would need to be changed from their sample values as well, so I'm not sure how limit is any different. Hope that helps, and let me know if you have any follow-up questions.

[puidenz]

Hi Ryan, thanks for your reply!
Could we add valid value range (1~50) under explanation of limit attribute in the SDK doc? Currently there is no explanation for valid value.

limit (integer) – The maximum number of items returned. If you don’t specify a value, the default is up to 50 items.

So users don't have to travel over API doc or try-and-error to get the valid value.

[tim-finnigan]

Hi @puidenz thanks for following up and providing more context. As Ryan mentioned, using limit=123 is just a placeholder and not intended to be copied and ran as is. However, I saw that this has tripped up a few other people over the years who were running other commands (see #1356 for example). So we brought this up for discussion with the team, and decided to create a new tracking issue (#4088) for tracking these issues.

As described in the new issue, further discussion is needed to discuss possible paths forward here. I'll go ahead and close this in favor of consolidating and tracking in the new issue. Please feel free to 👍 or comment there. Thanks again!

[github-actions]

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.