ansible-collections / amazon.aws

Ansible Collection for Amazon AWS
GNU General Public License v3.0
277 stars 321 forks source link

amazon.aws.s3_bucket_info incorrect return value #2116

Open alicekaerast opened 1 month ago

alicekaerast commented 1 month ago

Summary

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.

Issue Type

Documentation Report

Component Name

s3_bucket_info

Ansible Version

$ 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

Collection Versions

$ ansible-galaxy collection list
amazon.aws                               7.3.0
community.aws                            7.1.0 

Configuration

$ 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

OS / Environment

MacOS

Additional Information

No response

Code of Conduct

alinabuzachis commented 1 month ago

@alicekaerast Thank you for opening this issue. We'll be working on a fix for this documentation mismatch.

mandar242 commented 2 weeks ago

@alicekaerast #2135 should resolve the issue.