-
Notifications
You must be signed in to change notification settings - Fork 342
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update docs #2349
base: main
Are you sure you want to change the base?
Update docs #2349
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/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/aws_account_attribute_lookup.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/aws_account_attribute_lookup.html
index b7d721e..e4e7127 100644
--- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/aws_account_attribute_lookup.html
+++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/aws_account_attribute_lookup.html
@@ -379,7 +379,7 @@ examples: <code class="docutils literal notranslate"><span class="pre">lookup('a
<div class="ansibleOptionAnchor" id="return-_raw"></div><p class="ansible-option-title" id="ansible-collections-amazon-aws-aws-account-attribute-lookup-return-raw"><strong>Return value</strong></p>
<a class="ansibleOptionLink" href="#return-_raw" 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>Returns a boolean when <em>attribute</em> is check_ec2_classic. Otherwise returns the value(s) of the attribute (or all attributes if one is not specified).</p>
+<td><div class="ansible-option-cell"><p>Returns a boolean when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-amazon-aws-aws-account-attribute-lookup-parameter-attribute"><span class="std std-ref"><span class="pre">attribute=check_ec2_classic</span></span></a></code>. Otherwise returns the value(s) of the attribute (or all attributes if one is not specified).</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
</div></td>
</tr>
diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/aws_collection_constants_lookup.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/aws_collection_constants_lookup.html
index eb7d882..cdeeace 100644
--- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/aws_collection_constants_lookup.html
+++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/aws_collection_constants_lookup.html
@@ -22,7 +22,7 @@
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="search" title="Search" href="../../../search.html" />
- <link rel="next" title="amazon.aws.aws_service_ip_ranges lookup – Look up the IP ranges for services provided in AWS such as EC2 and S3." href="aws_service_ip_ranges_lookup.html" />
+ <link rel="next" title="amazon.aws.aws_service_ip_ranges lookup – Look up the IP ranges for services provided in AWS such as EC2 and S3" href="aws_service_ip_ranges_lookup.html" />
<link rel="prev" title="amazon.aws.aws_account_attribute lookup – Look up AWS account attributes" href="aws_account_attribute_lookup.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
@@ -201,7 +201,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<div class="ansibleOptionAnchor" id="return-_raw"></div><p class="ansible-option-title" id="ansible-collections-amazon-aws-aws-collection-constants-lookup-return-raw"><strong>Return value</strong></p>
<a class="ansibleOptionLink" href="#return-_raw" 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>value</p>
+<td><div class="ansible-option-cell"><p>Value.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
</div></td>
</tr>
@@ -235,7 +235,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="aws_account_attribute_lookup.html" class="btn btn-neutral float-left" title="amazon.aws.aws_account_attribute lookup – Look up AWS account attributes" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
- <a href="aws_service_ip_ranges_lookup.html" class="btn btn-neutral float-right" title="amazon.aws.aws_service_ip_ranges lookup – Look up the IP ranges for services provided in AWS such as EC2 and S3." accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+ <a href="aws_service_ip_ranges_lookup.html" class="btn btn-neutral float-right" title="amazon.aws.aws_service_ip_ranges lookup – Look up the IP ranges for services provided in AWS such as EC2 and S3" 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/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/aws_ec2_inventory.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/aws_ec2_inventory.html
index 2f5ddd7..e5ffc7e 100644
--- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/aws_ec2_inventory.html
+++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/aws_ec2_inventory.html
@@ -160,7 +160,7 @@ see <a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-
<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>Get inventory hosts from Amazon Web Services EC2.</p></li>
-<li><p>The inventory file is a YAML configuration file and must end with <code class="docutils literal notranslate"><span class="pre">aws_ec2.{yml|yaml}</span></code>. Example: <code class="docutils literal notranslate"><span class="pre">my_inventory.aws_ec2.yml</span></code>.</p></li>
+<li><p>The inventory file is a YAML configuration file and must end with <code class="docutils literal notranslate"><span class="pre">aws_ec2.{yml|yaml}</span></code>. For example - <code class="docutils literal notranslate"><span class="pre">my_inventory.aws_ec2.yml</span></code>.</p></li>
</ul>
</section>
<section id="requirements">
@@ -211,7 +211,7 @@ see <a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-
<a class="ansibleOptionLink" href="#parameter-allow_duplicated_hosts" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
<p><em class="ansible-option-versionadded">added in amazon.aws 5.0.0</em></p>
</div></td>
-<td><div class="ansible-option-cell"><p>By default, the first name that matches an entry of the <em>hostnames</em> list is returned.</p>
+<td><div class="ansible-option-cell"><p>By default, the first name that matches an entry of the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-inventory-parameter-hostnames"><span class="std std-ref"><span class="pre">hostnames</span></span></a></strong></code> list is returned.</p>
<p>Turn this flag on if you don’t mind having duplicated entries in the inventory and you want to get all the hostnames that match.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
@@ -377,7 +377,7 @@ see <a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-
<p><em class="ansible-option-versionadded">added in amazon.aws 1.5.0</em></p>
</div></td>
<td><div class="ansible-option-cell"><p>A list of filters. Any instances matching one of the filters are excluded from the result.</p>
-<p>The filters from <code class="docutils literal notranslate"><span class="pre">exclude_filters</span></code> take priority over the <code class="docutils literal notranslate"><span class="pre">include_filters</span></code> and <code class="docutils literal notranslate"><span class="pre">filters</span></code> keys</p>
+<p>The filters from <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-inventory-parameter-exclude-filters"><span class="std std-ref"><span class="pre">exclude_filters</span></span></a></strong></code> take priority over the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-inventory-parameter-include-filters"><span class="std std-ref"><span class="pre">include_filters</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-inventory-parameter-filters"><span class="std std-ref"><span class="pre">filters</span></span></a></strong></code> keys.</p>
<p>Available filters are listed here <a class="reference external" href="http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html#options">http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html#options</a>.</p>
<p>Every entry in this list triggers a search query. As such, from a performance point of view, it’s better to keep the list as short as possible.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">[]</span></code></p>
@@ -423,8 +423,8 @@ see <a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-
<div class="ansibleOptionAnchor" id="parameter-hostnames/prefix"></div><p class="ansible-option-title" id="ansible-collections-amazon-aws-aws-ec2-inventory-parameter-hostnames-prefix"><strong>prefix</strong></p>
<a class="ansibleOptionLink" href="#parameter-hostnames/prefix" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
-<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Prefix to prepend to <em>name</em>. Same options as <em>name</em>.</p>
-<p>If <em>prefix</em> is specified, final hostname will be <em>prefix</em> + <em>separator</em> + <em>name</em>.</p>
+<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Prefix to prepend to <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-inventory-parameter-hostnames-name"><span class="std std-ref"><span class="pre">hostnames.name</span></span></a></strong></code>. Same options as <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-inventory-parameter-hostnames-name"><span class="std std-ref"><span class="pre">hostnames.name</span></span></a></strong></code>.</p>
+<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-inventory-parameter-hostnames-prefix"><span class="std std-ref"><span class="pre">hostnames.prefix</span></span></a></strong></code> is specified, final hostname will be <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-inventory-parameter-hostnames-prefix"><span class="std std-ref"><span class="pre">hostnames.prefix</span></span></a></strong></code> + <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-inventory-parameter-hostnames-separator"><span class="std std-ref"><span class="pre">hostnames.separator</span></span></a></strong></code> + <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-inventory-parameter-hostnames-name"><span class="std std-ref"><span class="pre">hostnames.name</span></span></a></strong></code>.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">""</span></code></p>
</div></td>
</tr>
@@ -432,7 +432,7 @@ see <a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-
<div class="ansibleOptionAnchor" id="parameter-hostnames/separator"></div><p class="ansible-option-title" id="ansible-collections-amazon-aws-aws-ec2-inventory-parameter-hostnames-separator"><strong>separator</strong></p>
<a class="ansibleOptionLink" href="#parameter-hostnames/separator" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
-<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Value to separate <em>prefix</em> and <em>name</em> when <em>prefix</em> is specified.</p>
+<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Value to separate <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-inventory-parameter-hostnames-prefix"><span class="std std-ref"><span class="pre">hostnames.prefix</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-inventory-parameter-hostnames-name"><span class="std std-ref"><span class="pre">hostnames.name</span></span></a></strong></code> when <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-inventory-parameter-hostnames-prefix"><span class="std std-ref"><span class="pre">hostnames.prefix</span></span></a></strong></code> is specified.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"_"</span></code></p>
</div></td>
</tr>
@@ -585,7 +585,7 @@ see <a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-
<a class="ansibleOptionLink" href="#parameter-regions" 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=string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>A list of regions in which to describe EC2 instances.</p>
-<p>If empty (the default) default this will include all regions, except possibly restricted ones like us-gov-west-1 and cn-north-1.</p>
+<p>If empty (the default) default this will include all regions, except possibly restricted ones like <code class="ansible-value docutils literal notranslate"><span class="pre">us-gov-west-1</span></code> and <code class="ansible-value docutils literal notranslate"><span class="pre">cn-north-1</span></code>.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">[]</span></code></p>
</div></td>
</tr>
@@ -727,7 +727,7 @@ see <a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-
<p><em class="ansible-option-versionadded">added in amazon.aws 6.0.0</em></p>
</div></td>
<td><div class="ansible-option-cell"><p>Enables fetching additional EC2 instance information from the AWS Systems Manager (SSM) inventory service into hostvars.</p>
-<p>By leveraging the SSM inventory data, the <em>use_ssm_inventory</em> option provides additional details and attributes about the EC2 instances in your inventory. These details can include operating system information, installed software, network configurations, and custom inventory attributes defined in SSM.</p>
+<p>By leveraging the SSM inventory data, the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-amazon-aws-aws-ec2-inventory-parameter-use-ssm-inventory"><span class="std std-ref"><span class="pre">use_ssm_inventory</span></span></a></strong></code> option provides additional details and attributes about the EC2 instances in your inventory. These details can include operating system information, installed software, network configurations, and custom inventory attributes defined in SSM.</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>
diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/aws_service_ip_ranges_lookup.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/aws_service_ip_ranges_lookup.html
index 4eedc85..37685c5 100644
--- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/aws_service_ip_ranges_lookup.html
+++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/aws_service_ip_ranges_lookup.html
@@ -7,7 +7,7 @@
<meta content="2.15.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <title>amazon.aws.aws_service_ip_ranges lookup – Look up the IP ranges for services provided in AWS such as EC2 and S3. — Ansible collections documentation</title>
+ <title>amazon.aws.aws_service_ip_ranges lookup – Look up the IP ranges for services provided in AWS such as EC2 and S3 — Ansible collections documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/ansible.css?v=c5b67dd2" />
<link rel="stylesheet" type="text/css" href="../../../_static/antsibull-minimal.css" />
@@ -122,7 +122,7 @@
<li class="breadcrumb-item"><a href="../../index.html">Collection Index</a></li>
<li class="breadcrumb-item"><a href="../index.html">Collections in the Amazon Namespace</a></li>
<li class="breadcrumb-item"><a href="index.html">Amazon.Aws</a></li>
- <li class="breadcrumb-item active">amazon.aws.aws_service_ip_ranges lookup – Look up the IP ranges for services provided in AWS such as EC2 and S3.</li>
+ <li class="breadcrumb-item active">amazon.aws.aws_service_ip_ranges lookup – Look up the IP ranges for services provided in AWS such as EC2 and S3</li>
<li class="wy-breadcrumbs-aside">
<!-- User defined GitHub URL -->
<a href="https://github.com/ansible-collections/amazon.aws/edit/main/plugins/lookup/aws_service_ip_ranges.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>
@@ -136,7 +136,7 @@
<div itemprop="articleBody">
<span class="target" id="ansible-collections-amazon-aws-aws-service-ip-ranges-lookup"></span><section id="amazon-aws-aws-service-ip-ranges-lookup-look-up-the-ip-ranges-for-services-provided-in-aws-such-as-ec2-and-s3">
-<h1>amazon.aws.aws_service_ip_ranges lookup – Look up the IP ranges for services provided in AWS such as EC2 and S3.<a class="headerlink" href="#amazon-aws-aws-service-ip-ranges-lookup-look-up-the-ip-ranges-for-services-provided-in-aws-such-as-ec2-and-s3" title="Link to this heading"></a></h1>
+<h1>amazon.aws.aws_service_ip_ranges lookup – Look up the IP ranges for services provided in AWS such as EC2 and S3<a class="headerlink" href="#amazon-aws-aws-service-ip-ranges-lookup-look-up-the-ip-ranges-for-services-provided-in-aws-such-as-ec2-and-s3" title="Link to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This lookup plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/amazon/aws/">amazon.aws collection</a> (version 9.0.0-dev0).</p>
@@ -186,21 +186,22 @@ examples: <code class="docutils literal notranslate"><span class="pre">lookup('a
<a class="ansibleOptionLink" href="#parameter-ipv6_prefixes" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
<p><em class="ansible-option-versionadded">added in amazon.aws 2.1.0</em></p>
</div></td>
-<td><div class="ansible-option-cell"><p>When <em>ipv6_prefixes=True</em> the lookup will return ipv6 addresses instead of ipv4 addresses</p>
+<td><div class="ansible-option-cell"><p>When <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-amazon-aws-aws-service-ip-ranges-lookup-parameter-ipv6-prefixes"><span class="std std-ref"><span class="pre">ipv6_prefixes=true</span></span></a></code> the lookup will return ipv6 addresses instead of ipv4 addresses.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-region"></div><p class="ansible-option-title" id="ansible-collections-amazon-aws-aws-service-ip-ranges-lookup-parameter-region"><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-type">string</span></p>
</div></td>
-<td><div class="ansible-option-cell"><p>The AWS region to narrow the ranges to. Examples: us-east-1, eu-west-2, ap-southeast-1</p>
+<td><div class="ansible-option-cell"><p>The AWS region to narrow the ranges to. Examples include <code class="ansible-value docutils literal notranslate"><span class="pre">us-east-1</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">eu-west-2</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">ap-southeast-1</span></code>.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-service"></div><p class="ansible-option-title" id="ansible-collections-amazon-aws-aws-service-ip-ranges-lookup-parameter-service"><strong>service</strong></p>
<a class="ansibleOptionLink" href="#parameter-service" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
-<td><div class="ansible-option-cell"><p>The service to filter ranges by. Options: EC2, S3, CLOUDFRONT, CODEbUILD, ROUTE53, ROUTE53_HEALTHCHECKS</p>
+<td><div class="ansible-option-cell"><p>The service to filter ranges by.</p>
+<p>Options include <code class="ansible-value docutils literal notranslate"><span class="pre">EC2</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">S3</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">CLOUDFRONT</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">CODEBUILD</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">ROUTE53</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">ROUTE53_HEALTHCHECKS</span></code>.</p>
</div></td>
</tr>
</tbody>
@@ -212,11 +213,11 @@ examples: <code class="docutils literal notranslate"><span class="pre">lookup('a
<span class="w"> </span><span class="nt">ec2_ranges</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'aws_service_ip_ranges'</span><span class="o">,</span> <span class="nv">region</span><span class="o">=</span><span class="s1">'ap-southeast-2'</span><span class="o">,</span> <span class="nv">service</span><span class="o">=</span><span class="s1">'EC2'</span><span class="o">,</span> <span class="nv">wantlist</span><span class="o">=</span><span class="kp">True</span><span class="o">)</span> <span class="cp">}}</span><span class="s">"</span>
<span class="nt">tasks</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"use</span><span class="nv"> </span><span class="s">list</span><span class="nv"> </span><span class="s">return</span><span class="nv"> </span><span class="s">option</span><span class="nv"> </span><span class="s">and</span><span class="nv"> </span><span class="s">iterate</span><span class="nv"> </span><span class="s">as</span><span class="nv"> </span><span class="s">a</span><span class="nv"> </span><span class="s">loop"</span>
-<span class="w"> </span><span class="nt">debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">msg="</span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">cidr</span> <span class="k">in</span> <span class="nv">ec2_ranges</span> <span class="cp">%}{{</span> <span class="nv">cidr</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain"> </span><span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
+<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">msg="</span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">cidr</span> <span class="k">in</span> <span class="nv">ec2_ranges</span> <span class="cp">%}{{</span> <span class="nv">cidr</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain"> </span><span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
<span class="w"> </span><span class="c1"># "52.62.0.0/15 52.64.0.0/17 52.64.128.0/17 52.65.0.0/16 52.95.241.0/24 52.95.255.16/28 54.66.0.0/16 "</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Pull</span><span class="nv"> </span><span class="s">S3</span><span class="nv"> </span><span class="s">IP</span><span class="nv"> </span><span class="s">ranges,</span><span class="nv"> </span><span class="s">and</span><span class="nv"> </span><span class="s">print</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">default</span><span class="nv"> </span><span class="s">return</span><span class="nv"> </span><span class="s">style"</span>
-<span class="w"> </span><span class="nt">debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">msg="</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'aws_service_ip_ranges'</span><span class="o">,</span> <span class="nv">region</span><span class="o">=</span><span class="s1">'us-east-1'</span><span class="o">,</span> <span class="nv">service</span><span class="o">=</span><span class="s1">'S3'</span><span class="o">)</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
+<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">msg="</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'aws_service_ip_ranges'</span><span class="o">,</span> <span class="nv">region</span><span class="o">=</span><span class="s1">'us-east-1'</span><span class="o">,</span> <span class="nv">service</span><span class="o">=</span><span class="s1">'S3'</span><span class="o">)</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
<span class="w"> </span><span class="c1"># "52.92.16.0/20,52.216.0.0/15,54.231.0.0/17"</span>
</pre></div>
</div>
@@ -234,7 +235,7 @@ examples: <code class="docutils literal notranslate"><span class="pre">lookup('a
<div class="ansibleOptionAnchor" id="return-_raw"></div><p class="ansible-option-title" id="ansible-collections-amazon-aws-aws-service-ip-ranges-lookup-return-raw"><strong>Return value</strong></p>
<a class="ansibleOptionLink" href="#return-_raw" 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>comma-separated list of CIDR ranges</p>
+<td><div class="ansible-option-cell"><p>Comma-separated list of CIDR ranges.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
</div></td>
</tr>
diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/index.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/index.html
index d0294a8..f9f412b 100644
--- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/index.html
+++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/index.html
@@ -356,7 +356,7 @@
<ul class="simple">
<li><p><a class="reference internal" href="aws_account_attribute_lookup.html#ansible-collections-amazon-aws-aws-account-attribute-lookup"><span class="std std-ref">aws_account_attribute lookup</span></a> – Look up AWS account attributes</p></li>
<li><p><a class="reference internal" href="aws_collection_constants_lookup.html#ansible-collections-amazon-aws-aws-collection-constants-lookup"><span class="std std-ref">aws_collection_constants lookup</span></a> – expose various collection related constants</p></li>
-<li><p><a class="reference internal" href="aws_service_ip_ranges_lookup.html#ansible-collections-amazon-aws-aws-service-ip-ranges-lookup"><span class="std std-ref">aws_service_ip_ranges lookup</span></a> – Look up the IP ranges for services provided in AWS such as EC2 and S3.</p></li>
+<li><p><a class="reference internal" href="aws_service_ip_ranges_lookup.html#ansible-collections-amazon-aws-aws-service-ip-ranges-lookup"><span class="std std-ref">aws_service_ip_ranges lookup</span></a> – Look up the IP ranges for services provided in AWS such as EC2 and S3</p></li>
<li><p><a class="reference internal" href="secretsmanager_secret_lookup.html#ansible-collections-amazon-aws-secretsmanager-secret-lookup"><span class="std std-ref">secretsmanager_secret lookup</span></a> – Look up secrets stored in AWS Secrets Manager</p></li>
<li><p><a class="reference internal" href="ssm_parameter_lookup.html#ansible-collections-amazon-aws-ssm-parameter-lookup"><span class="std std-ref">ssm_parameter lookup</span></a> – gets the value for a SSM parameter or all parameters under a path</p></li>
</ul>
diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/secretsmanager_secret_lookup.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/secretsmanager_secret_lookup.html
index 5df8df9..e10cc9e 100644
--- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/secretsmanager_secret_lookup.html
+++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/secretsmanager_secret_lookup.html
@@ -23,7 +23,7 @@
<script src="../../../_static/js/theme.js"></script>
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="amazon.aws.ssm_parameter lookup – gets the value for a SSM parameter or all parameters under a path" href="ssm_parameter_lookup.html" />
- <link rel="prev" title="amazon.aws.aws_service_ip_ranges lookup – Look up the IP ranges for services provided in AWS such as EC2 and S3." href="aws_service_ip_ranges_lookup.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
+ <link rel="prev" title="amazon.aws.aws_service_ip_ranges lookup – Look up the IP ranges for services provided in AWS such as EC2 and S3" href="aws_service_ip_ranges_lookup.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
@@ -163,7 +163,7 @@ see <a class="reference internal" href="#ansible-collections-amazon-aws-secretsm
<ul class="simple">
<li><p>Look up secrets stored in AWS Secrets Manager provided the caller has the appropriate permissions to read the secret.</p></li>
<li><p>Lookup is based on the secret’s <em>Name</em> value.</p></li>
-<li><p>Optional parameters can be passed into this lookup; <em>version_id</em> and <em>version_stage</em></p></li>
+<li><p>Optional parameters can be passed into this lookup; <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-amazon-aws-secretsmanager-secret-lookup-parameter-version-id"><span class="std std-ref"><span class="pre">version_id</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-amazon-aws-secretsmanager-secret-lookup-parameter-version-stage"><span class="std std-ref"><span class="pre">version_stage</span></span></a></strong></code>.</p></li>
<li><p>Prior to release 6.0.0 this module was known as <code class="docutils literal notranslate"><span class="pre">aws_ssm</span></code>, the usage remains the same.</p></li>
</ul>
<p>Aliases: aws_secret</p>
@@ -271,7 +271,7 @@ examples: <code class="docutils literal notranslate"><span class="pre">lookup('a
</div></td>
<td><div class="ansible-option-cell"><p>Join two or more entries to form an extended secret.</p>
<p>This is useful for overcoming the 4096 character limit imposed by AWS.</p>
-<p>No effect when used with <em>bypath</em>.</p>
+<p>No effect when used with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-amazon-aws-secretsmanager-secret-lookup-parameter-bypath"><span class="std std-ref"><span class="pre">bypath</span></span></a></strong></code>.</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>
@@ -298,9 +298,9 @@ examples: <code class="docutils literal notranslate"><span class="pre">lookup('a
<p><em class="ansible-option-versionadded">added in amazon.aws 2.0.0</em></p>
</div></td>
<td><div class="ansible-option-cell"><p>Action to take if the secret has been marked for deletion.</p>
-<p><code class="docutils literal notranslate"><span class="pre">error</span></code> will raise a fatal error when the secret has been marked for deletion.</p>
-<p><code class="docutils literal notranslate"><span class="pre">skip</span></code> will silently ignore the deleted secret.</p>
-<p><code class="docutils literal notranslate"><span class="pre">warn</span></code> will skip over the deleted secret but issue a warning.</p>
+<p><code class="ansible-value docutils literal notranslate"><span class="pre">error</span></code> will raise a fatal error when the secret has been marked for deletion.</p>
+<p><code class="ansible-value docutils literal notranslate"><span class="pre">skip</span></code> will silently ignore the deleted secret.</p>
+<p><code class="ansible-value docutils literal notranslate"><span class="pre">warn</span></code> will skip over the deleted secret but issue a warning.</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">"error"</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
@@ -465,33 +465,32 @@ examples: <code class="docutils literal notranslate"><span class="pre">lookup('a
</section>
<section id="examples">
<h2><a class="toc-backref" href="#id6" 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="p p-Indicator">-</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">lookup secretsmanager secret in the current region</span>
-<span class="w"> </span><span class="nt">debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">msg="</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'amazon.aws.aws_secret'</span><span class="o">,</span> <span class="s1">'/path/to/secrets'</span><span class="o">,</span> <span class="nv">bypath</span><span class="o">=</span><span class="kp">true</span><span class="o">)</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
+<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</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">Lookup secretsmanager secret in the current region</span>
+<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">msg="</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'amazon.aws.aws_secret'</span><span class="o">,</span> <span class="s1">'/path/to/secrets'</span><span class="o">,</span> <span class="nv">bypath</span><span class="o">=</span><span class="kp">true</span><span class="o">)</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
<span class="p p-Indicator">-</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">Create RDS instance with aws_secret lookup for password param</span>
-<span class="w"> </span><span class="nt">rds</span><span class="p">:</span>
-<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">create</span>
-<span class="w"> </span><span class="nt">instance_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">app-db</span>
-<span class="w"> </span><span class="nt">db_engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">MySQL</span>
-<span class="w"> </span><span class="nt">size</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10</span>
+<span class="w"> </span><span class="nt">amazon.aws.rds_instance</span><span class="p">:</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">db_instance_identifier</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">app-db</span>
+<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mysql</span>
<span class="w"> </span><span class="nt">instance_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">db.m1.small</span>
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dbadmin</span>
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'amazon.aws.aws_secret'</span><span class="o">,</span> <span class="s1">'DbSecret'</span><span class="o">)</span> <span class="cp">}}</span><span class="s">"</span>
<span class="w"> </span><span class="nt">tags</span><span class="p">:</span>
<span class="w"> </span><span class="nt">Environment</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">staging</span>
-<span class="p p-Indicator">-</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">skip if secret does not exist</span>
-<span class="w"> </span><span class="nt">debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">msg="</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'amazon.aws.aws_secret'</span><span class="o">,</span> <span class="s1">'secret-not-exist'</span><span class="o">,</span> <span class="nv">on_missing</span><span class="o">=</span><span class="s1">'skip'</span><span class="o">)</span><span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
+<span class="p p-Indicator">-</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">Skip if secret does not exist</span>
+<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">msg="</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'amazon.aws.aws_secret'</span><span class="o">,</span> <span class="s1">'secret-not-exist'</span><span class="o">,</span> <span class="nv">on_missing</span><span class="o">=</span><span class="s1">'skip'</span><span class="o">)</span><span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
-<span class="p p-Indicator">-</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">warn if access to the secret is denied</span>
-<span class="w"> </span><span class="nt">debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">msg="</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'amazon.aws.aws_secret'</span><span class="o">,</span> <span class="s1">'secret-denied'</span><span class="o">,</span> <span class="nv">on_denied</span><span class="o">=</span><span class="s1">'warn'</span><span class="o">)</span><span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
+<span class="p p-Indicator">-</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">Warn if access to the secret is denied</span>
+<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">msg="</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'amazon.aws.aws_secret'</span><span class="o">,</span> <span class="s1">'secret-denied'</span><span class="o">,</span> <span class="nv">on_denied</span><span class="o">=</span><span class="s1">'warn'</span><span class="o">)</span><span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
-<span class="p p-Indicator">-</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">lookup secretsmanager secret in the current region using the nested feature</span>
-<span class="w"> </span><span class="nt">debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">msg="</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'amazon.aws.aws_secret'</span><span class="o">,</span> <span class="s1">'secrets.environments.production.password'</span><span class="o">,</span> <span class="nv">nested</span><span class="o">=</span><span class="kp">true</span><span class="o">)</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
+<span class="p p-Indicator">-</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">Lookup secretsmanager secret in the current region using the nested feature</span>
+<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">msg="</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'amazon.aws.aws_secret'</span><span class="o">,</span> <span class="s1">'secrets.environments.production.password'</span><span class="o">,</span> <span class="nv">nested</span><span class="o">=</span><span class="kp">true</span><span class="o">)</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
<span class="w"> </span><span class="c1"># The secret can be queried using the following syntax: `aws_secret_object_name.key1.key2.key3`.</span>
<span class="w"> </span><span class="c1"># If an object is of the form `{"key1":{"key2":{"key3":1}}}` the query would return the value `1`.</span>
-<span class="p p-Indicator">-</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">lookup secretsmanager secret in a specific region using specified region and aws profile using nested feature</span>
-<span class="w"> </span><span class="nt">debug</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">></span>
+<span class="p p-Indicator">-</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">Lookup secretsmanager secret in a specific region using specified region and aws profile using nested feature</span>
+<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">></span>
<span class="w"> </span><span class="no">msg="</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'amazon.aws.aws_secret'</span><span class="o">,</span> <span class="s1">'secrets.environments.production.password'</span><span class="o">,</span> <span class="nv">region</span><span class="o">=</span><span class="nv">region</span><span class="o">,</span> <span class="nv">profile</span><span class="o">=</span><span class="nv">aws_profile</span><span class="o">,</span>
<span class="nv">access_key</span><span class="o">=</span><span class="nv">aws_access_key</span><span class="o">,</span> <span class="nv">secret_key</span><span class="o">=</span><span class="nv">aws_secret_key</span><span class="o">,</span> <span class="nv">nested</span><span class="o">=</span><span class="kp">true</span><span class="o">)</span> <span class="cp">}}</span><span class="no">"</span>
<span class="w"> </span><span class="c1"># The secret can be queried using the following syntax: `aws_secret_object_name.key1.key2.key3`.</span>
@@ -547,7 +546,7 @@ examples: <code class="docutils literal notranslate"><span class="pre">lookup('a
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
- <a href="aws_service_ip_ranges_lookup.html" class="btn btn-neutral float-left" title="amazon.aws.aws_service_ip_ranges lookup – Look up the IP ranges for services provided in AWS such as EC2 and S3." accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+ <a href="aws_service_ip_ranges_lookup.html" class="btn btn-neutral float-left" title="amazon.aws.aws_service_ip_ranges lookup – Look up the IP ranges for services provided in AWS such as EC2 and S3" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="ssm_parameter_lookup.html" class="btn btn-neutral float-right" title="amazon.aws.ssm_parameter lookup – gets the value for a SSM parameter or all parameters under a path" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/ssm_parameter_lookup.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/ssm_parameter_lookup.html
index 8ee2b7d..528c9cc 100644
--- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/ssm_parameter_lookup.html
+++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/ssm_parameter_lookup.html
@@ -160,7 +160,7 @@ see <a class="reference internal" href="#ansible-collections-amazon-aws-ssm-para
<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>Get the value for an Amazon Simple Systems Manager parameter or a hierarchy of parameters. The first argument you pass the lookup can either be a parameter name or a hierarchy of parameters. Hierarchies start with a forward slash and end with the parameter name. Up to 5 layers may be specified.</p></li>
-<li><p>If looking up an explicitly listed parameter by name which does not exist then the lookup will generate an error. You can use the <code class="docutils literal notranslate"><span class="pre">default</span></code> filter to give a default value in this case but must set the <em>on_missing</em> parameter to <code class="docutils literal notranslate"><span class="pre">skip</span></code> or <code class="docutils literal notranslate"><span class="pre">warn</span></code>. You must also set the second parameter of the <code class="docutils literal notranslate"><span class="pre">default</span></code> filter to <code class="docutils literal notranslate"><span class="pre">true</span></code> (see examples below).</p></li>
+<li><p>If looking up an explicitly listed parameter by name which does not exist then the lookup will generate an error. You can use the <code class="docutils literal notranslate"><span class="pre">default</span></code> filter to give a default value in this case but must set the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-amazon-aws-ssm-parameter-lookup-parameter-on-missing"><span class="std std-ref"><span class="pre">on_missing</span></span></a></strong></code> parameter to <code class="ansible-value docutils literal notranslate"><span class="pre">skip</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">warn</span></code>. You must also set the second parameter of the <code class="docutils literal notranslate"><span class="pre">default</span></code> filter to <code class="docutils literal notranslate"><span class="pre">true</span></code> (see examples below).</p></li>
<li><p>When looking up a path for parameters under it a dictionary will be returned for each path. If there is no parameter under that path then the lookup will generate an error.</p></li>
<li><p>If the lookup fails due to lack of permissions or due to an AWS client error then the aws_ssm will generate an error. If you want to continue in this case then you will have to set up two ansible tasks, one which sets a variable and ignores failures and one which uses the value of that variable with a default. See the examples below.</p></li>
<li><p>Prior to release 6.0.0 this module was known as <code class="docutils literal notranslate"><span class="pre">aws_ssm</span></code>, the usage remains the same.</p></li>
@@ -276,9 +276,9 @@ examples: <code class="docutils literal notranslate"><span class="pre">lookup('a
<p><em class="ansible-option-versionadded">added in amazon.aws 2.0.0</em></p>
</div></td>
<td><div class="ansible-option-cell"><p>Action to take if access to the SSM parameter is denied.</p>
-<p><code class="docutils literal notranslate"><span class="pre">error</span></code> will raise a fatal error when access to the SSM parameter is denied.</p>
-<p><code class="docutils literal notranslate"><span class="pre">skip</span></code> will silently ignore the denied SSM parameter.</p>
-<p><code class="docutils literal notranslate"><span class="pre">warn</span></code> will skip over the denied SSM parameter but issue a warning.</p>
+<p>v(error) will raise a fatal error when access to the SSM parameter is denied.</p>
+<p>v(skip) will silently ignore the denied SSM parameter.</p>
+<p>v(warn) will skip over the denied SSM parameter but issue a warning.</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">"error"</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
@@ -438,59 +438,59 @@ examples: <code class="docutils literal notranslate"><span class="pre">lookup('a
<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"># lookup sample:</span>
-<span class="p p-Indicator">-</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">lookup ssm parameter store in the current region</span>
-<span class="w"> </span><span class="nt">debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">msg="</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'amazon.aws.aws_ssm'</span><span class="o">,</span> <span class="s1">'Hello'</span> <span class="o">)</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
+<span class="p p-Indicator">-</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">Lookup ssm parameter store in the current region</span>
+<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">msg="</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'amazon.aws.aws_ssm'</span><span class="o">,</span> <span class="s1">'Hello'</span> <span class="o">)</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
-<span class="p p-Indicator">-</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">lookup ssm parameter store in specified region</span>
-<span class="w"> </span><span class="nt">debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">msg="</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'amazon.aws.aws_ssm'</span><span class="o">,</span> <span class="s1">'Hello'</span><span class="o">,</span> <span class="nv">region</span><span class="o">=</span><span class="s1">'us-east-2'</span> <span class="o">)</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
+<span class="p p-Indicator">-</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">Lookup ssm parameter store in specified region</span>
+<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">msg="</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'amazon.aws.aws_ssm'</span><span class="o">,</span> <span class="s1">'Hello'</span><span class="o">,</span> <span class="nv">region</span><span class="o">=</span><span class="s1">'us-east-2'</span> <span class="o">)</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
-<span class="p p-Indicator">-</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">lookup ssm parameter store without decryption</span>
-<span class="w"> </span><span class="nt">debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">msg="</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'amazon.aws.aws_ssm'</span><span class="o">,</span> <span class="s1">'Hello'</span><span class="o">,</span> <span class="nv">decrypt</span><span class="o">=</span><span class="kp">False</span> <span class="o">)</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
+<span class="p p-Indicator">-</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">Lookup ssm parameter store without decryption</span>
+<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">msg="</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'amazon.aws.aws_ssm'</span><span class="o">,</span> <span class="s1">'Hello'</span><span class="o">,</span> <span class="nv">decrypt</span><span class="o">=</span><span class="kp">False</span> <span class="o">)</span> <span class="cp">}}</span><span class="l l-Scalar l-Scalar-Plain">"</span>
-<span class="p p-Indicator">-</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">lookup ssm parameter store using a specified aws profile</span>
-<span |
Signed-off-by: Alina Buzachis <[email protected]>
538a346
to
90acb01
Compare
Build succeeded. ✔️ ansible-galaxy-importer SUCCESS in 5m 52s |
SUMMARY
ISSUE TYPE
COMPONENT NAME
ADDITIONAL INFORMATION