Skip to content

Commit a4d5b66

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Update documentation for App Sec SCA (#2061)
* Regenerate client from commit 44cf4afe of spec repo * pre-commit fixes --------- 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 0fbfc45 commit a4d5b66

8 files changed

+129
-6
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": "2024-07-26 18:27:50.289131",
8-
"spec_repo_commit": "7e92b530"
7+
"regenerated": "2024-07-26 19:06:13.301282",
8+
"spec_repo_commit": "44cf4afe"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-07-26 18:27:50.306427",
13-
"spec_repo_commit": "7e92b530"
12+
"regenerated": "2024-07-26 19:06:13.318622",
13+
"spec_repo_commit": "44cf4afe"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4216,6 +4216,7 @@ components:
42164216
- profiled_host_usage
42174217
- rum_browser_mobile_sessions_usage
42184218
- rum_replay_sessions_usage
4219+
- sca_fargate_usage
42194220
- sds_scanned_bytes_usage
42204221
- serverless_apps_usage
42214222
- siem_analyzed_logs_add_on_usage
@@ -4288,6 +4289,7 @@ components:
42884289
- PROFILED_HOST_USAGE
42894290
- RUM_BROWSER_MOBILE_SESSIONS_USAGE
42904291
- RUM_REPLAY_SESSIONS_USAGE
4292+
- SCA_FARGATE_USAGE
42914293
- SDS_SCANNED_BYTES_USAGE
42924294
- SERVERLESS_APPS_USAGE
42934295
- SIEM_ANALYZED_LOGS_ADD_ON_USAGE
@@ -7991,6 +7993,8 @@ components:
79917993
- siem_ingested_bytes_percentage
79927994
- workflow_executions_usage
79937995
- workflow_executions_percentage
7996+
- sca_fargate_usage
7997+
- sca_fargate_percentage
79947998
- '*'
79957999
type: string
79968000
x-enum-varnames:
@@ -8130,6 +8134,8 @@ components:
81308134
- SIEM_INGESTED_BYTES_PERCENTAGE
81318135
- WORKFLOW_EXECUTIONS_USAGE
81328136
- WORKFLOW_EXECUTIONS_PERCENTAGE
8137+
- SCA_FARGATE_USAGE
8138+
- SCA_FARGATE_PERCENTAGE
81338139
- ALL
81348140
MonthlyUsageAttributionValues:
81358141
description: Fields in Usage Summary by tag(s).
@@ -8639,6 +8645,16 @@ components:
86398645
description: The total RUM Session Replay usage by tag(s).
86408646
format: double
86418647
type: number
8648+
sca_fargate_percentage:
8649+
description: The percentage of Software Composition Analysis Fargate task
8650+
usage by tag(s).
8651+
format: double
8652+
type: number
8653+
sca_fargate_usage:
8654+
description: The total Software Composition Analysis Fargate task usage
8655+
by tag(s).
8656+
format: double
8657+
type: number
86428658
sds_scanned_bytes_percentage:
86438659
description: The percentage of Sensitive Data Scanner usage by tag(s).
86448660
format: double
@@ -19256,6 +19272,17 @@ components:
1925619272
1st, 2024).
1925719273
format: int64
1925819274
type: integer
19275+
sca_fargate_count_avg:
19276+
description: Shows the average of all Software Composition Analysis Fargate
19277+
tasks over all hours in the current date for the given org.
19278+
format: int64
19279+
type: integer
19280+
sca_fargate_count_hwm:
19281+
description: Shows the sum of the high-water marks of all Software Composition
19282+
Analysis Fargate tasks over all hours in the current date for the given
19283+
org.
19284+
format: int64
19285+
type: integer
1925919286
sds_apm_scanned_bytes_sum:
1926019287
description: Sum of all APM bytes scanned with sensitive data scanner over
1926119288
all hours in the current date for all organizations.
@@ -19964,6 +19991,17 @@ components:
1996419991
1st, 2024).
1996519992
format: int64
1996619993
type: integer
19994+
sca_fargate_count_avg:
19995+
description: Shows the average of all Software Composition Analysis Fargate
19996+
tasks over all hours in the current date for the given org.
19997+
format: int64
19998+
type: integer
19999+
sca_fargate_count_hwm:
20000+
description: Shows the sum of the high-water marks of all Software Composition
20001+
Analysis Fargate tasks over all hours in the current date for the given
20002+
org.
20003+
format: int64
20004+
type: integer
1996720005
sds_apm_scanned_bytes_sum:
1996820006
description: Sum of all APM bytes scanned with sensitive data scanner over
1996920007
all hours in the current date for the given org.
@@ -20707,6 +20745,16 @@ components:
2070720745
October 1st, 2024).
2070820746
format: int64
2070920747
type: integer
20748+
sca_fargate_count_avg_sum:
20749+
description: Shows the average of all Software Composition Analysis Fargate
20750+
tasks over all hours in the current months for all organizations.
20751+
format: int64
20752+
type: integer
20753+
sca_fargate_count_hwm_sum:
20754+
description: Shows the sum of the high-water marks of all Software Composition
20755+
Analysis Fargate tasks over all hours in the current months for all organizations.
20756+
format: int64
20757+
type: integer
2071020758
sds_apm_scanned_bytes_sum:
2071120759
description: Sum of all APM bytes scanned with sensitive data scanner in
2071220760
the current month for all organizations.

src/datadog_api_client/v1/model/hourly_usage_attribution_usage_type.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ class HourlyUsageAttributionUsageType(ModelSimple):
1616
"""
1717
Supported products for hourly usage attribution requests.
1818
19-
:param value: Must be one of ["api_usage", "apm_fargate_usage", "apm_host_usage", "apm_usm_usage", "appsec_fargate_usage", "appsec_usage", "asm_serverless_traced_invocations_usage", "asm_serverless_traced_invocations_percentage", "browser_usage", "ci_pipeline_indexed_spans_usage", "ci_test_indexed_spans_usage", "ci_visibility_itr_usage", "cloud_siem_usage", "container_excl_agent_usage", "container_usage", "cspm_containers_usage", "cspm_hosts_usage", "custom_event_usage", "custom_ingested_timeseries_usage", "custom_timeseries_usage", "cws_containers_usage", "cws_hosts_usage", "dbm_hosts_usage", "dbm_queries_usage", "error_tracking_usage", "error_tracking_percentage", "estimated_indexed_logs_usage", "estimated_indexed_spans_usage", "estimated_ingested_logs_usage", "estimated_ingested_spans_usage", "estimated_rum_sessions_usage", "fargate_usage", "functions_usage", "incident_management_monthly_active_users_usage", "indexed_spans_usage", "infra_host_usage", "ingested_logs_bytes_usage", "ingested_spans_bytes_usage", "invocations_usage", "lambda_traced_invocations_usage", "logs_indexed_15day_usage", "logs_indexed_180day_usage", "logs_indexed_1day_usage", "logs_indexed_30day_usage", "logs_indexed_360day_usage", "logs_indexed_3day_usage", "logs_indexed_45day_usage", "logs_indexed_60day_usage", "logs_indexed_7day_usage", "logs_indexed_90day_usage", "logs_indexed_custom_retention_usage", "mobile_app_testing_usage", "ndm_netflow_usage", "npm_host_usage", "obs_pipeline_bytes_usage", "obs_pipelines_vcpu_usage", "online_archive_usage", "profiled_container_usage", "profiled_fargate_usage", "profiled_host_usage", "rum_browser_mobile_sessions_usage", "rum_replay_sessions_usage", "sds_scanned_bytes_usage", "serverless_apps_usage", "siem_analyzed_logs_add_on_usage", "siem_ingested_bytes_usage", "snmp_usage", "universal_service_monitoring_usage", "vuln_management_hosts_usage", "workflow_executions_usage"].
19+
:param value: Must be one of ["api_usage", "apm_fargate_usage", "apm_host_usage", "apm_usm_usage", "appsec_fargate_usage", "appsec_usage", "asm_serverless_traced_invocations_usage", "asm_serverless_traced_invocations_percentage", "browser_usage", "ci_pipeline_indexed_spans_usage", "ci_test_indexed_spans_usage", "ci_visibility_itr_usage", "cloud_siem_usage", "container_excl_agent_usage", "container_usage", "cspm_containers_usage", "cspm_hosts_usage", "custom_event_usage", "custom_ingested_timeseries_usage", "custom_timeseries_usage", "cws_containers_usage", "cws_hosts_usage", "dbm_hosts_usage", "dbm_queries_usage", "error_tracking_usage", "error_tracking_percentage", "estimated_indexed_logs_usage", "estimated_indexed_spans_usage", "estimated_ingested_logs_usage", "estimated_ingested_spans_usage", "estimated_rum_sessions_usage", "fargate_usage", "functions_usage", "incident_management_monthly_active_users_usage", "indexed_spans_usage", "infra_host_usage", "ingested_logs_bytes_usage", "ingested_spans_bytes_usage", "invocations_usage", "lambda_traced_invocations_usage", "logs_indexed_15day_usage", "logs_indexed_180day_usage", "logs_indexed_1day_usage", "logs_indexed_30day_usage", "logs_indexed_360day_usage", "logs_indexed_3day_usage", "logs_indexed_45day_usage", "logs_indexed_60day_usage", "logs_indexed_7day_usage", "logs_indexed_90day_usage", "logs_indexed_custom_retention_usage", "mobile_app_testing_usage", "ndm_netflow_usage", "npm_host_usage", "obs_pipeline_bytes_usage", "obs_pipelines_vcpu_usage", "online_archive_usage", "profiled_container_usage", "profiled_fargate_usage", "profiled_host_usage", "rum_browser_mobile_sessions_usage", "rum_replay_sessions_usage", "sca_fargate_usage", "sds_scanned_bytes_usage", "serverless_apps_usage", "siem_analyzed_logs_add_on_usage", "siem_ingested_bytes_usage", "snmp_usage", "universal_service_monitoring_usage", "vuln_management_hosts_usage", "workflow_executions_usage"].
2020
:type value: str
2121
"""
2222

@@ -83,6 +83,7 @@ class HourlyUsageAttributionUsageType(ModelSimple):
8383
"profiled_host_usage",
8484
"rum_browser_mobile_sessions_usage",
8585
"rum_replay_sessions_usage",
86+
"sca_fargate_usage",
8687
"sds_scanned_bytes_usage",
8788
"serverless_apps_usage",
8889
"siem_analyzed_logs_add_on_usage",
@@ -154,6 +155,7 @@ class HourlyUsageAttributionUsageType(ModelSimple):
154155
PROFILED_HOST_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
155156
RUM_BROWSER_MOBILE_SESSIONS_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
156157
RUM_REPLAY_SESSIONS_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
158+
SCA_FARGATE_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
157159
SDS_SCANNED_BYTES_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
158160
SERVERLESS_APPS_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
159161
SIEM_ANALYZED_LOGS_ADD_ON_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
@@ -264,6 +266,7 @@ def openapi_types(_):
264266
"rum_browser_mobile_sessions_usage"
265267
)
266268
HourlyUsageAttributionUsageType.RUM_REPLAY_SESSIONS_USAGE = HourlyUsageAttributionUsageType("rum_replay_sessions_usage")
269+
HourlyUsageAttributionUsageType.SCA_FARGATE_USAGE = HourlyUsageAttributionUsageType("sca_fargate_usage")
267270
HourlyUsageAttributionUsageType.SDS_SCANNED_BYTES_USAGE = HourlyUsageAttributionUsageType("sds_scanned_bytes_usage")
268271
HourlyUsageAttributionUsageType.SERVERLESS_APPS_USAGE = HourlyUsageAttributionUsageType("serverless_apps_usage")
269272
HourlyUsageAttributionUsageType.SIEM_ANALYZED_LOGS_ADD_ON_USAGE = HourlyUsageAttributionUsageType(

src/datadog_api_client/v1/model/monthly_usage_attribution_supported_metrics.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ class MonthlyUsageAttributionSupportedMetrics(ModelSimple):
1616
"""
1717
Supported metrics for monthly usage attribution requests.
1818
19-
: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", "asm_serverless_traced_invocations_usage", "asm_serverless_traced_invocations_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", "error_tracking_usage", "error_tracking_percentage", "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", "incident_management_monthly_active_users_usage", "incident_management_monthly_active_users_percentage", "infra_host_usage", "infra_host_percentage", "invocations_usage", "invocations_percentage", "lambda_traced_invocations_usage", "lambda_traced_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", "obs_pipelines_vcpu_usage", "obs_pipelines_vcpu_percentage", "online_archive_usage", "online_archive_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", "ci_test_indexed_spans_usage", "ci_test_indexed_spans_percentage", "ingested_logs_bytes_usage", "ingested_logs_bytes_percentage", "ci_pipeline_indexed_spans_usage", "ci_pipeline_indexed_spans_percentage", "indexed_spans_usage", "indexed_spans_percentage", "custom_event_usage", "custom_event_percentage", "logs_indexed_custom_retention_usage", "logs_indexed_custom_retention_percentage", "logs_indexed_360day_usage", "logs_indexed_360day_percentage", "logs_indexed_180day_usage", "logs_indexed_180day_percentage", "logs_indexed_90day_usage", "logs_indexed_90day_percentage", "logs_indexed_60day_usage", "logs_indexed_60day_percentage", "logs_indexed_45day_usage", "logs_indexed_45day_percentage", "logs_indexed_30day_usage", "logs_indexed_30day_percentage", "logs_indexed_15day_usage", "logs_indexed_15day_percentage", "logs_indexed_7day_usage", "logs_indexed_7day_percentage", "logs_indexed_3day_usage", "logs_indexed_3day_percentage", "logs_indexed_1day_usage", "logs_indexed_1day_percentage", "rum_replay_sessions_usage", "rum_replay_sessions_percentage", "rum_browser_mobile_sessions_usage", "rum_browser_mobile_sessions_percentage", "ingested_spans_bytes_usage", "ingested_spans_bytes_percentage", "siem_analyzed_logs_add_on_usage", "siem_analyzed_logs_add_on_percentage", "siem_ingested_bytes_usage", "siem_ingested_bytes_percentage", "workflow_executions_usage", "workflow_executions_percentage", "*"].
19+
: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", "asm_serverless_traced_invocations_usage", "asm_serverless_traced_invocations_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", "error_tracking_usage", "error_tracking_percentage", "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", "incident_management_monthly_active_users_usage", "incident_management_monthly_active_users_percentage", "infra_host_usage", "infra_host_percentage", "invocations_usage", "invocations_percentage", "lambda_traced_invocations_usage", "lambda_traced_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", "obs_pipelines_vcpu_usage", "obs_pipelines_vcpu_percentage", "online_archive_usage", "online_archive_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", "ci_test_indexed_spans_usage", "ci_test_indexed_spans_percentage", "ingested_logs_bytes_usage", "ingested_logs_bytes_percentage", "ci_pipeline_indexed_spans_usage", "ci_pipeline_indexed_spans_percentage", "indexed_spans_usage", "indexed_spans_percentage", "custom_event_usage", "custom_event_percentage", "logs_indexed_custom_retention_usage", "logs_indexed_custom_retention_percentage", "logs_indexed_360day_usage", "logs_indexed_360day_percentage", "logs_indexed_180day_usage", "logs_indexed_180day_percentage", "logs_indexed_90day_usage", "logs_indexed_90day_percentage", "logs_indexed_60day_usage", "logs_indexed_60day_percentage", "logs_indexed_45day_usage", "logs_indexed_45day_percentage", "logs_indexed_30day_usage", "logs_indexed_30day_percentage", "logs_indexed_15day_usage", "logs_indexed_15day_percentage", "logs_indexed_7day_usage", "logs_indexed_7day_percentage", "logs_indexed_3day_usage", "logs_indexed_3day_percentage", "logs_indexed_1day_usage", "logs_indexed_1day_percentage", "rum_replay_sessions_usage", "rum_replay_sessions_percentage", "rum_browser_mobile_sessions_usage", "rum_browser_mobile_sessions_percentage", "ingested_spans_bytes_usage", "ingested_spans_bytes_percentage", "siem_analyzed_logs_add_on_usage", "siem_analyzed_logs_add_on_percentage", "siem_ingested_bytes_usage", "siem_ingested_bytes_percentage", "workflow_executions_usage", "workflow_executions_percentage", "sca_fargate_usage", "sca_fargate_percentage", "*"].
2020
:type value: str
2121
"""
2222

@@ -157,6 +157,8 @@ class MonthlyUsageAttributionSupportedMetrics(ModelSimple):
157157
"siem_ingested_bytes_percentage",
158158
"workflow_executions_usage",
159159
"workflow_executions_percentage",
160+
"sca_fargate_usage",
161+
"sca_fargate_percentage",
160162
"*",
161163
}
162164
API_USAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
@@ -295,6 +297,8 @@ class MonthlyUsageAttributionSupportedMetrics(ModelSimple):
295297
SIEM_INGESTED_BYTES_PERCENTAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
296298
WORKFLOW_EXECUTIONS_USAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
297299
WORKFLOW_EXECUTIONS_PERCENTAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
300+
SCA_FARGATE_USAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
301+
SCA_FARGATE_PERCENTAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
298302
ALL: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
299303

300304
@cached_property
@@ -668,4 +672,8 @@ def openapi_types(_):
668672
MonthlyUsageAttributionSupportedMetrics.WORKFLOW_EXECUTIONS_PERCENTAGE = MonthlyUsageAttributionSupportedMetrics(
669673
"workflow_executions_percentage"
670674
)
675+
MonthlyUsageAttributionSupportedMetrics.SCA_FARGATE_USAGE = MonthlyUsageAttributionSupportedMetrics("sca_fargate_usage")
676+
MonthlyUsageAttributionSupportedMetrics.SCA_FARGATE_PERCENTAGE = MonthlyUsageAttributionSupportedMetrics(
677+
"sca_fargate_percentage"
678+
)
671679
MonthlyUsageAttributionSupportedMetrics.ALL = MonthlyUsageAttributionSupportedMetrics("*")

0 commit comments

Comments
 (0)