search

boto / botocore

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

Waiter documentation about error behavior is incorrect #3193

Open Shtutnik opened 3 weeks ago

Shtutnik commented 3 weeks ago

Describe the issue

Hi,

(Also opened this issue that was merged)

From what I see in the different waiter pages, it states that An error is returned (see code here) ... although when checking the python code (for example here) it seems that actually an error is raised, not returned.

Could you please emphasize this so that developers know what behavior to expect from the wait function?

I listed some examples below, but I think this is a generic thing that applies to all waiter pages.

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ecs/waiter/ServicesStable.html https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2/waiter/ImageExists.html

tim-finnigan commented 3 weeks ago

Thanks for following up here, created https://github.com/boto/botocore/pull/3196 which should address this.