Update documentation for Cloud SIEM (#1722)

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

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-13 14:48:32.400230",
-            "spec_repo_commit": "9c0d47b3"
+            "regenerated": "2023-10-16 19:14:55.749551",
+            "spec_repo_commit": "4f580adf"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-13 14:48:32.484748",
-            "spec_repo_commit": "9c0d47b3"
+            "regenerated": "2023-10-16 19:14:55.767443",
+            "spec_repo_commit": "4f580adf"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -3902,6 +3902,7 @@ components:
       - appsec_usage
       - browser_usage
       - ci_visibility_itr_usage
+      - cloud_siem_usage
       - container_excl_agent_usage
       - container_usage
       - cspm_containers_usage
@@ -3943,6 +3944,7 @@ components:
       - APPSEC_USAGE
       - BROWSER_USAGE
       - CI_VISIBILITY_ITR_USAGE
+      - CLOUD_SIEM_USAGE
       - CONTAINER_EXCL_AGENT_USAGE
       - CONTAINER_USAGE
       - CSPM_CONTAINERS_USAGE
@@ -7505,6 +7507,8 @@ components:
       - browser_percentage
       - ci_visibility_itr_usage
       - ci_visibility_itr_percentage
+      - cloud_siem_usage
+      - cloud_siem_percentage
       - container_excl_agent_usage
       - container_excl_agent_percentage
       - container_usage
@@ -7586,6 +7590,8 @@ components:
       - BROWSER_PERCENTAGE
       - CI_VISIBILITY_ITR_USAGE
       - CI_VISIBILITY_ITR_PERCENTAGE
+      - CLOUD_SIEM_USAGE
+      - CLOUD_SIEM_PERCENTAGE
       - CONTAINER_EXCL_AGENT_USAGE
       - CONTAINER_EXCL_AGENT_PERCENTAGE
       - CONTAINER_USAGE
@@ -7721,6 +7727,16 @@ components:
           description: The Git committers for Intelligent Test Runner usage by tag(s).
           format: double
           type: number
+        cloud_siem_percentage:
+          description: The percentage of Cloud Security Information and Event Management
+            usage by tag(s).
+          format: double
+          type: number
+        cloud_siem_usage:
+          description: The Cloud Security Information and Event Management usage by
+            tag(s).
+          format: double
+          type: number
         container_excl_agent_percentage:
           description: The percentage of container usage without the Datadog Agent
             by tag(s).
@@ -18022,6 +18038,11 @@ components:
             for the given date and given organization.
           format: int64
           type: integer
+        cloud_siem_events_sum:
+          description: Shows the sum of all Cloud Security Information and Event Management
+            events over all hours in the current date for the given org.
+          format: int64
+          type: integer
         container_avg:
           description: Shows the average of all distinct containers over all hours
             in the current date for all organizations.
@@ -18543,6 +18564,11 @@ components:
             for the given date and given org.
           format: int64
           type: integer
+        cloud_siem_events_sum:
+          description: Shows the sum of all Cloud Security Information and Event Management
+            events over all hours in the current date for the given org.
+          format: int64
+          type: integer
         container_avg:
           description: Shows the average of all distinct containers over all hours
             in the current date for the given org.
@@ -19071,6 +19097,11 @@ components:
             all cloud providers.
           format: int64
           type: integer
+        cloud_siem_events_agg_sum:
+          description: Shows the sum of all Cloud Security Information and Event Management
+            events over all hours in the current months for all organizations.
+          format: int64
+          type: integer
         container_avg_sum:
           description: Shows the average of all distinct containers over all hours
             in the current months for all organizations.

src/datadog_api_client/v1/model/hourly_usage_attribution_usage_type.py

@@ -16,7 +16,7 @@ class HourlyUsageAttributionUsageType(ModelSimple):
     """
     Supported products for hourly usage attribution requests.
 
-    :param value: Must be one of ["api_usage", "apm_fargate_usage", "apm_host_usage", "apm_usm_usage", "appsec_fargate_usage", "appsec_usage", "browser_usage", "ci_visibility_itr_usage", "container_excl_agent_usage", "container_usage", "cspm_containers_usage", "cspm_hosts_usage", "custom_ingested_timeseries_usage", "custom_timeseries_usage", "cws_containers_usage", "cws_hosts_usage", "dbm_hosts_usage", "dbm_queries_usage", "estimated_indexed_logs_usage", "estimated_indexed_spans_usage", "estimated_ingested_logs_usage", "estimated_ingested_spans_usage", "estimated_rum_sessions_usage", "fargate_usage", "functions_usage", "infra_host_usage", "invocations_usage", "mobile_app_testing_usage", "ndm_netflow_usage", "npm_host_usage", "obs_pipeline_bytes_usage", "profiled_container_usage", "profiled_fargate_usage", "profiled_host_usage", "sds_scanned_bytes_usage", "serverless_apps_usage", "snmp_usage", "universal_service_monitoring_usage", "vuln_management_hosts_usage"].
+    :param value: Must be one of ["api_usage", "apm_fargate_usage", "apm_host_usage", "apm_usm_usage", "appsec_fargate_usage", "appsec_usage", "browser_usage", "ci_visibility_itr_usage", "cloud_siem_usage", "container_excl_agent_usage", "container_usage", "cspm_containers_usage", "cspm_hosts_usage", "custom_ingested_timeseries_usage", "custom_timeseries_usage", "cws_containers_usage", "cws_hosts_usage", "dbm_hosts_usage", "dbm_queries_usage", "estimated_indexed_logs_usage", "estimated_indexed_spans_usage", "estimated_ingested_logs_usage", "estimated_ingested_spans_usage", "estimated_rum_sessions_usage", "fargate_usage", "functions_usage", "infra_host_usage", "invocations_usage", "mobile_app_testing_usage", "ndm_netflow_usage", "npm_host_usage", "obs_pipeline_bytes_usage", "profiled_container_usage", "profiled_fargate_usage", "profiled_host_usage", "sds_scanned_bytes_usage", "serverless_apps_usage", "snmp_usage", "universal_service_monitoring_usage", "vuln_management_hosts_usage"].
     :type value: str
     """
 
@@ -29,6 +29,7 @@ class HourlyUsageAttributionUsageType(ModelSimple):
         "appsec_usage",
         "browser_usage",
         "ci_visibility_itr_usage",
+        "cloud_siem_usage",
         "container_excl_agent_usage",
         "container_usage",
         "cspm_containers_usage",
@@ -69,6 +70,7 @@ class HourlyUsageAttributionUsageType(ModelSimple):
     APPSEC_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
     BROWSER_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
     CI_VISIBILITY_ITR_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
+    CLOUD_SIEM_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
     CONTAINER_EXCL_AGENT_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
     CONTAINER_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
     CSPM_CONTAINERS_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
@@ -116,6 +118,7 @@ def openapi_types(_):
 HourlyUsageAttributionUsageType.APPSEC_USAGE = HourlyUsageAttributionUsageType("appsec_usage")
 HourlyUsageAttributionUsageType.BROWSER_USAGE = HourlyUsageAttributionUsageType("browser_usage")
 HourlyUsageAttributionUsageType.CI_VISIBILITY_ITR_USAGE = HourlyUsageAttributionUsageType("ci_visibility_itr_usage")
+HourlyUsageAttributionUsageType.CLOUD_SIEM_USAGE = HourlyUsageAttributionUsageType("cloud_siem_usage")
 HourlyUsageAttributionUsageType.CONTAINER_EXCL_AGENT_USAGE = HourlyUsageAttributionUsageType(
     "container_excl_agent_usage"
 )

src/datadog_api_client/v1/model/monthly_usage_attribution_supported_metrics.py

@@ -16,7 +16,7 @@ class MonthlyUsageAttributionSupportedMetrics(ModelSimple):
     """
     Supported metrics for monthly usage attribution requests.
 
-    :param value: Must be one of ["api_usage", "api_percentage", "apm_fargate_usage", "apm_fargate_percentage", "appsec_fargate_usage", "appsec_fargate_percentage", "apm_host_usage", "apm_host_percentage", "apm_usm_usage", "apm_usm_percentage", "appsec_usage", "appsec_percentage", "browser_usage", "browser_percentage", "ci_visibility_itr_usage", "ci_visibility_itr_percentage", "container_excl_agent_usage", "container_excl_agent_percentage", "container_usage", "container_percentage", "cspm_containers_percentage", "cspm_containers_usage", "cspm_hosts_percentage", "cspm_hosts_usage", "custom_timeseries_usage", "custom_timeseries_percentage", "custom_ingested_timeseries_usage", "custom_ingested_timeseries_percentage", "cws_containers_percentage", "cws_containers_usage", "cws_hosts_percentage", "cws_hosts_usage", "dbm_hosts_percentage", "dbm_hosts_usage", "dbm_queries_percentage", "dbm_queries_usage", "estimated_indexed_logs_usage", "estimated_indexed_logs_percentage", "estimated_ingested_logs_usage", "estimated_ingested_logs_percentage", "estimated_indexed_spans_usage", "estimated_indexed_spans_percentage", "estimated_ingested_spans_usage", "estimated_ingested_spans_percentage", "fargate_usage", "fargate_percentage", "functions_usage", "functions_percentage", "infra_host_usage", "infra_host_percentage", "invocations_usage", "invocations_percentage", "mobile_app_testing_percentage", "mobile_app_testing_usage", "ndm_netflow_usage", "ndm_netflow_percentage", "npm_host_usage", "npm_host_percentage", "obs_pipeline_bytes_usage", "obs_pipeline_bytes_percentage", "profiled_container_usage", "profiled_container_percentage", "profiled_fargate_usage", "profiled_fargate_percentage", "profiled_host_usage", "profiled_host_percentage", "serverless_apps_usage", "serverless_apps_percentage", "snmp_usage", "snmp_percentage", "estimated_rum_sessions_usage", "estimated_rum_sessions_percentage", "universal_service_monitoring_usage", "universal_service_monitoring_percentage", "vuln_management_hosts_usage", "vuln_management_hosts_percentage", "sds_scanned_bytes_usage", "sds_scanned_bytes_percentage", "*"].
+    :param value: Must be one of ["api_usage", "api_percentage", "apm_fargate_usage", "apm_fargate_percentage", "appsec_fargate_usage", "appsec_fargate_percentage", "apm_host_usage", "apm_host_percentage", "apm_usm_usage", "apm_usm_percentage", "appsec_usage", "appsec_percentage", "browser_usage", "browser_percentage", "ci_visibility_itr_usage", "ci_visibility_itr_percentage", "cloud_siem_usage", "cloud_siem_percentage", "container_excl_agent_usage", "container_excl_agent_percentage", "container_usage", "container_percentage", "cspm_containers_percentage", "cspm_containers_usage", "cspm_hosts_percentage", "cspm_hosts_usage", "custom_timeseries_usage", "custom_timeseries_percentage", "custom_ingested_timeseries_usage", "custom_ingested_timeseries_percentage", "cws_containers_percentage", "cws_containers_usage", "cws_hosts_percentage", "cws_hosts_usage", "dbm_hosts_percentage", "dbm_hosts_usage", "dbm_queries_percentage", "dbm_queries_usage", "estimated_indexed_logs_usage", "estimated_indexed_logs_percentage", "estimated_ingested_logs_usage", "estimated_ingested_logs_percentage", "estimated_indexed_spans_usage", "estimated_indexed_spans_percentage", "estimated_ingested_spans_usage", "estimated_ingested_spans_percentage", "fargate_usage", "fargate_percentage", "functions_usage", "functions_percentage", "infra_host_usage", "infra_host_percentage", "invocations_usage", "invocations_percentage", "mobile_app_testing_percentage", "mobile_app_testing_usage", "ndm_netflow_usage", "ndm_netflow_percentage", "npm_host_usage", "npm_host_percentage", "obs_pipeline_bytes_usage", "obs_pipeline_bytes_percentage", "profiled_container_usage", "profiled_container_percentage", "profiled_fargate_usage", "profiled_fargate_percentage", "profiled_host_usage", "profiled_host_percentage", "serverless_apps_usage", "serverless_apps_percentage", "snmp_usage", "snmp_percentage", "estimated_rum_sessions_usage", "estimated_rum_sessions_percentage", "universal_service_monitoring_usage", "universal_service_monitoring_percentage", "vuln_management_hosts_usage", "vuln_management_hosts_percentage", "sds_scanned_bytes_usage", "sds_scanned_bytes_percentage", "*"].
     :type value: str
     """
 
@@ -37,6 +37,8 @@ class MonthlyUsageAttributionSupportedMetrics(ModelSimple):
         "browser_percentage",
         "ci_visibility_itr_usage",
         "ci_visibility_itr_percentage",
+        "cloud_siem_usage",
+        "cloud_siem_percentage",
         "container_excl_agent_usage",
         "container_excl_agent_percentage",
         "container_usage",
@@ -117,6 +119,8 @@ class MonthlyUsageAttributionSupportedMetrics(ModelSimple):
     BROWSER_PERCENTAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
     CI_VISIBILITY_ITR_USAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
     CI_VISIBILITY_ITR_PERCENTAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
+    CLOUD_SIEM_USAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
+    CLOUD_SIEM_PERCENTAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
     CONTAINER_EXCL_AGENT_USAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
     CONTAINER_EXCL_AGENT_PERCENTAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
     CONTAINER_USAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
@@ -220,6 +224,10 @@ def openapi_types(_):
 MonthlyUsageAttributionSupportedMetrics.CI_VISIBILITY_ITR_PERCENTAGE = MonthlyUsageAttributionSupportedMetrics(
     "ci_visibility_itr_percentage"
 )
+MonthlyUsageAttributionSupportedMetrics.CLOUD_SIEM_USAGE = MonthlyUsageAttributionSupportedMetrics("cloud_siem_usage")
+MonthlyUsageAttributionSupportedMetrics.CLOUD_SIEM_PERCENTAGE = MonthlyUsageAttributionSupportedMetrics(
+    "cloud_siem_percentage"
+)
 MonthlyUsageAttributionSupportedMetrics.CONTAINER_EXCL_AGENT_USAGE = MonthlyUsageAttributionSupportedMetrics(
     "container_excl_agent_usage"
 )

src/datadog_api_client/v1/model/monthly_usage_attribution_values.py

@@ -33,6 +33,8 @@ def openapi_types(_):
             "browser_usage": (float,),
             "ci_visibility_itr_percentage": (float,),
             "ci_visibility_itr_usage": (float,),
+            "cloud_siem_percentage": (float,),
+            "cloud_siem_usage": (float,),
             "container_excl_agent_percentage": (float,),
             "container_excl_agent_usage": (float,),
             "container_percentage": (float,),
@@ -114,6 +116,8 @@ def openapi_types(_):
         "browser_usage": "browser_usage",
         "ci_visibility_itr_percentage": "ci_visibility_itr_percentage",
         "ci_visibility_itr_usage": "ci_visibility_itr_usage",
+        "cloud_siem_percentage": "cloud_siem_percentage",
+        "cloud_siem_usage": "cloud_siem_usage",
         "container_excl_agent_percentage": "container_excl_agent_percentage",
         "container_excl_agent_usage": "container_excl_agent_usage",
         "container_percentage": "container_percentage",
@@ -196,6 +200,8 @@ def __init__(
         browser_usage: Union[float, UnsetType] = unset,
         ci_visibility_itr_percentage: Union[float, UnsetType] = unset,
         ci_visibility_itr_usage: Union[float, UnsetType] = unset,
+        cloud_siem_percentage: Union[float, UnsetType] = unset,
+        cloud_siem_usage: Union[float, UnsetType] = unset,
         container_excl_agent_percentage: Union[float, UnsetType] = unset,
         container_excl_agent_usage: Union[float, UnsetType] = unset,
         container_percentage: Union[float, UnsetType] = unset,
@@ -311,6 +317,12 @@ def __init__(
         :param ci_visibility_itr_usage: The Git committers for Intelligent Test Runner usage by tag(s).
         :type ci_visibility_itr_usage: float, optional
 
+        :param cloud_siem_percentage: The percentage of Cloud Security Information and Event Management usage by tag(s).
+        :type cloud_siem_percentage: float, optional
+
+        :param cloud_siem_usage: The Cloud Security Information and Event Management usage by tag(s).
+        :type cloud_siem_usage: float, optional
+
         :param container_excl_agent_percentage: The percentage of container usage without the Datadog Agent by tag(s).
         :type container_excl_agent_percentage: float, optional
 
@@ -529,6 +541,10 @@ def __init__(
             kwargs["ci_visibility_itr_percentage"] = ci_visibility_itr_percentage
         if ci_visibility_itr_usage is not unset:
             kwargs["ci_visibility_itr_usage"] = ci_visibility_itr_usage
+        if cloud_siem_percentage is not unset:
+            kwargs["cloud_siem_percentage"] = cloud_siem_percentage
+        if cloud_siem_usage is not unset:
+            kwargs["cloud_siem_usage"] = cloud_siem_usage
         if container_excl_agent_percentage is not unset:
             kwargs["container_excl_agent_percentage"] = container_excl_agent_percentage
         if container_excl_agent_usage is not unset:

src/datadog_api_client/v1/model/usage_summary_date.py

@@ -48,6 +48,7 @@ def openapi_types(_):
             "cloud_cost_management_aws_host_count_avg": (int,),
             "cloud_cost_management_azure_host_count_avg": (int,),
             "cloud_cost_management_host_count_avg": (int,),
+            "cloud_siem_events_sum": (int,),
             "container_avg": (int,),
             "container_excl_agent_avg": (int,),
             "container_hwm": (int,),
@@ -152,6 +153,7 @@ def openapi_types(_):
         "cloud_cost_management_aws_host_count_avg": "cloud_cost_management_aws_host_count_avg",
         "cloud_cost_management_azure_host_count_avg": "cloud_cost_management_azure_host_count_avg",
         "cloud_cost_management_host_count_avg": "cloud_cost_management_host_count_avg",
+        "cloud_siem_events_sum": "cloud_siem_events_sum",
         "container_avg": "container_avg",
         "container_excl_agent_avg": "container_excl_agent_avg",
         "container_hwm": "container_hwm",
@@ -257,6 +259,7 @@ def __init__(
         cloud_cost_management_aws_host_count_avg: Union[int, UnsetType] = unset,
         cloud_cost_management_azure_host_count_avg: Union[int, UnsetType] = unset,
         cloud_cost_management_host_count_avg: Union[int, UnsetType] = unset,
+        cloud_siem_events_sum: Union[int, UnsetType] = unset,
         container_avg: Union[int, UnsetType] = unset,
         container_excl_agent_avg: Union[int, UnsetType] = unset,
         container_hwm: Union[int, UnsetType] = unset,
@@ -411,6 +414,9 @@ def __init__(
         :param cloud_cost_management_host_count_avg: Host count average of Cloud Cost Management for all cloud providers for the given date and given organization.
         :type cloud_cost_management_host_count_avg: int, optional
 
+        :param cloud_siem_events_sum: Shows the sum of all Cloud Security Information and Event Management events over all hours in the current date for the given org.
+        :type cloud_siem_events_sum: int, optional
+
         :param container_avg: Shows the average of all distinct containers over all hours in the current date for all organizations.
         :type container_avg: int, optional
 
@@ -690,6 +696,8 @@ def __init__(
             kwargs["cloud_cost_management_azure_host_count_avg"] = cloud_cost_management_azure_host_count_avg
         if cloud_cost_management_host_count_avg is not unset:
             kwargs["cloud_cost_management_host_count_avg"] = cloud_cost_management_host_count_avg
+        if cloud_siem_events_sum is not unset:
+            kwargs["cloud_siem_events_sum"] = cloud_siem_events_sum
         if container_avg is not unset:
             kwargs["container_avg"] = container_avg
         if container_excl_agent_avg is not unset: