Skip to content

Commit 4d27259

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Update public docs for CSM Enterprise and CSPM (#1664)
Co-authored-by: ci.datadog-api-spec <[email protected]> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
1 parent 3a22915 commit 4d27259

16 files changed

+582
-117
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2023-09-22 15:04:35.073309",
8-
"spec_repo_commit": "61ae9703"
7+
"regenerated": "2023-09-22 16:26:43.981290",
8+
"spec_repo_commit": "45270a3e"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2023-09-22 15:04:35.095240",
13-
"spec_repo_commit": "61ae9703"
12+
"regenerated": "2023-09-22 16:26:43.995673",
13+
"spec_repo_commit": "45270a3e"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 238 additions & 67 deletions
Large diffs are not rendered by default.

.generator/schemas/v2/openapi.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27121,7 +27121,8 @@ paths:
2712127121

2712227122
`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`,
2712327123

27124-
`cspm`, `custom_events`, `cws`, `dbm`, `fargate`,
27124+
`csm_container_enterprise`, `csm_host_enterprise`, `cspm`, `custom_events`,
27125+
`cws`, `dbm`, `fargate`,
2712527126

2712627127
`infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`,
2712727128
`iot`,

examples/v1/usage-metering/GetUsageCloudSecurityPostureManagement.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Get hourly usage for CSPM returns "OK" response
2+
Get hourly usage for CSM Pro returns "OK" response
33
"""
44

55
from datetime import datetime

src/datadog_api_client/v1/api/usage_metering_api.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1743,9 +1743,9 @@ def get_usage_cloud_security_posture_management(
17431743
*,
17441744
end_hr: Union[datetime, UnsetType] = unset,
17451745
) -> UsageCloudSecurityPostureManagementResponse:
1746-
"""Get hourly usage for CSPM.
1746+
"""Get hourly usage for CSM Pro.
17471747
1748-
Get hourly usage for cloud security posture management (CSPM).
1748+
Get hourly usage for cloud security management (CSM) pro.
17491749
**Note:** hourly usage data for all products is now available in the `Get hourly usage by product family API <https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family>`_. Refer to `Migrating from the V1 Hourly Usage APIs to V2 <https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/>`_ for the associated migration guide.
17501750
17511751
:param start_hr: Datetime in ISO-8601 format, UTC, precise to hour: ``[YYYY-MM-DDThh]`` for usage beginning at this hour.

src/datadog_api_client/v1/model/monthly_usage_attribution_values.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -311,16 +311,16 @@ def __init__(
311311
:param container_usage: The container usage by tag(s).
312312
:type container_usage: float, optional
313313
314-
:param cspm_containers_percentage: The percentage of CSPM container usage by tag(s).
314+
:param cspm_containers_percentage: The percentage of Cloud Security Management Pro container usage by tag(s).
315315
:type cspm_containers_percentage: float, optional
316316
317-
:param cspm_containers_usage: The CSPM container usage by tag(s).
317+
:param cspm_containers_usage: The Cloud Security Management Pro container usage by tag(s).
318318
:type cspm_containers_usage: float, optional
319319
320-
:param cspm_hosts_percentage: The percentage of CSPM host usage by by tag(s).
320+
:param cspm_hosts_percentage: The percentage of Cloud Security Management Pro host usage by tag(s).
321321
:type cspm_hosts_percentage: float, optional
322322
323-
:param cspm_hosts_usage: The CSPM host usage by tag(s).
323+
:param cspm_hosts_usage: The Cloud Security Management Pro host usage by tag(s).
324324
:type cspm_hosts_usage: float, optional
325325
326326
:param custom_ingested_timeseries_percentage: The percentage of ingested custom metrics usage by tag(s).

src/datadog_api_client/v1/model/usage_attribution_values.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -227,16 +227,16 @@ def __init__(
227227
:param container_usage: The container usage by tag(s).
228228
:type container_usage: float, optional
229229
230-
:param cspm_container_percentage: The percentage of Cloud Security Posture Management container usage by tag(s)
230+
:param cspm_container_percentage: The percentage of Cloud Security Management Pro container usage by tag(s)
231231
:type cspm_container_percentage: float, optional
232232
233-
:param cspm_container_usage: The Cloud Security Posture Management container usage by tag(s)
233+
:param cspm_container_usage: The Cloud Security Management Pro container usage by tag(s)
234234
:type cspm_container_usage: float, optional
235235
236-
:param cspm_host_percentage: The percentage of Cloud Security Posture Management host usage by tag(s)
236+
:param cspm_host_percentage: The percentage of Cloud Security Management Pro host usage by tag(s)
237237
:type cspm_host_percentage: float, optional
238238
239-
:param cspm_host_usage: The Cloud Security Posture Management host usage by tag(s)
239+
:param cspm_host_usage: The Cloud Security Management Pro host usage by tag(s)
240240
:type cspm_host_usage: float, optional
241241
242242
:param custom_timeseries_percentage: The percentage of custom metrics usage by tag(s).

src/datadog_api_client/v1/model/usage_cloud_security_posture_management_hour.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,27 +59,27 @@ def __init__(
5959
**kwargs,
6060
):
6161
"""
62-
Cloud Security Posture Management usage for a given organization for a given hour.
62+
Cloud Security Management Pro usage for a given organization for a given hour.
6363
64-
:param aas_host_count: The number of Cloud Security Posture Management Azure app services hosts during a given hour.
64+
:param aas_host_count: The number of Cloud Security Management Pro Azure app services hosts during a given hour.
6565
:type aas_host_count: float, none_type, optional
6666
67-
:param aws_host_count: The number of Cloud Security Posture Management AWS hosts during a given hour.
67+
:param aws_host_count: The number of Cloud Security Management Pro AWS hosts during a given hour.
6868
:type aws_host_count: float, none_type, optional
6969
70-
:param azure_host_count: The number of Cloud Security Posture Management Azure hosts during a given hour.
70+
:param azure_host_count: The number of Cloud Security Management Pro Azure hosts during a given hour.
7171
:type azure_host_count: float, none_type, optional
7272
73-
:param compliance_host_count: The number of Cloud Security Posture Management hosts during a given hour.
73+
:param compliance_host_count: The number of Cloud Security Management Pro hosts during a given hour.
7474
:type compliance_host_count: float, none_type, optional
7575
76-
:param container_count: The total number of Cloud Security Posture Management containers during a given hour.
76+
:param container_count: The total number of Cloud Security Management Pro containers during a given hour.
7777
:type container_count: float, none_type, optional
7878
79-
:param gcp_host_count: The number of Cloud Security Posture Management GCP hosts during a given hour.
79+
:param gcp_host_count: The number of Cloud Security Management Pro GCP hosts during a given hour.
8080
:type gcp_host_count: float, none_type, optional
8181
82-
:param host_count: The total number of Cloud Security Posture Management hosts during a given hour.
82+
:param host_count: The total number of Cloud Security Management Pro hosts during a given hour.
8383
:type host_count: float, none_type, optional
8484
8585
:param hour: The hour for the usage.

src/datadog_api_client/v1/model/usage_cloud_security_posture_management_response.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ def openapi_types(_):
3636

3737
def __init__(self_, usage: Union[List[UsageCloudSecurityPostureManagementHour], UnsetType] = unset, **kwargs):
3838
"""
39-
The response containing the Cloud Security Posture Management usage for each hour for a given organization.
39+
The response containing the Cloud Security Management Pro usage for each hour for a given organization.
4040
41-
:param usage: Get hourly usage for Cloud Security Posture Management.
41+
:param usage: Get hourly usage for Cloud Security Management Pro.
4242
:type usage: [UsageCloudSecurityPostureManagementHour], optional
4343
"""
4444
if usage is not unset:

src/datadog_api_client/v1/model/usage_summary_date.py

Lines changed: 89 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,16 @@ def openapi_types(_):
5151
"container_avg": (int,),
5252
"container_excl_agent_avg": (int,),
5353
"container_hwm": (int,),
54+
"csm_container_enterprise_compliance_count_sum": (int,),
55+
"csm_container_enterprise_cws_count_sum": (int,),
56+
"csm_container_enterprise_total_count_sum": (int,),
57+
"csm_host_enterprise_aas_host_count_top99p": (int,),
58+
"csm_host_enterprise_aws_host_count_top99p": (int,),
59+
"csm_host_enterprise_azure_host_count_top99p": (int,),
60+
"csm_host_enterprise_compliance_host_count_top99p": (int,),
61+
"csm_host_enterprise_cws_host_count_top99p": (int,),
62+
"csm_host_enterprise_gcp_host_count_top99p": (int,),
63+
"csm_host_enterprise_total_host_count_top99p": (int,),
5464
"cspm_aas_host_top99p": (int,),
5565
"cspm_aws_host_top99p": (int,),
5666
"cspm_azure_host_top99p": (int,),
@@ -141,6 +151,16 @@ def openapi_types(_):
141151
"container_avg": "container_avg",
142152
"container_excl_agent_avg": "container_excl_agent_avg",
143153
"container_hwm": "container_hwm",
154+
"csm_container_enterprise_compliance_count_sum": "csm_container_enterprise_compliance_count_sum",
155+
"csm_container_enterprise_cws_count_sum": "csm_container_enterprise_cws_count_sum",
156+
"csm_container_enterprise_total_count_sum": "csm_container_enterprise_total_count_sum",
157+
"csm_host_enterprise_aas_host_count_top99p": "csm_host_enterprise_aas_host_count_top99p",
158+
"csm_host_enterprise_aws_host_count_top99p": "csm_host_enterprise_aws_host_count_top99p",
159+
"csm_host_enterprise_azure_host_count_top99p": "csm_host_enterprise_azure_host_count_top99p",
160+
"csm_host_enterprise_compliance_host_count_top99p": "csm_host_enterprise_compliance_host_count_top99p",
161+
"csm_host_enterprise_cws_host_count_top99p": "csm_host_enterprise_cws_host_count_top99p",
162+
"csm_host_enterprise_gcp_host_count_top99p": "csm_host_enterprise_gcp_host_count_top99p",
163+
"csm_host_enterprise_total_host_count_top99p": "csm_host_enterprise_total_host_count_top99p",
144164
"cspm_aas_host_top99p": "cspm_aas_host_top99p",
145165
"cspm_aws_host_top99p": "cspm_aws_host_top99p",
146166
"cspm_azure_host_top99p": "cspm_azure_host_top99p",
@@ -232,6 +252,16 @@ def __init__(
232252
container_avg: Union[int, UnsetType] = unset,
233253
container_excl_agent_avg: Union[int, UnsetType] = unset,
234254
container_hwm: Union[int, UnsetType] = unset,
255+
csm_container_enterprise_compliance_count_sum: Union[int, UnsetType] = unset,
256+
csm_container_enterprise_cws_count_sum: Union[int, UnsetType] = unset,
257+
csm_container_enterprise_total_count_sum: Union[int, UnsetType] = unset,
258+
csm_host_enterprise_aas_host_count_top99p: Union[int, UnsetType] = unset,
259+
csm_host_enterprise_aws_host_count_top99p: Union[int, UnsetType] = unset,
260+
csm_host_enterprise_azure_host_count_top99p: Union[int, UnsetType] = unset,
261+
csm_host_enterprise_compliance_host_count_top99p: Union[int, UnsetType] = unset,
262+
csm_host_enterprise_cws_host_count_top99p: Union[int, UnsetType] = unset,
263+
csm_host_enterprise_gcp_host_count_top99p: Union[int, UnsetType] = unset,
264+
csm_host_enterprise_total_host_count_top99p: Union[int, UnsetType] = unset,
235265
cspm_aas_host_top99p: Union[int, UnsetType] = unset,
236266
cspm_aws_host_top99p: Union[int, UnsetType] = unset,
237267
cspm_azure_host_top99p: Union[int, UnsetType] = unset,
@@ -378,25 +408,55 @@ def __init__(
378408
:param container_hwm: Shows the high-water mark of all distinct containers over all hours in the current date for all organizations.
379409
:type container_hwm: int, optional
380410
381-
:param cspm_aas_host_top99p: Shows the 99th percentile of all Cloud Security Posture Management Azure app services hosts over all hours in the current date for all organizations.
411+
:param csm_container_enterprise_compliance_count_sum: Shows the sum of all Cloud Security Management Enterprise compliance containers over all hours in the current date for the given org.
412+
:type csm_container_enterprise_compliance_count_sum: int, optional
413+
414+
:param csm_container_enterprise_cws_count_sum: Shows the sum of all Cloud Security Management Enterprise Cloud Workload Security containers over all hours in the current date for the given org.
415+
:type csm_container_enterprise_cws_count_sum: int, optional
416+
417+
:param csm_container_enterprise_total_count_sum: Shows the sum of all Cloud Security Management Enterprise containers over all hours in the current date for the given org.
418+
:type csm_container_enterprise_total_count_sum: int, optional
419+
420+
:param csm_host_enterprise_aas_host_count_top99p: Shows the 99th percentile of all Cloud Security Management Enterprise Azure app services hosts over all hours in the current date for the given org.
421+
:type csm_host_enterprise_aas_host_count_top99p: int, optional
422+
423+
:param csm_host_enterprise_aws_host_count_top99p: Shows the 99th percentile of all Cloud Security Management Enterprise AWS hosts over all hours in the current date for the given org.
424+
:type csm_host_enterprise_aws_host_count_top99p: int, optional
425+
426+
:param csm_host_enterprise_azure_host_count_top99p: Shows the 99th percentile of all Cloud Security Management Enterprise Azure hosts over all hours in the current date for the given org.
427+
:type csm_host_enterprise_azure_host_count_top99p: int, optional
428+
429+
:param csm_host_enterprise_compliance_host_count_top99p: Shows the 99th percentile of all Cloud Security Management Enterprise compliance hosts over all hours in the current date for the given org.
430+
:type csm_host_enterprise_compliance_host_count_top99p: int, optional
431+
432+
:param csm_host_enterprise_cws_host_count_top99p: Shows the 99th percentile of all Cloud Security Management Enterprise Cloud Workload Security hosts over all hours in the current date for the given org.
433+
:type csm_host_enterprise_cws_host_count_top99p: int, optional
434+
435+
:param csm_host_enterprise_gcp_host_count_top99p: Shows the 99th percentile of all Cloud Security Management Enterprise GCP hosts over all hours in the current date for the given org.
436+
:type csm_host_enterprise_gcp_host_count_top99p: int, optional
437+
438+
:param csm_host_enterprise_total_host_count_top99p: Shows the 99th percentile of all Cloud Security Management Enterprise hosts over all hours in the current date for the given org.
439+
:type csm_host_enterprise_total_host_count_top99p: int, optional
440+
441+
:param cspm_aas_host_top99p: Shows the 99th percentile of all Cloud Security Management Pro Azure app services hosts over all hours in the current date for all organizations.
382442
:type cspm_aas_host_top99p: int, optional
383443
384-
:param cspm_aws_host_top99p: Shows the 99th percentile of all Cloud Security Posture Management AWS hosts over all hours in the current date for all organizations.
444+
:param cspm_aws_host_top99p: Shows the 99th percentile of all Cloud Security Management Pro AWS hosts over all hours in the current date for all organizations.
385445
:type cspm_aws_host_top99p: int, optional
386446
387-
:param cspm_azure_host_top99p: Shows the 99th percentile of all Cloud Security Posture Management Azure hosts over all hours in the current date for all organizations.
447+
:param cspm_azure_host_top99p: Shows the 99th percentile of all Cloud Security Management Pro Azure hosts over all hours in the current date for all organizations.
388448
:type cspm_azure_host_top99p: int, optional
389449
390-
:param cspm_container_avg: Shows the average number of Cloud Security Posture Management containers over all hours in the current date for all organizations.
450+
:param cspm_container_avg: Shows the average number of Cloud Security Management Pro containers over all hours in the current date for all organizations.
391451
:type cspm_container_avg: int, optional
392452
393-
:param cspm_container_hwm: Shows the high-water mark of Cloud Security Posture Management containers over all hours in the current date for all organizations.
453+
:param cspm_container_hwm: Shows the high-water mark of Cloud Security Management Pro containers over all hours in the current date for all organizations.
394454
:type cspm_container_hwm: int, optional
395455
396-
:param cspm_gcp_host_top99p: Shows the 99th percentile of all Cloud Security Posture Management GCP hosts over all hours in the current date for all organizations.
456+
:param cspm_gcp_host_top99p: Shows the 99th percentile of all Cloud Security Management Pro GCP hosts over all hours in the current date for all organizations.
397457
:type cspm_gcp_host_top99p: int, optional
398458
399-
:param cspm_host_top99p: Shows the 99th percentile of all Cloud Security Posture Management hosts over all hours in the current date for all organizations.
459+
:param cspm_host_top99p: Shows the 99th percentile of all Cloud Security Management Pro hosts over all hours in the current date for all organizations.
400460
:type cspm_host_top99p: int, optional
401461
402462
:param custom_ts_avg: Shows the average number of distinct custom metrics over all hours in the current date for all organizations.
@@ -612,6 +672,28 @@ def __init__(
612672
kwargs["container_excl_agent_avg"] = container_excl_agent_avg
613673
if container_hwm is not unset:
614674
kwargs["container_hwm"] = container_hwm
675+
if csm_container_enterprise_compliance_count_sum is not unset:
676+
kwargs["csm_container_enterprise_compliance_count_sum"] = csm_container_enterprise_compliance_count_sum
677+
if csm_container_enterprise_cws_count_sum is not unset:
678+
kwargs["csm_container_enterprise_cws_count_sum"] = csm_container_enterprise_cws_count_sum
679+
if csm_container_enterprise_total_count_sum is not unset:
680+
kwargs["csm_container_enterprise_total_count_sum"] = csm_container_enterprise_total_count_sum
681+
if csm_host_enterprise_aas_host_count_top99p is not unset:
682+
kwargs["csm_host_enterprise_aas_host_count_top99p"] = csm_host_enterprise_aas_host_count_top99p
683+
if csm_host_enterprise_aws_host_count_top99p is not unset:
684+
kwargs["csm_host_enterprise_aws_host_count_top99p"] = csm_host_enterprise_aws_host_count_top99p
685+
if csm_host_enterprise_azure_host_count_top99p is not unset:
686+
kwargs["csm_host_enterprise_azure_host_count_top99p"] = csm_host_enterprise_azure_host_count_top99p
687+
if csm_host_enterprise_compliance_host_count_top99p is not unset:
688+
kwargs[
689+
"csm_host_enterprise_compliance_host_count_top99p"
690+
] = csm_host_enterprise_compliance_host_count_top99p
691+
if csm_host_enterprise_cws_host_count_top99p is not unset:
692+
kwargs["csm_host_enterprise_cws_host_count_top99p"] = csm_host_enterprise_cws_host_count_top99p
693+
if csm_host_enterprise_gcp_host_count_top99p is not unset:
694+
kwargs["csm_host_enterprise_gcp_host_count_top99p"] = csm_host_enterprise_gcp_host_count_top99p
695+
if csm_host_enterprise_total_host_count_top99p is not unset:
696+
kwargs["csm_host_enterprise_total_host_count_top99p"] = csm_host_enterprise_total_host_count_top99p
615697
if cspm_aas_host_top99p is not unset:
616698
kwargs["cspm_aas_host_top99p"] = cspm_aas_host_top99p
617699
if cspm_aws_host_top99p is not unset:

0 commit comments

Comments
 (0)