community.aws.aws_s3_bucket_info – lists S3 buckets in AWS

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values

Synopsis

• Lists S3 buckets and details about those buckets.
• This module was called aws_s3_bucket_facts before Ansible 2.9, returning ansible_facts. Note that the community.aws.aws_s3_bucket_info module no longer returns ansible_facts!

Requirements

The below requirements are needed on the host that executes this module.

• boto
• boto3 >= 1.4.4
• python >= 2.6

Parameters

Notes

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Note: Only AWS S3 is currently supported

# Lists all s3 buckets
- community.aws.aws_s3_bucket_info:
  register: result

# Retrieve detailed bucket information
- community.aws.aws_s3_bucket_info:
    # Show only buckets with name matching
    name_filter: your.testing
    # Choose facts to retrieve
    bucket_facts:
      # bucket_accelerate_configuration: true
      bucket_acl: true
      bucket_cors: true
      bucket_encryption: true
      # bucket_lifecycle_configuration: true
      bucket_location: true
      # bucket_logging: true
      # bucket_notification_configuration: true
      # bucket_ownership_controls: true
      # bucket_policy: true
      # bucket_policy_status: true
      # bucket_replication: true
      # bucket_request_payment: true
      # bucket_tagging: true
      # bucket_website: true
      # public_access_block: true
    transform_location: true
    register: result

# Print out result
- name: List buckets
  ansible.builtin.debug:
    msg: "{{ result['buckets'] }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Authors

• Gerben Geijteman (@hyperized)