Open alicekaerast opened 1 month ago
The documentation claims that this module returns bucket_list but it actually returns buckets. The example of msg: "{{ result['buckets'] }}" is correct, the list of return values is not.
bucket_list
buckets
msg: "{{ result['buckets'] }}"
Documentation Report
s3_bucket_info
$ ansible --version ansible [core 2.16.4] config file = /Users/alicekaerast/.ansible.cfg configured module search path = ['/Users/alicekaerast/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules'] ansible python module location = /Users/alicekaerast/.asdf/installs/python/3.12.2/lib/python3.12/site-packages/ansible ansible collection location = /Users/alicekaerast/.ansible/collections:/usr/share/ansible/collections executable location = /Users/alicekaerast/.asdf/installs/python/3.12.2/bin/ansible python version = 3.12.2 (main, Mar 6 2024, 16:25:12) [Clang 15.0.0 (clang-1500.1.0.2.5)] (/Users/alicekaerast/.asdf/installs/python/3.12.2/bin/python3.12) jinja version = 3.1.3 libyaml = True
$ ansible-galaxy collection list amazon.aws 7.3.0 community.aws 7.1.0
$ ansible-config dump --only-changed ANSIBLE_FORCE_COLOR(env: ANSIBLE_FORCE_COLOR) = True CONFIG_FILE() = /Users/alicekaerast/.ansible.cfg EDITOR(env: EDITOR) = lvim PAGER(env: PAGER) = less
MacOS
No response
@alicekaerast Thank you for opening this issue. We'll be working on a fix for this documentation mismatch.
@alicekaerast #2135 should resolve the issue.
Summary
The documentation claims that this module returns
bucket_list
but it actually returnsbuckets
. The example ofmsg: "{{ result['buckets'] }}"
is correct, the list of return values is not.Issue Type
Documentation Report
Component Name
s3_bucket_info
Ansible Version
Collection Versions
Configuration
OS / Environment
MacOS
Additional Information
No response
Code of Conduct