Skip to content

Commit c066ec7

Browse files
api-clients-generation-pipeline[bot]api-clients-generation-pipeline[bot]
committed
Document Agentless AWS on demand routes (#2440)
Co-authored-by: ci.datadog-api-spec <[email protected]> 8affa9c
1 parent 64fb1ef commit c066ec7

9 files changed

+565
-10
lines changed

‎_sources/datadog_api_client.v2.model.rst.txt

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1194,6 +1194,62 @@ datadog\_api\_client.v2.model.aws\_new\_external\_id\_response\_data\_type modul
11941194
:members:
11951195
:show-inheritance:
11961196

1197+
datadog\_api\_client.v2.model.aws\_on\_demand\_attributes module
1198+
----------------------------------------------------------------
1199+
1200+
.. automodule:: datadog_api_client.v2.model.aws_on_demand_attributes
1201+
:members:
1202+
:show-inheritance:
1203+
1204+
datadog\_api\_client.v2.model.aws\_on\_demand\_create\_attributes module
1205+
------------------------------------------------------------------------
1206+
1207+
.. automodule:: datadog_api_client.v2.model.aws_on_demand_create_attributes
1208+
:members:
1209+
:show-inheritance:
1210+
1211+
datadog\_api\_client.v2.model.aws\_on\_demand\_create\_data module
1212+
------------------------------------------------------------------
1213+
1214+
.. automodule:: datadog_api_client.v2.model.aws_on_demand_create_data
1215+
:members:
1216+
:show-inheritance:
1217+
1218+
datadog\_api\_client.v2.model.aws\_on\_demand\_create\_request module
1219+
---------------------------------------------------------------------
1220+
1221+
.. automodule:: datadog_api_client.v2.model.aws_on_demand_create_request
1222+
:members:
1223+
:show-inheritance:
1224+
1225+
datadog\_api\_client.v2.model.aws\_on\_demand\_data module
1226+
----------------------------------------------------------
1227+
1228+
.. automodule:: datadog_api_client.v2.model.aws_on_demand_data
1229+
:members:
1230+
:show-inheritance:
1231+
1232+
datadog\_api\_client.v2.model.aws\_on\_demand\_list\_response module
1233+
--------------------------------------------------------------------
1234+
1235+
.. automodule:: datadog_api_client.v2.model.aws_on_demand_list_response
1236+
:members:
1237+
:show-inheritance:
1238+
1239+
datadog\_api\_client.v2.model.aws\_on\_demand\_response module
1240+
--------------------------------------------------------------
1241+
1242+
.. automodule:: datadog_api_client.v2.model.aws_on_demand_response
1243+
:members:
1244+
:show-inheritance:
1245+
1246+
datadog\_api\_client.v2.model.aws\_on\_demand\_type module
1247+
----------------------------------------------------------
1248+
1249+
.. automodule:: datadog_api_client.v2.model.aws_on_demand_type
1250+
:members:
1251+
:show-inheritance:
1252+
11971253
datadog\_api\_client.v2.model.aws\_regions module
11981254
-------------------------------------------------
11991255

@@ -1229,6 +1285,13 @@ datadog\_api\_client.v2.model.aws\_scan\_options\_attributes module
12291285
:members:
12301286
:show-inheritance:
12311287

1288+
datadog\_api\_client.v2.model.aws\_scan\_options\_create\_attributes module
1289+
---------------------------------------------------------------------------
1290+
1291+
.. automodule:: datadog_api_client.v2.model.aws_scan_options_create_attributes
1292+
:members:
1293+
:show-inheritance:
1294+
12321295
datadog\_api\_client.v2.model.aws\_scan\_options\_create\_data module
12331296
---------------------------------------------------------------------
12341297

‎datadog_api_client.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2481,11 +2481,20 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
24812481
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_new_external_id_response_attributes">datadog_api_client.v2.model.aws_new_external_id_response_attributes module</a></li>
24822482
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_new_external_id_response_data">datadog_api_client.v2.model.aws_new_external_id_response_data module</a></li>
24832483
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_new_external_id_response_data_type">datadog_api_client.v2.model.aws_new_external_id_response_data_type module</a></li>
2484+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_on_demand_attributes">datadog_api_client.v2.model.aws_on_demand_attributes module</a></li>
2485+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_on_demand_create_attributes">datadog_api_client.v2.model.aws_on_demand_create_attributes module</a></li>
2486+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_on_demand_create_data">datadog_api_client.v2.model.aws_on_demand_create_data module</a></li>
2487+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_on_demand_create_request">datadog_api_client.v2.model.aws_on_demand_create_request module</a></li>
2488+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_on_demand_data">datadog_api_client.v2.model.aws_on_demand_data module</a></li>
2489+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_on_demand_list_response">datadog_api_client.v2.model.aws_on_demand_list_response module</a></li>
2490+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_on_demand_response">datadog_api_client.v2.model.aws_on_demand_response module</a></li>
2491+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_on_demand_type">datadog_api_client.v2.model.aws_on_demand_type module</a></li>
24842492
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_regions">datadog_api_client.v2.model.aws_regions module</a></li>
24852493
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.aws_regions_include_all">datadog_api_client.v2.model.aws_regions_include_all module</a></li>
24862494
<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>
24872495
<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>
24882496
<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>
2497+
<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_attributes">datadog_api_client.v2.model.aws_scan_options_create_attributes module</a></li>
24892498
<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>
24902499
<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>
24912500
<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>

‎datadog_api_client.v2.api.html

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -697,12 +697,18 @@
697697
<ul class="md-nav__list">
698698
<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">
699699
<ul class="md-nav__list">
700+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.create_aws_on_demand_task" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">AgentlessScanningApi.create_aws_on_demand_task()</span></code></a>
701+
</li>
700702
<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>
701703
</li>
702704
<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>
703705
</li>
706+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.list_aws_on_demand_tasks" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">AgentlessScanningApi.list_aws_on_demand_tasks()</span></code></a>
707+
</li>
704708
<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>
705709
</li>
710+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.retrieve_aws_on_demand_task" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">AgentlessScanningApi.retrieve_aws_on_demand_task()</span></code></a>
711+
</li>
706712
<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>
707713
</li></ul>
708714
</nav>
@@ -2235,6 +2241,20 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
22352241
requiring teams to install Agents on every host or where Agents cannot be installed.
22362242
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>
22372243
<dl class="py method">
2244+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.create_aws_on_demand_task">
2245+
<span class="sig-name descname"><span class="pre">create_aws_on_demand_task</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_on_demand_create_request.AwsOnDemandCreateRequest" title="datadog_api_client.v2.model.aws_on_demand_create_request.AwsOnDemandCreateRequest"><span class="pre">AwsOnDemandCreateRequest</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_on_demand_response.AwsOnDemandResponse" title="datadog_api_client.v2.model.aws_on_demand_response.AwsOnDemandResponse"><span class="pre">AwsOnDemandResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.create_aws_on_demand_task" title="Link to this definition">¶</a></dt>
2246+
<dd><p>Post an AWS on demand task.</p>
2247+
<p>Trigger the scan of an AWS resource with a high priority.</p>
2248+
<dl class="field-list simple">
2249+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
2250+
<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_on_demand_create_request.AwsOnDemandCreateRequest" title="datadog_api_client.v2.model.aws_on_demand_create_request.AwsOnDemandCreateRequest"><em>AwsOnDemandCreateRequest</em></a>) – The definition of the on demand task.</p>
2251+
</dd>
2252+
<dt class="field-even">Return type<span class="colon">:</span></dt>
2253+
<dd class="field-even"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.aws_on_demand_response.AwsOnDemandResponse" title="datadog_api_client.v2.model.aws_on_demand_response.AwsOnDemandResponse">AwsOnDemandResponse</a></p>
2254+
</dd>
2255+
</dl>
2256+
</dd></dl>
2257+
<dl class="py method">
22382258
<dt class="sig sig-object py" id="datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.create_aws_scan_options">
22392259
<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>
22402260
<dd><p>Post AWS Scan Options.</p>
@@ -2263,6 +2283,17 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
22632283
</dl>
22642284
</dd></dl>
22652285
<dl class="py method">
2286+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.list_aws_on_demand_tasks">
2287+
<span class="sig-name descname"><span class="pre">list_aws_on_demand_tasks</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_on_demand_list_response.AwsOnDemandListResponse" title="datadog_api_client.v2.model.aws_on_demand_list_response.AwsOnDemandListResponse"><span class="pre">AwsOnDemandListResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.list_aws_on_demand_tasks" title="Link to this definition">¶</a></dt>
2288+
<dd><p>Get AWS On Demand tasks.</p>
2289+
<p>Fetches the most recent 1000 AWS on demand tasks.</p>
2290+
<dl class="field-list simple">
2291+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2292+
<dd class="field-odd"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.aws_on_demand_list_response.AwsOnDemandListResponse" title="datadog_api_client.v2.model.aws_on_demand_list_response.AwsOnDemandListResponse">AwsOnDemandListResponse</a></p>
2293+
</dd>
2294+
</dl>
2295+
</dd></dl>
2296+
<dl class="py method">
22662297
<dt class="sig sig-object py" id="datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.list_aws_scan_options">
22672298
<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>
22682299
<dd><p>Get AWS Scan Options.</p>
@@ -2274,6 +2305,20 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
22742305
</dl>
22752306
</dd></dl>
22762307
<dl class="py method">
2308+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.retrieve_aws_on_demand_task">
2309+
<span class="sig-name descname"><span class="pre">retrieve_aws_on_demand_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_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"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.aws_on_demand_response.AwsOnDemandResponse" title="datadog_api_client.v2.model.aws_on_demand_response.AwsOnDemandResponse"><span class="pre">AwsOnDemandResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.retrieve_aws_on_demand_task" title="Link to this definition">¶</a></dt>
2310+
<dd><p>Get AWS On Demand task by id.</p>
2311+
<p>Fetch the data of a specific on demand task.</p>
2312+
<dl class="field-list simple">
2313+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
2314+
<dd class="field-odd"><p><strong>task_id</strong> (<em>str</em>) – The UUID of the task.</p>
2315+
</dd>
2316+
<dt class="field-even">Return type<span class="colon">:</span></dt>
2317+
<dd class="field-even"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.aws_on_demand_response.AwsOnDemandResponse" title="datadog_api_client.v2.model.aws_on_demand_response.AwsOnDemandResponse">AwsOnDemandResponse</a></p>
2318+
</dd>
2319+
</dl>
2320+
</dd></dl>
2321+
<dl class="py method">
22772322
<dt class="sig sig-object py" id="datadog_api_client.v2.api.agentless_scanning_api.AgentlessScanningApi.update_aws_scan_options">
22782323
<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>
22792324
<dd><p>Patch AWS Scan Options.</p>

0 commit comments

Comments
 (0)