Add suppressions to SensitiveDataScannerRule resource (#3050)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> 4ae0268

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

_sources/datadog_api_client.v2.model.rst.txt

@@ -24686,6 +24686,13 @@ datadog\_api\_client.v2.model.sensitive\_data\_scanner\_standard\_patterns\_resp
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.sensitive\_data\_scanner\_suppressions module
+---------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.sensitive_data_scanner_suppressions
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.sensitive\_data\_scanner\_text\_replacement module
 --------------------------------------------------------------------------------
 

datadog_api_client.html

@@ -6094,6 +6094,7 @@ <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.sensitive_data_scanner_standard_patterns_response">datadog_api_client.v2.model.sensitive_data_scanner_standard_patterns_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.sensitive_data_scanner_standard_patterns_response_data">datadog_api_client.v2.model.sensitive_data_scanner_standard_patterns_response_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.sensitive_data_scanner_standard_patterns_response_item">datadog_api_client.v2.model.sensitive_data_scanner_standard_patterns_response_item module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_suppressions">datadog_api_client.v2.model.sensitive_data_scanner_suppressions module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_text_replacement">datadog_api_client.v2.model.sensitive_data_scanner_text_replacement module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_text_replacement_type">datadog_api_client.v2.model.sensitive_data_scanner_text_replacement_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.service_account_create_attributes">datadog_api_client.v2.model.service_account_create_attributes module</a></li>

datadog_api_client.v2.html

@@ -16655,6 +16655,10 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
 <li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.sensitive_data_scanner_standard_patterns_response_item.SensitiveDataScannerStandardPatternsResponseItem"><code class="docutils literal notranslate"><span class="pre">SensitiveDataScannerStandardPatternsResponseItem</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_suppressions">datadog_api_client.v2.model.sensitive_data_scanner_suppressions module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.sensitive_data_scanner_suppressions.SensitiveDataScannerSuppressions"><code class="docutils literal notranslate"><span class="pre">SensitiveDataScannerSuppressions</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_text_replacement">datadog_api_client.v2.model.sensitive_data_scanner_text_replacement module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.sensitive_data_scanner_text_replacement.SensitiveDataScannerTextReplacement"><code class="docutils literal notranslate"><span class="pre">SensitiveDataScannerTextReplacement</span></code></a></li>
 </ul>

datadog_api_client.v2.model.html

@@ -22141,6 +22141,12 @@
         </li></ul>
             </nav>
         </li>
+        <li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.sensitive_data_scanner_suppressions" class="md-nav__link">datadog_api_client.v2.model.sensitive_data_scanner_suppressions module</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.model.sensitive_data_scanner_suppressions.SensitiveDataScannerSuppressions" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SensitiveDataScannerSuppressions</span></code></a>
+        </li></ul>
+            </nav>
+        </li>
         <li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.sensitive_data_scanner_text_replacement" class="md-nav__link">datadog_api_client.v2.model.sensitive_data_scanner_text_replacement module</a><nav class="md-nav">
               <ul class="md-nav__list">
         <li class="md-nav__item"><a href="#datadog_api_client.v2.model.sensitive_data_scanner_text_replacement.SensitiveDataScannerTextReplacement" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SensitiveDataScannerTextReplacement</span></code></a>
@@ -109186,6 +109192,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 If both are missing the whole event is scanned.</p></li>
 <li><p><strong>pattern</strong> (<em>str</em><em>, </em><em>optional</em>) – Not included if there is a relationship to a standard pattern.</p></li>
 <li><p><strong>priority</strong> (<em>int</em><em>, </em><em>optional</em>) – Integer from 1 (high) to 5 (low) indicating rule issue severity.</p></li>
+<li><p><strong>suppressions</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.sensitive_data_scanner_suppressions.SensitiveDataScannerSuppressions" title="datadog_api_client.v2.model.sensitive_data_scanner_suppressions.SensitiveDataScannerSuppressions"><em>SensitiveDataScannerSuppressions</em></a><em>, </em><em>optional</em>) – Object describing the suppressions for a rule. There are three types of suppressions, <code class="docutils literal notranslate"><span class="pre">starts_with</span></code> , <code class="docutils literal notranslate"><span class="pre">ends_with</span></code> , and <code class="docutils literal notranslate"><span class="pre">exact_match</span></code>.
+Suppressed matches are not obfuscated, counted in metrics, or displayed in the Findings page.</p></li>
 <li><p><strong>tags</strong> (<em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – List of tags.</p></li>
 <li><p><strong>text_replacement</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.sensitive_data_scanner_text_replacement.SensitiveDataScannerTextReplacement" title="datadog_api_client.v2.model.sensitive_data_scanner_text_replacement.SensitiveDataScannerTextReplacement"><em>SensitiveDataScannerTextReplacement</em></a><em>, </em><em>optional</em>) – Object describing how the scanned event will be replaced.</p></li>
 </ul>
@@ -109636,6 +109644,29 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 </dl>
 </dd></dl>
 </section>
+<section id="module-datadog_api_client.v2.model.sensitive_data_scanner_suppressions">
+<span id="datadog-api-client-v2-model-sensitive-data-scanner-suppressions-module"></span><h2 id="module-datadog_api_client.v2.model.sensitive_data_scanner_suppressions">datadog_api_client.v2.model.sensitive_data_scanner_suppressions module<a class="headerlink" href="#module-datadog_api_client.v2.model.sensitive_data_scanner_suppressions" title="Link to this heading">¶</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="datadog_api_client.v2.model.sensitive_data_scanner_suppressions.SensitiveDataScannerSuppressions">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SensitiveDataScannerSuppressions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datadog_api_client.v2.model.sensitive_data_scanner_suppressions.SensitiveDataScannerSuppressions" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SensitiveDataScannerSuppressions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</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.html#datadog_api_client.model_utils.ModelComposed" title="datadog_api_client.model_utils.ModelComposed"><span class="pre">ModelComposed</span></a></span></em><span class="sig-paren">)</span></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SensitiveDataScannerSuppressions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span></dt>
+<dd><p>Bases: <a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelNormal" title="datadog_api_client.model_utils.ModelNormal"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelNormal</span></code></a></p>
+<p>Object describing the suppressions for a rule. There are three types of suppressions, <code class="docutils literal notranslate"><span class="pre">starts_with</span></code> , <code class="docutils literal notranslate"><span class="pre">ends_with</span></code> , and <code class="docutils literal notranslate"><span class="pre">exact_match</span></code>.
+Suppressed matches are not obfuscated, counted in metrics, or displayed in the Findings page.</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>ends_with</strong> (<em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – List of strings to use for suppression of matches ending with these strings.</p></li>
+<li><p><strong>exact_match</strong> (<em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – List of strings to use for suppression of matches exactly matching these strings.</p></li>
+<li><p><strong>starts_with</strong> (<em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – List of strings to use for suppression of matches starting with these strings.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+</section>
 <section id="module-datadog_api_client.v2.model.sensitive_data_scanner_text_replacement">
 <span id="datadog-api-client-v2-model-sensitive-data-scanner-text-replacement-module"></span><h2 id="module-datadog_api_client.v2.model.sensitive_data_scanner_text_replacement">datadog_api_client.v2.model.sensitive_data_scanner_text_replacement module<a class="headerlink" href="#module-datadog_api_client.v2.model.sensitive_data_scanner_text_replacement" title="Link to this heading">¶</a></h2>
 <dl class="py class">

genindex.html

@@ -23134,15 +23134,15 @@ <h2 id="D">D</h2>
         <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.global_variable_json_patch_request">module</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     datadog_api_client.v2.model.global_variable_json_patch_request_data
 
       <ul>
         <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.global_variable_json_patch_request_data">module</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     datadog_api_client.v2.model.global_variable_json_patch_request_data_attributes
 
@@ -36322,6 +36322,13 @@ <h2 id="D">D</h2>
 
       <ul>
         <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_standard_patterns_response_item">module</a>
+</li>
+      </ul></li>
+      <li>
+    datadog_api_client.v2.model.sensitive_data_scanner_suppressions
+
+      <ul>
+        <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_suppressions">module</a>
 </li>
       </ul></li>
       <li>
@@ -55277,6 +55284,8 @@ <h2 id="M">M</h2>
         <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_standard_patterns_response_data">datadog_api_client.v2.model.sensitive_data_scanner_standard_patterns_response_data</a>
 </li>
         <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_standard_patterns_response_item">datadog_api_client.v2.model.sensitive_data_scanner_standard_patterns_response_item</a>
+</li>
+        <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_suppressions">datadog_api_client.v2.model.sensitive_data_scanner_suppressions</a>
 </li>
         <li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_text_replacement">datadog_api_client.v2.model.sensitive_data_scanner_text_replacement</a>
 </li>
@@ -59816,6 +59825,8 @@ <h2 id="S">S</h2>
       <li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.sensitive_data_scanner_standard_patterns_response_item.SensitiveDataScannerStandardPatternsResponseItem">SensitiveDataScannerStandardPatternsResponseItem (class in datadog_api_client.v2.model.sensitive_data_scanner_standard_patterns_response_item)</a>
 </li>
       <li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.sensitive_data_scanner_standard_pattern_type.SensitiveDataScannerStandardPatternType">SensitiveDataScannerStandardPatternType (class in datadog_api_client.v2.model.sensitive_data_scanner_standard_pattern_type)</a>
+</li>
+      <li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.sensitive_data_scanner_suppressions.SensitiveDataScannerSuppressions">SensitiveDataScannerSuppressions (class in datadog_api_client.v2.model.sensitive_data_scanner_suppressions)</a>
 </li>
       <li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.sensitive_data_scanner_text_replacement.SensitiveDataScannerTextReplacement">SensitiveDataScannerTextReplacement (class in datadog_api_client.v2.model.sensitive_data_scanner_text_replacement)</a>
 </li>
@@ -60068,11 +60079,11 @@ <h2 id="S">S</h2>
       <li><a href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.on_call_api.OnCallApi.set_on_call_team_routing_rules">set_on_call_team_routing_rules() (OnCallApi method)</a>
 </li>
       <li><a href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.synthetics_api.SyntheticsApi.set_on_demand_concurrency_cap">set_on_demand_concurrency_cap() (SyntheticsApi method)</a>
-</li>
-      <li><a href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.shared_dashboard.SharedDashboard">SharedDashboard (class in datadog_api_client.v1.model.shared_dashboard)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.shared_dashboard.SharedDashboard">SharedDashboard (class in datadog_api_client.v1.model.shared_dashboard)</a>
+</li>
       <li><a href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.shared_dashboard_author.SharedDashboardAuthor">SharedDashboardAuthor (class in datadog_api_client.v1.model.shared_dashboard_author)</a>
 </li>
       <li><a href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.shared_dashboard_invitees_items.SharedDashboardInviteesItems">SharedDashboardInviteesItems (class in datadog_api_client.v1.model.shared_dashboard_invitees_items)</a>

objects.inv

@@ -24047,6 +24047,11 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_standard_patterns_response_item"><code class="xref">datadog_api_client.v2.model.sensitive_data_scanner_standard_patterns_response_item</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sensitive_data_scanner_suppressions"><code class="xref">datadog_api_client.v2.model.sensitive_data_scanner_suppressions</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;