Event Stream documentation lists exceptions and errors as being returned, not thrown as EventStreamError #4031
Labels
documentation
This is a problem with documentation.
needs-triage
This issue or PR still needs to be triaged.
Describe the issue
The documentation for methods that return event streams, at least the ones I've looked at, include errors as part of the shape of the structure that can be returned. For example from https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sagemaker-runtime/client/invoke_endpoint_with_response_stream.html
However boto3 is smart enough to throw errors as a EventStreamError, via https://github.com/boto/botocore/blob/bf2473756ac0dac340916eaac606b9b767d15e99/botocore/eventstream.py#L354-L362 and https://github.com/boto/botocore/blob/bf2473756ac0dac340916eaac606b9b767d15e99/botocore/eventstream.py#L613-L619.
Links
This is a couple of examples, not an exhaustive list:
The text was updated successfully, but these errors were encountered: