s3_bucket_*: Refactor S3 modules to use shared utilities and rename for consistency - #2472
s3_bucket_*: Refactor S3 modules to use shared utilities and rename for consistency#2472tremble wants to merge 4 commits into
Conversation
Docs Build 📝Thank you for contribution!✨ The docsite for this PR is available for download as an artifact from this run: You can compare to the docs for the File changes:
Click to see the diff comparison.NOTE: only file modifications are shown here. New and deleted files are excluded. The diff output was truncated because it exceeded the maximum size. diff --git a/home/runner/work/community.aws/community.aws/docsbuild/base/collections/community/aws/index.html b/home/runner/work/community.aws/community.aws/docsbuild/head/collections/community/aws/index.html
index 4ec2fe4..e0c64a5 100644
--- a/home/runner/work/community.aws/community.aws/docsbuild/base/collections/community/aws/index.html
+++ b/home/runner/work/community.aws/community.aws/docsbuild/head/collections/community/aws/index.html
@@ -286,13 +286,18 @@
<li><p><a class="reference internal" href="redshift_info_module.html#ansible-collections-community-aws-redshift-info-module"><span class="std std-ref">redshift_info module</span></a> – Gather information about Redshift cluster(s)</p></li>
<li><p><a class="reference internal" href="redshift_subnet_group_module.html#ansible-collections-community-aws-redshift-subnet-group-module"><span class="std std-ref">redshift_subnet_group module</span></a> – manage Redshift cluster subnet groups</p></li>
<li><p><a class="reference internal" href="route53_wait_module.html#ansible-collections-community-aws-route53-wait-module"><span class="std std-ref">route53_wait module</span></a> – wait for changes in Amazons Route 53 DNS service to propagate</p></li>
+<li><p><a class="reference internal" href="s3_bucket_cors_module.html#ansible-collections-community-aws-s3-bucket-cors-module"><span class="std std-ref">s3_bucket_cors module</span></a> – Manage CORS for S3 buckets in AWS</p></li>
+<li><p><a class="reference internal" href="s3_bucket_cors_info_module.html#ansible-collections-community-aws-s3-bucket-cors-info-module"><span class="std std-ref">s3_bucket_cors_info module</span></a> – Retrieve CORS configuration for S3 buckets</p></li>
+<li><p><a class="reference internal" href="s3_bucket_lifecycle_module.html#ansible-collections-community-aws-s3-bucket-lifecycle-module"><span class="std std-ref">s3_bucket_lifecycle module</span></a> – Manage S3 bucket lifecycle rules in AWS</p></li>
+<li><p><a class="reference internal" href="s3_bucket_lifecycle_info_module.html#ansible-collections-community-aws-s3-bucket-lifecycle-info-module"><span class="std std-ref">s3_bucket_lifecycle_info module</span></a> – Retrieve lifecycle configuration for S3 buckets</p></li>
+<li><p><a class="reference internal" href="s3_bucket_metrics_configuration_module.html#ansible-collections-community-aws-s3-bucket-metrics-configuration-module"><span class="std std-ref">s3_bucket_metrics_configuration module</span></a> – Manage s3 bucket metrics configuration in AWS</p></li>
+<li><p><a class="reference internal" href="s3_bucket_metrics_configuration_info_module.html#ansible-collections-community-aws-s3-bucket-metrics-configuration-info-module"><span class="std std-ref">s3_bucket_metrics_configuration_info module</span></a> – Retrieve information about S3 bucket metrics configurations</p></li>
<li><p><a class="reference internal" href="s3_bucket_notification_module.html#ansible-collections-community-aws-s3-bucket-notification-module"><span class="std std-ref">s3_bucket_notification module</span></a> – Creates, updates or deletes S3 Bucket notifications targeting Lambda functions, SNS or SQS.</p></li>
-<li><p><a class="reference internal" href="s3_cors_module.html#ansible-collections-community-aws-s3-cors-module"><span class="std std-ref">s3_cors module</span></a> – Manage CORS for S3 buckets in AWS</p></li>
-<li><p><a class="reference internal" href="s3_lifecycle_module.html#ansible-collections-community-aws-s3-lifecycle-module"><span class="std std-ref">s3_lifecycle module</span></a> – Manage S3 bucket lifecycle rules in AWS</p></li>
+<li><p><a class="reference internal" href="s3_bucket_notification_info_module.html#ansible-collections-community-aws-s3-bucket-notification-info-module"><span class="std std-ref">s3_bucket_notification_info module</span></a> – Retrieve notification configuration for S3 buckets</p></li>
+<li><p><a class="reference internal" href="s3_bucket_website_module.html#ansible-collections-community-aws-s3-bucket-website-module"><span class="std std-ref">s3_bucket_website module</span></a> – Configure an s3 bucket as a website</p></li>
+<li><p><a class="reference internal" href="s3_bucket_website_info_module.html#ansible-collections-community-aws-s3-bucket-website-info-module"><span class="std std-ref">s3_bucket_website_info module</span></a> – Retrieve website configuration for S3 buckets</p></li>
<li><p><a class="reference internal" href="s3_logging_module.html#ansible-collections-community-aws-s3-logging-module"><span class="std std-ref">s3_logging module</span></a> – Manage logging facility of an s3 bucket in AWS</p></li>
-<li><p><a class="reference internal" href="s3_metrics_configuration_module.html#ansible-collections-community-aws-s3-metrics-configuration-module"><span class="std std-ref">s3_metrics_configuration module</span></a> – Manage s3 bucket metrics configuration in AWS</p></li>
<li><p><a class="reference internal" href="s3_sync_module.html#ansible-collections-community-aws-s3-sync-module"><span class="std std-ref">s3_sync module</span></a> – Efficiently upload multiple files to S3</p></li>
-<li><p><a class="reference internal" href="s3_website_module.html#ansible-collections-community-aws-s3-website-module"><span class="std std-ref">s3_website module</span></a> – Configure an s3 bucket as a website</p></li>
<li><p><a class="reference internal" href="secretsmanager_secret_module.html#ansible-collections-community-aws-secretsmanager-secret-module"><span class="std std-ref">secretsmanager_secret module</span></a> – Manage secrets stored in AWS Secrets Manager</p></li>
<li><p><a class="reference internal" href="ses_identity_module.html#ansible-collections-community-aws-ses-identity-module"><span class="std std-ref">ses_identity module</span></a> – Manages SES email and domain identity</p></li>
<li><p><a class="reference internal" href="ses_identity_policy_module.html#ansible-collections-community-aws-ses-identity-policy-module"><span class="std std-ref">ses_identity_policy module</span></a> – Manages SES sending authorization policies</p></li>
diff --git a/home/runner/work/community.aws/community.aws/docsbuild/base/collections/community/aws/route53_wait_module.html b/home/runner/work/community.aws/community.aws/docsbuild/head/collections/community/aws/route53_wait_module.html
index ed225f7..145bbe4 100644
--- a/home/runner/work/community.aws/community.aws/docsbuild/base/collections/community/aws/route53_wait_module.html
+++ b/home/runner/work/community.aws/community.aws/docsbuild/head/collections/community/aws/route53_wait_module.html
@@ -22,7 +22,7 @@
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="search" title="Search" href="../../../search.html" />
- <link rel="next" title="community.aws.s3_bucket_notification module – Creates, updates or deletes S3 Bucket notifications targeting Lambda functions, SNS or SQS." href="s3_bucket_notification_module.html" />
+ <link rel="next" title="community.aws.s3_bucket_cors module – Manage CORS for S3 buckets in AWS" href="s3_bucket_cors_module.html" />
<link rel="prev" title="community.aws.redshift_subnet_group module – manage Redshift cluster subnet groups" href="redshift_subnet_group_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
@@ -394,7 +394,7 @@ see <a class="reference internal" href="#ansible-collections-community-aws-route
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="redshift_subnet_group_module.html" class="btn btn-neutral float-left" title="community.aws.redshift_subnet_group module – manage Redshift cluster subnet groups" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
- <a href="s3_bucket_notification_module.html" class="btn btn-neutral float-right" title="community.aws.s3_bucket_notification module – Creates, updates or deletes S3 Bucket notifications targeting Lambda functions, SNS or SQS." accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+ <a href="s3_bucket_cors_module.html" class="btn btn-neutral float-right" title="community.aws.s3_bucket_cors module – Manage CORS for S3 buckets in AWS" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
diff --git a/home/runner/work/community.aws/community.aws/docsbuild/base/collections/community/aws/s3_bucket_notification_module.html b/home/runner/work/community.aws/community.aws/docsbuild/head/collections/community/aws/s3_bucket_notification_module.html
index 6507ea0..0b9564c 100644
--- a/home/runner/work/community.aws/community.aws/docsbuild/base/collections/community/aws/s3_bucket_notification_module.html
+++ b/home/runner/work/community.aws/community.aws/docsbuild/head/collections/community/aws/s3_bucket_notification_module.html
@@ -22,8 +22,8 @@
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="search" title="Search" href="../../../search.html" />
- <link rel="next" title="community.aws.s3_cors module – Manage CORS for S3 buckets in AWS" href="s3_cors_module.html" />
- <link rel="prev" title="community.aws.route53_wait module – wait for changes in Amazons Route 53 DNS service to propagate" href="route53_wait_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
+ <link rel="next" title="community.aws.s3_bucket_notification_info module – Retrieve notification configuration for S3 buckets" href="s3_bucket_notification_info_module.html" />
+ <link rel="prev" title="community.aws.s3_bucket_metrics_configuration_info module – Retrieve information about S3 bucket metrics configurations" href="s3_bucket_metrics_configuration_info_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
@@ -521,8 +521,8 @@ see <a class="reference internal" href="#ansible-collections-community-aws-s3-bu
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
- <a href="route53_wait_module.html" class="btn btn-neutral float-left" title="community.aws.route53_wait module – wait for changes in Amazons Route 53 DNS service to propagate" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
- <a href="s3_cors_module.html" class="btn btn-neutral float-right" title="community.aws.s3_cors module – Manage CORS for S3 buckets in AWS" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+ <a href="s3_bucket_metrics_configuration_info_module.html" class="btn btn-neutral float-left" title="community.aws.s3_bucket_metrics_configuration_info module – Retrieve information about S3 bucket metrics configurations" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+ <a href="s3_bucket_notification_info_module.html" class="btn btn-neutral float-right" title="community.aws.s3_bucket_notification_info module – Retrieve notification configuration for S3 buckets" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
diff --git a/home/runner/work/community.aws/community.aws/docsbuild/base/collections/community/aws/s3_cors_module.html b/home/runner/work/community.aws/community.aws/docsbuild/head/collections/community/aws/s3_cors_module.html
index f652bcd..d92442a 100644
--- a/home/runner/work/community.aws/community.aws/docsbuild/base/collections/community/aws/s3_cors_module.html
+++ b/home/runner/work/community.aws/community.aws/docsbuild/head/collections/community/aws/s3_cors_module.html
@@ -7,7 +7,7 @@
<meta content="2.24.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <title>community.aws.s3_cors module – Manage CORS for S3 buckets in AWS — Ansible collections documentation</title>
+ <title>community.aws.s3_cors module — Ansible collections documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=41de9001" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/ansible.css?v=b54c304f" />
<link rel="stylesheet" type="text/css" href="../../../_static/antsibull-minimal.css" />
@@ -21,9 +21,7 @@
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../../../_static/js/theme.js"></script>
- <link rel="search" title="Search" href="../../../search.html" />
- <link rel="next" title="community.aws.s3_lifecycle module – Manage S3 bucket lifecycle rules in AWS" href="s3_lifecycle_module.html" />
- <link rel="prev" title="community.aws.s3_bucket_notification module – Creates, updates or deletes S3 Bucket notifications targeting Lambda functions, SNS or SQS." href="s3_bucket_notification_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
+ <link rel="search" title="Search" href="../../../search.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
@@ -74,20 +72,8 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p>
-<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Collection Index</a><ul class="current">
-<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Collections in the Community Namespace</a><ul class="current">
-<li class="toctree-l3 current"><a class="reference internal" href="index.html">Community.Aws</a><ul class="current">
-<li class="toctree-l4"><a class="reference internal" href="index.html#description">Description</a></li>
-<li class="toctree-l4"><a class="reference internal" href="index.html#communication">Communication</a></li>
-<li class="toctree-l4"><a class="reference internal" href="index.html#changelog">Changelog</a></li>
-<li class="toctree-l4 current"><a class="reference internal" href="index.html#plugin-index">Plugin Index</a></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</li>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../index.html">Collection Index</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p>
<ul>
@@ -114,13 +100,8 @@
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
- <li class="breadcrumb-item"><a href="../../index.html">Collection Index</a></li>
- <li class="breadcrumb-item"><a href="../index.html">Collections in the Community Namespace</a></li>
- <li class="breadcrumb-item"><a href="index.html">Community.Aws</a></li>
- <li class="breadcrumb-item active">community.aws.s3_cors module – Manage CORS for S3 buckets in AWS</li>
+ <li class="breadcrumb-item active">community.aws.s3_cors module</li>
<li class="wy-breadcrumbs-aside">
- <!-- User defined GitHub URL -->
- <a href="https://github.com/ansible-collections/community.aws/edit/main/plugins/modules/s3_cors.py?description=%23%23%23%23%23%20SUMMARY%0A%3C!—%20Your%20description%20here%20–%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
@@ -130,292 +111,17 @@
<div itemprop="articleBody">
- <span class="target" id="ansible-collections-community-aws-s3-cors-module"></span><section id="community-aws-s3-cors-module-manage-cors-for-s3-buckets-in-aws">
-<h1>community.aws.s3_cors module – Manage CORS for S3 buckets in AWS<a class="headerlink" href="#community-aws-s3-cors-module-manage-cors-for-s3-buckets-in-aws" title="Link to this heading"></a></h1>
+ <span class="target" id="ansible-collections-community-aws-s3-cors-module"></span><section id="community-aws-s3-cors-module">
+<h1>community.aws.s3_cors module<a class="headerlink" href="#community-aws-s3-cors-module" title="Link to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
-<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/aws/">community.aws collection</a> (version 12.0.0-dev0).</p>
-<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
-To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
-<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.aws</span></code>.
-You need further requirements to be able to use this module,
-see <a class="reference internal" href="#ansible-collections-community-aws-s3-cors-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
+<p>This redirect is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/aws/">community.aws collection</a> (version 12.0.0-dev0).</p>
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">community.aws.s3_cors</span></code>.</p>
</div>
-<p class="ansible-version-added">New in community.aws 1.0.0</p>
-<nav class="contents local" id="contents">
<ul class="simple">
-<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
-<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
-<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
-<li><p><a class="reference internal" href="#notes" id="id4">Notes</a></p></li>
-<li><p><a class="reference internal" href="#examples" id="id5">Examples</a></p></li>
-<li><p><a class="reference internal" href="#return-values" id="id6">Return Values</a></p></li>
+<li><p>This is a redirect to the <a class="reference internal" href="s3_bucket_cors_module.html#ansible-collections-community-aws-s3-bucket-cors-module"><span class="std std-ref">community.aws.s3_bucket_cors module</span></a>.</p></li>
+<li><p>This redirect does <strong>not</strong> work with Ansible 2.9.</p></li>
</ul>
-</nav>
-<section id="synopsis">
-<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
-<ul class="simple">
-<li><p>Manage CORS for S3 buckets in AWS.</p></li>
-<li><p>Prior to release 5.0.0 this module was called <code class="docutils literal notranslate"><span class="pre">community.aws.aws_s3_cors</span></code>. The usage did not change.</p></li>
-</ul>
-<p>Aliases: aws_s3_cors</p>
-</section>
-<section id="requirements">
-<span id="ansible-collections-community-aws-s3-cors-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Link to this heading"></a></h2>
-<p>The below requirements are needed on the host that executes this module.</p>
-<ul class="simple">
-<li><p>python >= 3.6</p></li>
-<li><p>boto3 >= 1.38.23</p></li>
-<li><p>botocore >= 1.38.23</p></li>
-</ul>
-</section>
-<section id="parameters">
-<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link to this heading"></a></h2>
-<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
-<thead>
-<tr class="row-odd"><th class="head"><p>Parameter</p></th>
-<th class="head"><p>Comments</p></th>
-</tr>
-</thead>
-<tbody>
-<tr class="row-even"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="parameter-access_key"></div>
-<div class="ansibleOptionAnchor" id="parameter-aws_access_key_id"></div>
-<div class="ansibleOptionAnchor" id="parameter-aws_access_key"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-cors-module-parameter-aws-access-key-id"><span id="ansible-collections-community-aws-s3-cors-module-parameter-aws-access-key"></span><span id="ansible-collections-community-aws-s3-cors-module-parameter-access-key"></span><strong>access_key</strong></p>
-<a class="ansibleOptionLink" href="#parameter-access_key" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: aws_access_key_id, aws_access_key</span></p>
-<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>AWS access key ID.</p>
-<p>See the AWS documentation for more information about access tokens <a class="reference external" href="https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys">https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys</a>.</p>
-<p>The <code class="docutils literal notranslate"><span class="pre">AWS_ACCESS_KEY_ID</span></code> or <code class="docutils literal notranslate"><span class="pre">AWS_ACCESS_KEY</span></code> environment variables may also be used in decreasing order of preference.</p>
-<p>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</p>
-<p>The <em>aws_access_key_id</em> alias was added in release 5.1.0 for consistency with the AWS botocore SDK.</p>
-</div></td>
-</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="parameter-aws_ca_bundle"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-cors-module-parameter-aws-ca-bundle"><strong>aws_ca_bundle</strong></p>
-<a class="ansibleOptionLink" href="#parameter-aws_ca_bundle" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>The location of a CA Bundle to use when validating SSL certificates.</p>
-<p>The <code class="docutils literal notranslate"><span class="pre">AWS_CA_BUNDLE</span></code> environment variable may also be used.</p>
-</div></td>
-</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="parameter-aws_config"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-cors-module-parameter-aws-config"><strong>aws_config</strong></p>
-<a class="ansibleOptionLink" href="#parameter-aws_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>A dictionary to modify the botocore configuration.</p>
-<p>Parameters can be found in the AWS documentation <a class="reference external" href="https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config">https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</p>
-</div></td>
-</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="parameter-debug_botocore_endpoint_logs"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-cors-module-parameter-debug-botocore-endpoint-logs"><strong>debug_botocore_endpoint_logs</strong></p>
-<a class="ansibleOptionLink" href="#parameter-debug_botocore_endpoint_logs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>Use a <code class="docutils literal notranslate"><span class="pre">botocore.endpoint</span></code> logger to parse the unique (rather than total) <code class="docutils literal notranslate"><span class="pre">"resource:action"</span></code> API calls made during a task, outputing the set to the resource_actions key in the task results. Use the <code class="docutils literal notranslate"><span class="pre">aws_resource_action</span></code> callback to output to total list made during a playbook.</p>
-<p>The <code class="docutils literal notranslate"><span class="pre">ANSIBLE_DEBUG_BOTOCORE_LOGS</span></code> environment variable may also be used.</p>
-<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
-<ul class="simple">
-<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
-<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
-</ul>
-</div></td>
-</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="parameter-endpoint_url"></div>
-<div class="ansibleOptionAnchor" id="parameter-aws_endpoint_url"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-cors-module-parameter-endpoint-url"><span id="ansible-collections-community-aws-s3-cors-module-parameter-aws-endpoint-url"></span><strong>endpoint_url</strong></p>
-<a class="ansibleOptionLink" href="#parameter-endpoint_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: aws_endpoint_url</span></p>
-<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>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.</p>
-<p>The <code class="docutils literal notranslate"><span class="pre">AWS_URL</span></code> environment variable may also be used.</p>
-</div></td>
-</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-cors-module-parameter-name"><strong>name</strong></p>
-<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>Name of the S3 bucket.</p>
-</div></td>
-</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="parameter-profile"></div>
-<div class="ansibleOptionAnchor" id="parameter-aws_profile"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-cors-module-parameter-profile"><span id="ansible-collections-community-aws-s3-cors-module-parameter-aws-profile"></span><strong>profile</strong></p>
-<a class="ansibleOptionLink" href="#parameter-profile" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: aws_profile</span></p>
-<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>A named AWS profile to use for authentication.</p>
-<p>See the AWS documentation for more information about named profiles <a class="reference external" href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html">https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html</a>.</p>
-<p>The <code class="docutils literal notranslate"><span class="pre">AWS_PROFILE</span></code> environment variable may also be used.</p>
-<p>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>session_token</em> options.</p>
-</div></td>
-</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="parameter-region"></div>
-<div class="ansibleOptionAnchor" id="parameter-aws_region"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-cors-module-parameter-region"><span id="ansible-collections-community-aws-s3-cors-module-parameter-aws-region"></span><strong>region</strong></p>
-<a class="ansibleOptionLink" href="#parameter-region" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: aws_region</span></p>
-<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>The AWS region to use.</p>
-<p>For global services such as IAM, Route53 and CloudFront, <em>region</em> is ignored.</p>
-<p>The <code class="docutils literal notranslate"><span class="pre">AWS_REGION</span></code> environment variable may also be used.</p>
-<p>See the Amazon AWS documentation for more information <a class="reference external" href="http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region">http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region</a>.</p>
-</div></td>
-</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="parameter-rules"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-cors-module-parameter-rules"><strong>rules</strong></p>
-<a class="ansibleOptionLink" href="#parameter-rules" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>Cors rules to put on the S3 bucket.</p>
-</div></td>
-</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="parameter-secret_key"></div>
-<div class="ansibleOptionAnchor" id="parameter-aws_secret_access_key"></div>
-<div class="ansibleOptionAnchor" id="parameter-aws_secret_key"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-cors-module-parameter-secret-key"><span id="ansible-collections-community-aws-s3-cors-module-parameter-aws-secret-key"></span><span id="ansible-collections-community-aws-s3-cors-module-parameter-aws-secret-access-key"></span><strong>secret_key</strong></p>
-<a class="ansibleOptionLink" href="#parameter-secret_key" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: aws_secret_access_key, aws_secret_key</span></p>
-<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>AWS secret access key.</p>
-<p>See the AWS documentation for more information about access tokens <a class="reference external" href="https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys">https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys</a>.</p>
-<p>The <code class="docutils literal notranslate"><span class="pre">AWS_SECRET_ACCESS_KEY</span></code> or <code class="docutils literal notranslate"><span class="pre">AWS_SECRET_KEY</span></code> environment variables may also be used in decreasing order of preference.</p>
-<p>The <em>secret_key</em> and <em>profile</em> options are mutually exclusive.</p>
-<p>The <em>aws_secret_access_key</em> alias was added in release 5.1.0 for consistency with the AWS botocore SDK.</p>
-</div></td>
-</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="parameter-session_token"></div>
-<div class="ansibleOptionAnchor" id="parameter-aws_session_token"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-cors-module-parameter-session-token"><span id="ansible-collections-community-aws-s3-cors-module-parameter-aws-session-token"></span><strong>session_token</strong></p>
-<a class="ansibleOptionLink" href="#parameter-session_token" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: aws_session_token</span></p>
-<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>AWS STS session token for use with temporary credentials.</p>
-<p>See the AWS documentation for more information about access tokens <a class="reference external" href="https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys">https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys</a>.</p>
-<p>The <code class="docutils literal notranslate"><span class="pre">AWS_SESSION_TOKEN</span></code> environment variable may also be used.</p>
-<p>The <em>session_token</em> and <em>profile</em> options are mutually exclusive.</p>
-</div></td>
-</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-cors-module-parameter-state"><strong>state</strong></p>
-<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>Create or remove cors on the S3 bucket.</p>
-<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
-<ul class="simple">
-<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"present"</span></code></p></li>
-<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"absent"</span></code></p></li>
-</ul>
-</div></td>
-</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="parameter-validate_certs"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-cors-module-parameter-validate-certs"><strong>validate_certs</strong></p>
-<a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>When set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, SSL certificates will not be validated for communication with the AWS APIs.</p>
-<p>Setting <em>validate_certs=false</em> is strongly discouraged, as an alternative, consider setting <em>aws_ca_bundle</em> instead.</p>
-<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
-<ul class="simple">
-<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
-<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
-</ul>
-</div></td>
-</tr>
-</tbody>
-</table>
-</section>
-<section id="notes">
-<h2><a class="toc-backref" href="#id4" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Link to this heading"></a></h2>
-<div class="admonition note">
-<p class="admonition-title">Note</p>
-<ul class="simple">
-<li><p><strong>Caution:</strong> 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.</p></li>
-<li><p>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 <code class="docutils literal notranslate"><span class="pre">~/.aws/credentials</span></code>). See <a class="reference external" href="https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html">https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html</a> for more information.</p></li>
-</ul>
-</div>
-</section>
-<section id="examples">
-<h2><a class="toc-backref" href="#id5" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
-<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="c1"># Note: These examples do not set authentication details, see the AWS Guide for details.</span>
-
-<span class="c1"># Create a simple cors for s3 bucket</span>
-<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">community.aws.s3_cors</span><span class="p">:</span>
-<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mys3bucket</span>
-<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span>
-<span class="w"> </span><span class="nt">rules</span><span class="p">:</span>
-<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">allowed_origins</span><span class="p">:</span>
-<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http://www.example.com/</span>
-<span class="w"> </span><span class="nt">allowed_methods</span><span class="p">:</span>
-<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">GET</span>
-<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">POST</span>
-<span class="w"> </span><span class="nt">allowed_headers</span><span class="p">:</span>
-<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Authorization</span>
-<span class="w"> </span><span class="nt">expose_headers</span><span class="p">:</span>
-<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">x-amz-server-side-encryption</span>
-<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">x-amz-request-id</span>
-<span class="w"> </span><span class="nt">max_age_seconds</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">30000</span>
-
-<span class="c1"># Remove cors for s3 bucket</span>
-<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">community.aws.s3_cors</span><span class="p">:</span>
-<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mys3bucket</span>
-<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">absent</span>
-</pre></div>
-</div>
-</section>
-<section id="return-values">
-<h2><a class="toc-backref" href="#id6" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2>
-<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/projects/ansible-core/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible Core devel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
-<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
-<thead>
-<tr class="row-odd"><th class="head"><p>Key</p></th>
-<th class="head"><p>Description</p></th>
-</tr>
-</thead>
-<tbody>
-<tr class="row-even"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="return-changed"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-cors-module-return-changed"><strong>changed</strong></p>
-<a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>check to see if a change was made to the rules</p>
-<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
-<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">true</span></code></p>
-</div></td>
-</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="return-name"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-cors-module-return-name"><strong>name</strong></p>
-<a class="ansibleOptionLink" href="#return-name" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>name of bucket</p>
-<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
-<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"bucket-name"</span></code></p>
-</div></td>
-</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="return-rules"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-cors-module-return-rules"><strong>rules</strong></p>
-<a class="ansibleOptionLink" href="#return-rules" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>list of current rules</p>
-<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
-<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{"allowed_headers":</span> <span class="pre">["Authorization"],</span> <span class="pre">"allowed_methods":</span> <span class="pre">["GET"],</span> <span class="pre">"allowed_origins":</span> <span class="pre">["*"],</span> <span class="pre">"max_age_seconds":</span> <span class="pre">30000}]</span></code></p>
-</div></td>
-</tr>
-</tbody>
-</table>
-<section id="authors">
-<h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
-<ul class="simple">
-<li><p>Oyvind Saltvik (@fivethreeo)</p></li>
-</ul>
-</section>
-<section id="collection-links">
-<h3>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h3>
-<ul class="ansible-links">
-<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/ansible-collections/community.aws/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
-<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/ansible-collections/community.aws" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
-<li><span><a class="reference internal" href="index.html#communication-for-community-aws"><span class="std std-ref">Communication</span></a></span></li>
-</ul>
-</section>
-</section>
</section>
@@ -423,10 +129,7 @@ see <a class="reference internal" href="#ansible-collections-community-aws-s3-co
</div>
-<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
- <a href="s3_bucket_notification_module.html" class="btn btn-neutral float-left" title="community.aws.s3_bucket_notification module – Creates, updates or deletes S3 Bucket notifications targeting Lambda functions, SNS or SQS." accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
- <a href="s3_lifecycle_module.html" class="btn btn-neutral float-right" title="community.aws.s3_lifecycle module – Manage S3 bucket lifecycle rules in AWS" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
- </div>
+<footer>
<hr/>
diff --git a/home/runner/work/community.aws/community.aws/docsbuild/base/collections/community/aws/s3_lifecycle_module.html b/home/runner/work/community.aws/community.aws/docsbuild/head/collections/community/aws/s3_lifecycle_module.html
index 8da89c1..05a746d 100644
--- a/home/runner/work/community.aws/community.aws/docsbuild/base/collections/community/aws/s3_lifecycle_module.html
+++ b/home/runner/work/community.aws/community.aws/docsbuild/head/collections/community/aws/s3_lifecycle_module.html
@@ -7,7 +7,7 @@
<meta content="2.24.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <title>community.aws.s3_lifecycle module – Manage S3 bucket lifecycle rules in AWS — Ansible collections documentation</title>
+ <title>community.aws.s3_lifecycle module — Ansible collections documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=41de9001" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/ansible.css?v=b54c304f" />
<link rel="stylesheet" type="text/css" href="../../../_static/antsibull-minimal.css" />
@@ -21,9 +21,7 @@
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../../../_static/js/theme.js"></script>
- <link rel="search" title="Search" href="../../../search.html" />
- <link rel="next" title="community.aws.s3_logging module – Manage logging facility of an s3 bucket in AWS" href="s3_logging_module.html" />
- <link rel="prev" title="community.aws.s3_cors module – Manage CORS for S3 buckets in AWS" href="s3_cors_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
+ <link rel="search" title="Search" href="../../../search.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
@@ -74,20 +72,8 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p>
-<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Collection Index</a><ul class="current">
-<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Collections in the Community Namespace</a><ul class="current">
-<li class="toctree-l3 current"><a class="reference internal" href="index.html">Community.Aws</a><ul class="current">
-<li class="toctree-l4"><a class="reference internal" href="index.html#description">Description</a></li>
-<li class="toctree-l4"><a class="reference internal" href="index.html#communication">Communication</a></li>
-<li class="toctree-l4"><a class="reference internal" href="index.html#changelog">Changelog</a></li>
-<li class="toctree-l4 current"><a class="reference internal" href="index.html#plugin-index">Plugin Index</a></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</li>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../index.html">Collection Index</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p>
<ul>
@@ -114,13 +100,8 @@
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
- <li class="breadcrumb-item"><a href="../../index.html">Collection Index</a></li>
- <li class="breadcrumb-item"><a href="../index.html">Collections in the Community Namespace</a></li>
- <li class="breadcrumb-item"><a href="index.html">Community.Aws</a></li>
- <li class="breadcrumb-item active">community.aws.s3_lifecycle module – Manage S3 bucket lifecycle rules in AWS</li>
+ <li class="breadcrumb-item active">community.aws.s3_lifecycle module</li>
<li class="wy-breadcrumbs-aside">
- <!-- User defined GitHub URL -->
- <a href="https://github.com/ansible-collections/community.aws/edit/main/plugins/modules/s3_lifecycle.py?description=%23%23%23%23%23%20SUMMARY%0A%3C!—%20Your%20description%20here%20–%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
@@ -130,484 +111,17 @@
<div itemprop="articleBody">
- <span class="target" id="ansible-collections-community-aws-s3-lifecycle-module"></span><section id="community-aws-s3-lifecycle-module-manage-s3-bucket-lifecycle-rules-in-aws">
-<h1>community.aws.s3_lifecycle module – Manage S3 bucket lifecycle rules in AWS<a class="headerlink" href="#community-aws-s3-lifecycle-module-manage-s3-bucket-lifecycle-rules-in-aws" title="Link to this heading"></a></h1>
+ <span class="target" id="ansible-collections-community-aws-s3-lifecycle-module"></span><section id="community-aws-s3-lifecycle-module">
+<h1>community.aws.s3_lifecycle module<a class="headerlink" href="#community-aws-s3-lifecycle-module" title="Link to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
-<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/aws/">community.aws collection</a> (version 12.0.0-dev0).</p>
-<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
-To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
-<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.aws</span></code>.
-You need further requirements to be able to use this module,
-see <a class="reference internal" href="#ansible-collections-community-aws-s3-lifecycle-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
+<p>This redirect is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/aws/">community.aws collection</a> (version 12.0.0-dev0).</p>
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">community.aws.s3_lifecycle</span></code>.</p>
</div>
-<p class="ansible-version-added">New in community.aws 1.0.0</p>
-<nav class="contents local" id="contents">
<ul class="simple">
-<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
-<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
-<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
-<li><p><a class="reference internal" href="#notes" id="id4">Notes</a></p></li>
-<li><p><a class="reference internal" href="#examples" id="id5">Examples</a></p></li>
+<li><p>This is a redirect to the <a class="reference internal" href="s3_bucket_lifecycle_module.html#ansible-collections-community-aws-s3-bucket-lifecycle-module"><span class="std std-ref">community.aws.s3_bucket_lifecycle module</span></a>.</p></li>
+<li><p>This redirect does <strong>not</strong> work with Ansible 2.9.</p></li>
</ul>
-</nav>
-<section id="synopsis">
-<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
-<ul class="simple">
-<li><p>Manage S3 bucket lifecycle rules in AWS.</p></li>
-</ul>
-</section>
-<section id="requirements">
-<span id="ansible-collections-community-aws-s3-lifecycle-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Link to this heading"></a></h2>
-<p>The below requirements are needed on the host that executes this module.</p>
-<ul class="simple">
-<li><p>python >= 3.6</p></li>
-<li><p>boto3 >= 1.38.23</p></li>
-<li><p>botocore >= 1.38.23</p></li>
-</ul>
-</section>
-<section id="parameters">
-<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link to this heading"></a></h2>
-<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
-<thead>
-<tr class="row-odd"><th class="head"><p>Parameter</p></th>
-<th class="head"><p>Comments</p></th>
-</tr>
-</thead>
-<tbody>
-<tr class="row-even"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="parameter-abort_incomplete_multipart_upload_days"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-lifecycle-module-parameter-abort-incomplete-multipart-upload-days"><strong>abort_incomplete_multipart_upload_days</strong></p>
-<a class="ansibleOptionLink" href="#parameter-abort_incomplete_multipart_upload_days" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
-<p><em class="ansible-option-versionadded">added in community.aws 2.2.0</em></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload.</p>
-</div></td>
-</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="parameter-access_key"></div>
-<div class="ansibleOptionAnchor" id="parameter-aws_access_key_id"></div>
-<div class="ansibleOptionAnchor" id="parameter-aws_access_key"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-lifecycle-module-parameter-aws-access-key-id"><span id="ansible-collections-community-aws-s3-lifecycle-module-parameter-aws-access-key"></span><span id="ansible-collections-community-aws-s3-lifecycle-module-parameter-access-key"></span><strong>access_key</strong></p>
-<a class="ansibleOptionLink" href="#parameter-access_key" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: aws_access_key_id, aws_access_key</span></p>
-<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>AWS access key ID.</p>
-<p>See the AWS documentation for more information about access tokens <a class="reference external" href="https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys">https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys</a>.</p>
-<p>The <code class="docutils literal notranslate"><span class="pre">AWS_ACCESS_KEY_ID</span></code> or <code class="docutils literal notranslate"><span class="pre">AWS_ACCESS_KEY</span></code> environment variables may also be used in decreasing order of preference.</p>
-<p>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</p>
-<p>The <em>aws_access_key_id</em> alias was added in release 5.1.0 for consistency with the AWS botocore SDK.</p>
-</div></td>
-</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="parameter-aws_ca_bundle"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-lifecycle-module-parameter-aws-ca-bundle"><strong>aws_ca_bundle</strong></p>
-<a class="ansibleOptionLink" href="#parameter-aws_ca_bundle" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>The location of a CA Bundle to use when validating SSL certificates.</p>
-<p>The <code class="docutils literal notranslate"><span class="pre">AWS_CA_BUNDLE</span></code> environment variable may also be used.</p>
-</div></td>
-</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="parameter-aws_config"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-lifecycle-module-parameter-aws-config"><strong>aws_config</strong></p>
-<a class="ansibleOptionLink" href="#parameter-aws_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>A dictionary to modify the botocore configuration.</p>
-<p>Parameters can be found in the AWS documentation <a class="reference external" href="https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config">https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</p>
-</div></td>
-</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
-<div class="ansibleOptionAnchor" id="parameter-debug_botocore_endpoint_logs"></div><p class="ansible-option-title" id="ansible-collections-community-aws-s3-lifecycle-module-parameter-debug-botocore-endpoint-logs"><strong>debug_botocore_endpoint_logs</strong></p>
-<a class="ansibleOptionLink" href="#parameter-debug_botocore_endpoint_logs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
-</div></td>
-<td><div class="ansible-option-cell"><p>Use a <code class="docutils literal notranslate"><span class="pre">botocore.endpoint</span></code> logger to parse the unique (rather than total) <code class="docutils literal notranslate"><span class="pre">"resource:action"</span></code> API calls made during a task, outputin |
|
Build succeeded. ✔️ ansible-galaxy-importer SUCCESS in 4m 38s (non-voting) |
|
Build succeeded. ✔️ ansible-galaxy-importer SUCCESS in 4m 36s (non-voting) |
…utilities Rename S3 configuration modules to follow s3_bucket_* naming convention: - s3_cors → s3_bucket_cors - s3_lifecycle → s3_bucket_lifecycle - s3_metrics_configuration → s3_bucket_metrics_configuration - s3_website → s3_bucket_website Add new _info modules for retrieving configuration: - s3_bucket_cors_info - s3_bucket_lifecycle_info - s3_bucket_metrics_configuration_info - s3_bucket_notification_info - s3_bucket_website_info Create shared module_utils infrastructure: - plugins/module_utils/s3.py: Common S3 utilities and helpers - plugins/module_utils/_s3/: Specialised S3 functionality modules Update meta/runtime.yml with redirects from old module names to new names for backwards compatibility, and add new modules to action groups. Update all integration and unit tests to use new module names. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add changelog fragment documenting the rename of s3_cors, s3_lifecycle, s3_metrics_configuration, and s3_website modules to s3_bucket_* naming convention for consistency. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
|
Build succeeded. ✔️ ansible-galaxy-importer SUCCESS in 4m 07s (non-voting) |
|
Build succeeded. ✔️ ansible-galaxy-importer SUCCESS in 4m 08s (non-voting) |
…operations
- Add community.aws S3ErrorHandler extending amazon.aws version
- Include configuration-specific error codes (NoSuchConfiguration, etc.)
- Remove manual try/except blocks from wrapper functions
- Fix race condition handling in delete operations (check result is not False)
- Fix get_bucket_cors default return value from {} to []
- Add normalize_website_configuration to strip ResponseMetadata after normalisation
- Fix s3_bucket_website comparison to normalise both current and new configs
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
|
Build succeeded. ✔️ ansible-galaxy-importer SUCCESS in 3m 50s (non-voting) |
SUMMARY
Rename S3 configuration modules to follow s3_bucket_* naming convention:
Add new _info modules for retrieving configuration:
Create shared module_utils infrastructure:
Update meta/runtime.yml with redirects from old module names to new names for backwards compatibility, and add new modules to action groups.
Update all integration and unit tests to use new module names.
ISSUE TYPE
COMPONENT NAME
s3_*
ADDITIONAL INFORMATION