amazon.aws.s3_bucket_info 模块 – 列出 AWS 中的 S3 存储桶

注意

此模块是 amazon.aws 集合（版本 9.0.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。 它不包含在 ansible-core 中。 要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install amazon.aws。 您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。

要在剧本中使用它，请指定：amazon.aws.s3_bucket_info。

community.aws 1.0.0 中新增

概要

• 列出 S3 存储桶以及有关这些存储桶的详细信息。

• 在 5.0.0 版本之前，此模块名为 community.aws.aws_s3_bucket_info。 用法没有改变。

别名：aws_s3_bucket_info

要求

执行此模块的主机需要满足以下要求。

• python >= 3.6

• boto3 >= 1.28.0

• botocore >= 1.31.0

参数

参数	注释
access_key 别名：aws_access_key_id, aws_access_key, ec2_access_key 字符串	AWS 访问密钥 ID。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 AWS_ACCESS_KEY_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量，优先级依次降低。 aws_access_key 和 profile 选项互斥。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_ACCESS_KEY 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
aws_ca_bundle 路径	用于验证 SSL 证书的 CA 捆绑包的位置。 也可以使用 AWS_CA_BUNDLE 环境变量。
aws_config 字典	用于修改 botocore 配置的字典。 可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。
bucket_facts 字典 在 amazon.aws 1.4.0 中添加	检索请求的 S3 存储桶详细信息。 每个 bucket_X 选项执行一次 API 调用，因此将多个选项设置为 true 会导致模块执行速度较慢。 您可以使用 name 或 name_filter 选项来限制存储桶。
bucket_accelerate_configuration 布尔值	检索 S3 加速配置。 选项 false ← (默认) true
bucket_acl 布尔值	检索 S3 存储桶 ACL。 选项 false ← (默认) true
bucket_cors 布尔值	检索 S3 存储桶 CORS 配置。 选项 false ← (默认) true
bucket_encryption 布尔值	检索 S3 存储桶加密。 选项 false ← (默认) true
bucket_lifecycle_configuration 布尔值	检索 S3 存储桶生命周期配置。 选项 false ← (默认) true
bucket_location 布尔值	检索 S3 存储桶位置。 选项 false ← (默认) true
bucket_logging 布尔值	检索 S3 存储桶日志记录。 选项 false ← (默认) true
bucket_notification_configuration 布尔值	检索 S3 存储桶通知配置。 选项 false ← (默认) true
bucket_ownership_controls 布尔值	检索 S3 所有权控制。 选项 false ← (默认) true
bucket_policy 布尔值	检索 S3 存储桶策略。 选项 false ← (默认) true
bucket_policy_status 布尔值	检索 S3 存储桶策略状态。 选项 false ← (默认) true
bucket_replication 布尔值	检索 S3 存储桶复制。 选项 false ← (默认) true
bucket_request_payment 布尔值	检索 S3 存储桶请求付款。 选项 false ← (默认) true
bucket_tagging 布尔值	检索 S3 存储桶标记。 选项 false ← (默认) true
bucket_versioning 布尔值 在 amazon.aws 7.3.0 中添加	检索存储桶的版本控制状态。 要检索存储桶的版本控制状态，您必须是存储桶的所有者。 选项 false ← (默认) true
bucket_website 布尔值	检索 S3 存储桶网站。 选项 false ← (默认) true
public_access_block 布尔值	检索 S3 存储桶公共访问阻止。 选项 false ← (默认) true
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 日志记录器来解析任务期间进行的唯一（而非总计）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调来输出 playbook 期间执行的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
endpoint_url 别名: ec2_url, aws_endpoint_url, s3_url 字符串	用于连接的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次降低。 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_URL 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
名称 字符串 在 amazon.aws 1.4.0 中添加	要查询的存储桶的名称。 默认值: ""
name_filter 字符串 在 amazon.aws 1.4.0 中添加	将存储桶限制为仅包含 name_filter 中的字符串的存储桶。 默认值: ""
profile 别名: aws_profile 字符串	用于身份验证的指定 AWS 配置文件。 有关命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 AWS_PROFILE 环境变量。 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。
region 别名: aws_region, ec2_region 字符串	要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全局服务，将忽略 region。 也可以使用 AWS_REGION 或 EC2_REGION 环境变量。 有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。 ec2_region 别名已弃用，将在 2024-12-01 之后的版本中删除 对 EC2_REGION 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
secret_key 别名: aws_secret_access_key, aws_secret_key, ec2_secret_key 字符串	AWS secret access key。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级递减的顺序使用 AWS_SECRET_ACCESS_KEY、AWS_SECRET_KEY 或 EC2_SECRET_KEY 环境变量。 secret_key 和 profile 选项互斥。 aws_secret_access_key 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 ec2_secret_key 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_SECRET_KEY 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
session_token 别名: aws_session_token, security_token, aws_security_token, access_token 字符串	用于临时凭证的 AWS STS 会话令牌。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级递减的顺序使用 AWS_SESSION_TOKEN、AWS_SECURITY_TOKEN 或 EC2_SECURITY_TOKEN 环境变量。 security_token 和 profile 选项互斥。 别名 aws_session_token 和 session_token 在 3.2.0 版本中添加，参数在 6.0.0 版本中从 security_token 重命名为 session_token。 security_token、aws_security_token 和 access_token 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
transform_location 布尔值 在 amazon.aws 1.4.0 中添加	默认 us-east-1 的 S3 存储桶位置通常报告为 null。 将此选项设置为 true 将返回 us-east-1。 仅影响使用 bucket_facts=true 和 bucket_facts.bucket_location=true 的查询。 选项 false ← (默认) true
validate_certs 布尔值	设置为 false 时，与 AWS API 通信时将不验证 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)

注意

注意

• 注意: 对于模块，环境变量和配置文件是从 Ansible “主机” 上下文读取的，而不是从“控制器”上下文中读取的。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible “控制器” 上下文读取的，而不是从“主机”上下文中读取的。

• Ansible 使用的 AWS SDK (boto3) 也可能从其在 Ansible “主机” 上下文中的配置文件（通常为 ~/.aws/credentials）读取凭证和其他设置（例如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

# 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
- amazon.aws.s3_bucket_info:
  register: result

# Retrieve detailed bucket information
- amazon.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'] }}"

返回值

常见返回值记录在此处，以下是此模块独有的字段

键	描述
buckets 复杂	S3 存储桶列表。 返回: 总是
bucket_accelerate_configuration 字典	存储桶的加速配置。 返回: 当 bucket_facts=true 并且 buckets.bucket_accelerate_configuration=true 时。 示例: {"RequestCharged": "requester", "Status": "Enabled"}
bucket_acl 复杂	存储桶 ACL 配置。 返回: 当 bucket_facts=true 并且 buckets.bucket_acl=true 时。
Grants list / elements=dictionary	ACL 授予列表。 返回: 成功 示例: [{"Grantee": {"DisplayName": "abc-aws-root+721234567890", "ID": "1234567890cbc0f1234567890f1234567890c123456789012123456789091234", "Type": "CanonicalUser"}, "Permission": "FULL_CONTROL"}]
Grantee 字典	被授予权限的人。 返回: 成功
DisplayName 字符串	被授权人的显示名称。 返回: 成功
ID 字符串	被授权人的规范用户 ID。 返回: 成功
Type 字符串	被授权人的类型。 返回: 成功
Permission 字符串	指定授予被授权人的权限。 返回: 成功
Owner 字典	存储桶所有者信息。 返回: 成功 示例: {"DisplayName": "abc-aws-root+721234567890", "ID": "1234567890cbc0f1234567890f1234567890c123456789012123456789091234"}
DisplayName 字符串	存储桶所有者用户的显示名称。 返回: 成功
ID 字符串	存储桶所有者用户 ID。 返回: 成功
bucket_cors 复杂	存储桶 CORS 配置。 返回: 当 bucket_facts=true 且 buckets.bucket_cors=true 时返回
CORSRules 列表 / 元素=字符串	存储桶 CORS 配置。 返回: 当存储桶定义了 CORS 规则时返回 示例: []
bucket_encryption 复杂	存储桶加密配置。 返回: 当 bucket_facts=true 且 buckets.bucket_encryption=true 时返回。 示例: {"ServerSideEncryptionConfiguration": {"Rules": [{"ApplyServerSideEncryptionByDefault": {"SSEAlgorithm": "AES256"}, "BucketKeyEnabled": true}]}}
ServerSideEncryptionConfiguration 复杂	ServerSideEncryptionConfiguration 配置。 返回: 当存储桶启用了加密时返回。
Rules list / elements=dictionary	应用的加密规则列表。 返回: 当存储桶启用了加密时返回。
ApplyServerSideEncryptionByDefault 字典	指定应用于存储桶中新对象的默认服务器端加密。 返回: 成功
KMSMasterKeyID 字符串	用于默认加密的 Amazon Web Services 密钥管理服务 (KMS) 客户 Amazon Web Services KMS 密钥 ID。 返回: 成功
SSEAlgorithm 字符串	用于默认加密的服务器端加密算法。 返回: 成功
BucketKeyEnabled 布尔值	指定 Amazon S3 是否应将 S3 存储桶密钥与使用 KMS (SSE-KMS) 的服务器端加密用于存储桶中的新对象。 返回: 成功
bucket_lifecycle_configuration list / elements=dictionary	存储桶生命周期配置设置。 返回: 当 bucket_facts=true 且 buckets.bucket_lifecycle_configuration=true 时返回。
Rules 列表 / 元素=字符串	生命周期管理规则列表。 返回: 当存在生命周期配置时返回。 示例: [{"ID": "example-rule", "Status": "Enabled"}]
bucket_location 字典	存储桶位置。 返回: 当 bucket_facts=true 且 buckets.bucket_location=true 时返回。 示例: {"LocationConstraint": "us-east-1"}
LocationConstraint 字符串	AWS 区域。 返回: 总是
bucket_logging 复杂	服务器访问日志记录配置。 返回: 当 bucket_facts=true 且 buckets.bucket_logging=true 时返回。
LoggingEnabled 复杂	服务器访问日志记录配置。 返回: 当为存储桶定义了服务器访问日志记录时返回。
TargetBucket 字符串	目标存储桶名称。 返回: 总是 示例: "logging-bucket-name"
TargetPrefix 字符串	目标存储桶中的前缀。 返回: 总是 示例: ""
bucket_name_filter 字符串	用于限制存储桶的字符串。请参阅 name_filter。 返回: 当定义了 name_filter 时返回 示例: "filter-by-this-string"
bucket_notification_configuration 复杂	存储桶通知设置。 返回: 当 bucket_facts=true 且 buckets.bucket_notification_configuration=true 时返回。
TopicConfigurations 列表 / 元素=字符串	通知事件配置列表。 返回: 当配置了至少一个通知时返回。 示例: [{"Events": ["s3:ObjectCreated:Copy"], "Filter": {"Key": {"FilterRules": [{"Name": "Prefix", "Value": "test/"}]}}, "Id": "topic-config-dev001", "TopicArn": "arn:aws:sns:us-west-1:721234567890:sns-dev001-topic"}]
bucket_ownership_controls 复杂	首选对象所有权设置。 返回: 当 bucket_facts=true 且 buckets.bucket_ownership_controls=true 时返回 示例: {"OwnershipControls": {"Rules": [{"ObjectOwnership": "BucketOwnerEnforced"}]}}
OwnershipControls 复杂	对象所有权设置。 返回: 当为存储桶定义了所有权控制时返回。
Rules 列表 / 元素=字符串	所有权规则列表。 返回: 当定义了所有权规则时返回。
bucket_policy 字符串	存储桶策略内容。 返回: 当 bucket_facts=true 且 buckets.bucket_policy=true 时返回。 示例: "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"AddCannedAcl\",\"Effect\":\"Allow\",..}}]}"
bucket_policy_status 字典	存储桶策略的状态。 返回: 当 bucket_facts=true 且 buckets.bucket_policy_status=true 时返回。
PolicyStatus 字典	存储桶策略的状态。 返回: 当存在存储桶策略时返回。
IsPublic 布尔值	报告存储桶策略的公共状态。 返回: 当存在存储桶策略时返回。 示例: true
bucket_replication 复杂	复制配置设置。 返回: 当 bucket_facts=true 且 buckets.bucket_replication=true 时返回。
Role 字符串	用于复制的 IAM 角色。 返回: 当定义了复制规则时返回。 示例: "arn:aws:iam::123:role/example-role"
Rules 列表 / 元素=字符串	复制规则列表。 返回: 当定义了复制规则时返回。 示例: [{"Filter": "{}", "ID": "rule-1"}]
bucket_request_payment 复杂	请求者付费设置。 返回: 当 bucket_facts=true 且 buckets.bucket_request_payment=true 时返回 示例: {"Payer": "BucketOwner"}
Payer 字符串	当前付费者。 返回: 总是
bucket_tagging 字典	存储桶标签。 返回: 当 bucket_facts=true 且 buckets.bucket_tagging=true 时返回。 示例: {"Tag1": "Value1", "Tag2": "Value2"}
bucket_versioning 字典 在 amazon.aws 7.2.0 中添加。	存储桶的版本控制状态。 这还将指定是否在存储桶版本控制配置中启用了 MFA 删除。如果仅在存储桶中配置了 MFA 删除。 返回: 当 bucket_facts=true 且 buckets.bucket_versioning=true 时返回。 示例: {"Status": "Enabled"}
bucket_website 复杂	静态网站托管。 返回: 当 bucket_facts=true 且 buckets.bucket_website=true 时返回。
ErrorDocument 字典	用作 HTTP 错误页面的对象。 返回: 当启用静态网站托管时返回。 示例: {"Key": "error.html"}
IndexDocument 字典	用作 HTTP 索引页面的对象。 返回: 当启用静态网站托管时返回。 示例: {"Suffix": "error.html"}
RedirectAllRequestsTo 复杂	网站重定向设置。 返回: 当配置重定向请求时返回。
HostName 字符串	要重定向的主机名。 返回: 总是 示例: "www.example.com"
Protocol 字符串	用于重定向的协议。 返回: 总是 示例: "https"
creation_date 字符串	存储桶创建日期时间戳。 返回: 总是 示例: "2021-01-21T12:44:10+00:00"
名称 字符串	存储桶名称。 返回: 总是 示例: "a-testing-bucket-name"
public_access_block 字典	存储桶公共访问阻止配置。 返回: 当 bucket_facts=true 且 buckets.public_access_block=true 时返回。 示例: {"PublicAccessBlockConfiguration": {"BlockPublicAcls": true, "BlockPublicPolicy": true, "IgnorePublicAcls": true, "RestrictPublicBuckets": true}}
PublicAccessBlockConfiguration 复杂	PublicAccessBlockConfiguration 数据。 返回: 当为存储桶定义了 PublicAccessBlockConfiguration 时返回
BlockPublicAcls 布尔值	BlockPublicAcls 设置值。 返回: 成功
BlockPublicPolicy 布尔值	BlockPublicPolicy 设置值。 返回: 成功
IgnorePublicAcls 布尔值	IgnorePublicAcls 设置值。 返回: 成功
RestrictPublicBuckets 布尔值	RestrictPublicBuckets 设置值。 返回: 成功

作者

• Gerben Geijteman (@hyperized)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 通信