community.aws.s3_bucket_info module – Lists S3 buckets in AWS
+community.aws.s3_bucket_info module
Note
-This module is part of the community.aws collection (version 7.0.0-dev0).
-It is not included in ansible-core
.
-To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.aws
.
-You need further requirements to be able to use this module,
-see Requirements for details.
This redirect is part of the community.aws collection (version 7.0.0-dev0).
To use it in a playbook, specify: community.aws.s3_bucket_info
.
New in community.aws 1.0.0
- -Synopsis
--
-
Lists S3 buckets and details about those buckets.
-Prior to release 5.0.0 this module was called
community.aws.aws_s3_bucket_info
. The usage did not change.
-
Aliases: aws_s3_bucket_info
-Requirements
-The below requirements are needed on the host that executes this module.
--
-
python >= 3.6
-boto3 >= 1.26.0
-botocore >= 1.29.0
-
Parameters
-Parameter |
-Comments |
-
---|---|
- | AWS access key ID. -See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. -The The aws_access_key and profile options are mutually exclusive. -The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. -The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. -Support for the |
-
- | The location of a CA Bundle to use when validating SSL certificates. -The |
-
- | A dictionary to modify the botocore configuration. -Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. - |
-
- | Retrieve requested S3 bucket detailed information. -Each bucket_X option executes one API call, hence many options being set to You can limit buckets by using the name or name_filter option. - |
-
- | Retrive S3 accelerate configuration. -Choices: -
|
-
- | Retrive S3 bucket ACLs. -Choices: -
|
-
- | Retrive S3 bucket CORS configuration. -Choices: -
|
-
- | Retrive S3 bucket encryption. -Choices: -
|
-
- | Retrive S3 bucket lifecycle configuration. -Choices: -
|
-
- | Retrive S3 bucket location. -Choices: -
|
-
- | Retrive S3 bucket logging. -Choices: -
|
-
- | Retrive S3 bucket notification configuration. -Choices: -
|
-
- | Retrive S3 ownership controls. -Choices: -
|
-
- | Retrive S3 bucket policy. -Choices: -
|
-
- | Retrive S3 bucket policy status. -Choices: -
|
-
- | Retrive S3 bucket replication. -Choices:
|
-
- | Retrive S3 bucket request payment. -Choices: -
|
-
- | Retrive S3 bucket tagging. -Choices: -
|
-
- | Retrive S3 bucket website. -Choices: -
|
-
- | Retrive S3 bucket public access block. -Choices: -
|
-
- | Use a The Choices: -
|
-
- | URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. -The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. -Support for the |
-
- | Name of bucket to query. -Default: |
-
- | Limits buckets to only buckets who’s name contain the string in name_filter. -Default: |
-
- | A named AWS profile to use for authentication. -See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. -The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. - |
-
- | The AWS region to use. -For global services such as IAM, Route53 and CloudFront, region is ignored. -The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. -The Support for the |
-
- | AWS secret access key. -See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. -The The secret_key and profile options are mutually exclusive. -The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. -The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. -Support for the |
-
- | AWS STS session token for use with temporary credentials. -See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. -The The security_token and profile options are mutually exclusive. -Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. -The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. -Support for the |
-
- | S3 bucket location for default us-east-1 is normally reported as Setting this option to Affects only queries with bucket_facts=true and bucket_location=true. -Choices: -
|
-
- | When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. -Choices: -
|
-
Notes
-Note
--
-
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
-The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials
). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
-
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.s3_bucket_info:
- register: result
-
-# Retrieve detailed bucket information
-- community.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:
-Key |
-Description |
-
---|---|
- | List of buckets -Returned: always - |
-
- | Bucket ACL configuration. -Returned: when bucket_facts=true and bucket_acl=true - |
-
- | List of ACL grants. -Returned: success -Sample: |
-
- | Bucket owner information. -Returned: success - |
-
- | Bucket owner user display name. -Returned: always -Sample: |
-
- | Bucket owner user ID. -Returned: always -Sample: |
-
- | Bucket CORS configuration. -Returned: when bucket_facts=true and bucket_cors=true - |
-
- | Bucket CORS configuration. -Returned: when CORS rules are defined for the bucket -Sample: |
-
- | Bucket encryption configuration. -Returned: when bucket_facts=true and bucket_encryption=true - |
-
- | ServerSideEncryptionConfiguration configuration. -Returned: when encryption is enabled on the bucket - |
-
- | List of applied encryptio rules. -Returned: when encryption is enabled on the bucket -Sample: |
-
- | Bucket lifecycle configuration settings. -Returned: when bucket_facts=true and bucket_lifecycle_configuration=true - |
-
- | List of lifecycle management rules. -Returned: when lifecycle configuration is present -Sample: |
-
- | Bucket location. -Returned: when bucket_facts=true and bucket_location=true - |
-
- | AWS region. -Returned: always -Sample: |
-
- | Server access logging configuration. -Returned: when bucket_facts=true and bucket_logging=true - |
-
- | Server access logging configuration. -Returned: when server access logging is defined for the bucket - |
-
- | Target bucket name. -Returned: always -Sample: |
-
- | Prefix in target bucket. -Returned: always -Sample: |
-
- | String used to limit buckets. See name_filter. -Returned: when name_filter is defined -Sample: |
-
- | Bucket notification settings. -Returned: when bucket_facts=true and bucket_notification_configuration=true - |
-
- | List of notification events configurations. -Returned: when at least one notification is configured -Sample: |
-
- | Preffered object ownership settings. -Returned: when bucket_facts=true and bucket_ownership_controls=true - |
-
- | Object ownership settings. -Returned: when ownership controls are defined for the bucket - |
-
- | List of ownership rules. -Returned: when ownership rule is defined -Sample: |
-
- | Bucket policy contents. -Returned: when bucket_facts=true and bucket_policy=true -Sample: |
-
- | Status of bucket policy. -Returned: when bucket_facts=true and bucket_policy_status=true - |
-
- | Status of bucket policy. -Returned: when bucket policy is present - |
-
- | Report bucket policy public status. -Returned: when bucket policy is present -Sample: |
-
- | Replication configuration settings. -Returned: when bucket_facts=true and bucket_replication=true - |
-
- | IAM role used for replication. -Returned: when replication rule is defined -Sample: |
-
- | List of replication rules. -Returned: when replication rule is defined -Sample: |
-
- | Requester pays setting. -Returned: when bucket_facts=true and bucket_request_payment=true - |
-
- | Current payer. -Returned: always -Sample: |
-
- | Bucket tags. -Returned: when bucket_facts=true and bucket_tagging=true -Sample: |
-
- | Static website hosting. -Returned: when bucket_facts=true and bucket_website=true - |
-
- | Object serving as HTTP error page. -Returned: when static website hosting is enabled -Sample: |
-
- | Object serving as HTTP index page. -Returned: when static website hosting is enabled -Sample: |
-
- | Website redict settings. -Returned: when redirect requests is configured - |
-
- | Hostname to redirect. -Returned: always -Sample: |
-
- | Protocol used for redirect. -Returned: always -Sample: |
-
- | Bucket creation date timestamp. -Returned: always -Sample: |
-
- | Bucket name. -Returned: always -Sample: |
-
- | Bucket public access block configuration. -Returned: when bucket_facts=true and public_access_block=true - |
-
- | PublicAccessBlockConfiguration data. -Returned: when PublicAccessBlockConfiguration is defined for the bucket - |
-
- | BlockPublicAcls setting value. -Returned: success -Sample: |
-
- | BlockPublicPolicy setting value. -Returned: success -Sample: |
-
- | IgnorePublicAcls setting value. -Returned: success -Sample: |
-
- | RestrictPublicBuckets setting value. -Returned: success -Sample: |
-