Document Agentless AWS scan options routes (#2435)

Co-authored-by: ci.datadog-api-spec <[email protected]> 5b4ca01

Author: api-clients-generation-pipeline[bot]

_sources/datadog_api_client.v2.model.rst.txt

@@ -1110,13 +1110,34 @@ datadog\_api\_client.v2.model.aws\_scan\_options\_attributes module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.aws\_scan\_options\_create\_data module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.aws_scan_options_create_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.aws\_scan\_options\_create\_request module
+------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.aws_scan_options_create_request
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.aws\_scan\_options\_data module
 -------------------------------------------------------------
 
 .. automodule:: datadog_api_client.v2.model.aws_scan_options_data
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.aws\_scan\_options\_list\_response module
+-----------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.aws_scan_options_list_response
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.aws\_scan\_options\_response module
 -----------------------------------------------------------------
 
@@ -1131,6 +1152,27 @@ datadog\_api\_client.v2.model.aws\_scan\_options\_type module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.aws\_scan\_options\_update\_attributes module
+---------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.aws_scan_options_update_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.aws\_scan\_options\_update\_data module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.aws_scan_options_update_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.aws\_scan\_options\_update\_request module
+------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.aws_scan_options_update_request
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.aws\_traces\_config module
 --------------------------------------------------------
 

datadog_api_client.html

@@ -2469,9 +2469,15 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_regions_include_only">datadog_api_client.v2.model.aws_regions_include_only module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_resources_config">datadog_api_client.v2.model.aws_resources_config module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_scan_options_attributes">datadog_api_client.v2.model.aws_scan_options_attributes module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_scan_options_create_data">datadog_api_client.v2.model.aws_scan_options_create_data module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_scan_options_create_request">datadog_api_client.v2.model.aws_scan_options_create_request module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_scan_options_data">datadog_api_client.v2.model.aws_scan_options_data module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_scan_options_list_response">datadog_api_client.v2.model.aws_scan_options_list_response module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_scan_options_response">datadog_api_client.v2.model.aws_scan_options_response module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_scan_options_type">datadog_api_client.v2.model.aws_scan_options_type module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_scan_options_update_attributes">datadog_api_client.v2.model.aws_scan_options_update_attributes module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_scan_options_update_data">datadog_api_client.v2.model.aws_scan_options_update_data module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_scan_options_update_request">datadog_api_client.v2.model.aws_scan_options_update_request module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_traces_config">datadog_api_client.v2.model.aws_traces_config module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.azure_uc_config">datadog_api_client.v2.model.azure_uc_config module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.azure_uc_config_pair">datadog_api_client.v2.model.azure_uc_config_pair module</a></li>

datadog_api_client.v2.api.html

@@ -697,7 +697,13 @@
               <ul class="md-nav__list">
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">AgentlessScanningApi</span></code></a><nav class="md-nav">
               <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.create_aws_scan_options" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">AgentlessScanningApi.create_aws_scan_options()</span></code></a>
+        </li>
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.delete_aws_scan_options" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">AgentlessScanningApi.delete_aws_scan_options()</span></code></a>
+        </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.list_aws_scan_options" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">AgentlessScanningApi.list_aws_scan_options()</span></code></a>
+        </li>
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.update_aws_scan_options" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">AgentlessScanningApi.update_aws_scan_options()</span></code></a>
         </li></ul>
             </nav>
         </li></ul>
@@ -2227,15 +2233,60 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 <p>Datadog Agentless Scanning provides visibility into risks and vulnerabilities
 within your hosts, running containers, and serverless functions—all without
 requiring teams to install Agents on every host or where Agents cannot be installed.
-Go to <a class="reference external" href="https://www.datadoghq.com/blog/agentless-scanning/">https://www.datadoghq.com/blog/agentless-scanning/</a> to learn more</p>
+Go to <a class="reference external" href="https://www.datadoghq.com/blog/agentless-scanning/">https://www.datadoghq.com/blog/agentless-scanning/</a> to learn more.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.create_aws_scan_options">
+<span class="sig-name descname"><span class="pre">create_aws_scan_options</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.aws_scan_options_create_request.AwsScanOptionsCreateRequest" title="datadog_api_client.v2.model.aws_scan_options_create_request.AwsScanOptionsCreateRequest"><span class="pre">AwsScanOptionsCreateRequest</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.aws_scan_options_response.AwsScanOptionsResponse" title="datadog_api_client.v2.model.aws_scan_options_response.AwsScanOptionsResponse"><span class="pre">AwsScanOptionsResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.create_aws_scan_options" title="Link to this definition">¶</a></dt>
+<dd><p>Post AWS Scan Options.</p>
+<p>Activate Agentless scan options for an AWS account.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>body</strong> (<a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.aws_scan_options_create_request.AwsScanOptionsCreateRequest" title="datadog_api_client.v2.model.aws_scan_options_create_request.AwsScanOptionsCreateRequest"><em>AwsScanOptionsCreateRequest</em></a>) – The definition of the new scan options.</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.aws_scan_options_response.AwsScanOptionsResponse" title="datadog_api_client.v2.model.aws_scan_options_response.AwsScanOptionsResponse">AwsScanOptionsResponse</a></p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.delete_aws_scan_options">
+<span class="sig-name descname"><span class="pre">delete_aws_scan_options</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">account_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.delete_aws_scan_options" title="Link to this definition">¶</a></dt>
+<dd><p>Delete AWS Scan Options.</p>
+<p>Delete Agentless scan options for an AWS account.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>account_id</strong> (<em>str</em>) – The ID of an AWS account.</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>None</p>
+</dd>
+</dl>
+</dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.list_aws_scan_options">
-<span class="sig-name descname"><span class="pre">list_aws_scan_options</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.aws_scan_options_response.AwsScanOptionsResponse" title="datadog_api_client.v2.model.aws_scan_options_response.AwsScanOptionsResponse"><span class="pre">AwsScanOptionsResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.list_aws_scan_options" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">list_aws_scan_options</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.aws_scan_options_list_response.AwsScanOptionsListResponse" title="datadog_api_client.v2.model.aws_scan_options_list_response.AwsScanOptionsListResponse"><span class="pre">AwsScanOptionsListResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.list_aws_scan_options" title="Link to this definition">¶</a></dt>
 <dd><p>Get AWS Scan Options.</p>
 <p>Fetches the scan options configured for AWS accounts.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.aws_scan_options_response.AwsScanOptionsResponse" title="datadog_api_client.v2.model.aws_scan_options_response.AwsScanOptionsResponse">AwsScanOptionsResponse</a></p>
+<dd class="field-odd"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.aws_scan_options_list_response.AwsScanOptionsListResponse" title="datadog_api_client.v2.model.aws_scan_options_list_response.AwsScanOptionsListResponse">AwsScanOptionsListResponse</a></p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.update_aws_scan_options">
+<span class="sig-name descname"><span class="pre">update_aws_scan_options</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">account_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.aws_scan_options_update_request.AwsScanOptionsUpdateRequest" title="datadog_api_client.v2.model.aws_scan_options_update_request.AwsScanOptionsUpdateRequest"><span class="pre">AwsScanOptionsUpdateRequest</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.update_aws_scan_options" title="Link to this definition">¶</a></dt>
+<dd><p>Patch AWS Scan Options.</p>
+<p>Update the Agentless scan options for an activated account.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>account_id</strong> (<em>str</em>) – The ID of an AWS account.</p></li>
+<li><p><strong>body</strong> (<a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.aws_scan_options_update_request.AwsScanOptionsUpdateRequest" title="datadog_api_client.v2.model.aws_scan_options_update_request.AwsScanOptionsUpdateRequest"><em>AwsScanOptionsUpdateRequest</em></a>) – New definition of the scan options.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>None</p>
 </dd>
 </dl>
 </dd></dl>