EventBridge put_events documentation does not mention limit of max 10 events

[sparrowt]

Describe the issue

EventBridge.Client.put_events fails if you supply more than 10 items in the Entries list but this is not mentioned at all on the boto3 documentation.

It is however mentioned on the generic APIReference docs.

See both links below for comparison

It would be helpful for the boto3 docs to mention this limitation (for example it does mention the maximum size in KB).

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/events/client/put_events.html

https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html#API_PutEvents_RequestSyntax

[tim-finnigan]

Thanks for reaching out. I agree that it would be good to note the 10 item limit for Entries.

The Amazon EventBridge team would need to add a note to their service API documentation model regarding the 10 item limit, in order for that to be reflected in the SDK documentation. I'll go ahead and reach out to the EventBridge team internally about adding that note. But since this wouldn't be added directly from Boto3, I'll go ahead and close this issue.

[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.

[sparrowt]

Many thanks @tim-finnigan. It is intriguing that it is mentioned in this eventbridge API documentation but is there a different/hidden set of docs which get churned through into botocore/boto3?

[tim-finnigan]

Many thanks @tim-finnigan. It is intriguing that it is mentioned in this eventbridge API documentation but is there a different/hidden set of docs which get churned through into botocore/boto3?

Sure - you can find service API documentation models in files like https://github.com/boto/botocore/blob/develop/botocore/data/events/2015-10-07/service-2.json, but they may not always be matching what is in the API documentation pages. That's why we sometimes need to reach out internally to service teams to ensure that the up-to-date information is being propagated to the SDK documentation.

[sparrowt]

I see, so they would need to open a PR to botocore? Or there is somewhere else which they maintain, from which botocore is updated via some (semi)automated process?

[tim-finnigan]

I see, so they would need to open a PR to botocore? Or there is somewhere else which they maintain, from which botocore is updated via some (semi)automated process?

Service teams maintain internal service API models, and once they make changes to documentation the changes should get reflected downstream in SDK documentation through an automated PR release process.